Giter Club home page Giter Club logo

aurelia-rxjs's Introduction

aurelia-rxjs

An Aurelia plugin that allows you to bind to Rx Observables and Rx Subjects or use them as Binding Signals.

How to install this plugin?

  1. In your project install the plugin and aurelia-binding-functions via jspm with following command
jspm install npm:aurelia-rxjs npm:aurelia-binding-functions
  1. Make Aurelia load the plugin by adding the following line to the configure function in the main.js file of your src folder
  export function configure(aurelia) {
    aurelia.use
      .standardConfiguration()
      .developmentLogging();

+   aurelia.use.plugin('aurelia-binding-functions');
+   aurelia.use.plugin('aurelia-rxjs');

    aurelia.start().then(a => a.setRoot());
  }
  1. If you use TypeScript or use Visual Studio Code the type declarations for aurelia-rxjs should be visible automatically.

Using the plugin (example)

View:

<input value.bind="@rx(twoWayBinding)" autofocus>
<h2>${@rx(counter)}</h2>
<button click.delegate="@rx(onClick)">recompute random</button>
<h2>${random & observableSignal: onClick}</h2>

ViewModel:

import {Observable, Subject, ReplaySubject} from 'rxjs/Rx'
import {computedFrom} from 'aurelia-framework'

export class ObservableExample {
  counter = Observable.interval(1000)
  twoWayBinding = new ReplaySubject(1)
  onClick = new Subject()

  constructor() {
    this.onClick.subscribe(next => console.log('clicked!'))
    this.twoWayBinding.subscribe(next => console.log(`new value: ${next}`))
  }
  
  // in this example we want to demonstrate 
  // regeneration of the value based on the observableSignal
  // hence we fool Aurelia into thinking it's computed from 'nothing'
  @computedFrom('nothing')
  get random() {
    return Math.random()
  }
}

Dependencies

Used By

This library isn't used by Aurelia. It is an optional plugin.

Platform Support

This library can be used in the browser as well as on the server.

Building The Code

To build the code, follow these steps.

  1. Ensure that NodeJS is installed. This provides the platform on which the build tooling runs.
  2. From the project folder, execute the following command:
npm install
  1. Ensure that Gulp is installed. If you need to install it, use the following command:
npm install -g gulp
  1. To build the code, you can now run:
gulp build
  1. You will find the compiled code in the dist folder, available in three module formats: AMD, CommonJS and ES6.

  2. See gulpfile.js for other tasks related to generating the docs and linting.

Running The Tests

To run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:

  1. Ensure that the Karma CLI is installed. If you need to install it, use the following command:
npm install -g karma-cli
  1. Ensure that jspm is installed. If you need to install it, use the following commnand:
npm install -g jspm
  1. Install the client-side dependencies with jspm:
jspm install
  1. You can now run the tests with this command:
karma start

aurelia-rxjs's People

Contributors

niieani avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

Forkers

doktordirk

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.