Rx functional interface to Facebook's React
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.vscode
docs
examples
src
test
.babelrc
.editorconfig
.eslintignore
.eslintrc
.gitignore
.make-package.js
.travis.yml
CHANGELOG.md
CONTRIBUTING.md
LICENSE
README.md
package-lock.json
package.json

README.md

Cycle-React

Build Status

An RxJS functional interface to Facebook's React.

Cycle-React allows users to write React applications in functional style and represents their UIs as Observables. In addition, Cycle-React is immutable and optimizes the component updates internally by default.

Additionally, Cycle-React is also a React-style implementation of a beautiful framework called Cycle.js.

Installing

npm install cycle-react react rxjs

React v16 or later is required.

Both RxJS 5 and RxJS 4 are supported. For migrating RxJS with cycle-react v6, see release note for details.

Example

import {component} from 'cycle-react/rxjs';
import Rx from 'rxjs/Rx';
import React from 'react';
import ReactDOM from 'react-dom';

const Hello = component('Hello', function computer(interactions) {
  return interactions.get('OnNameChanged')
    .map(ev => ev.target.value)
    .startWith('')
    .map(name =>
      <div>
        <label>Name:</label>
        <input type="text" onChange={interactions.listener('OnNameChanged')} />
        <hr />
        <h1>Hello {name}</h1>
      </div>
    );
});

ReactDOM.render(
  <Hello />,
  document.querySelector('.js-container')
);

The input of the function computer is interactions, a collection containing all user interaction events happening on the user-defined event handlers on the DOM, which you can query using interactions.get(eventName). And the event handler can be defined by interactions.listener(eventName).

The output of the computer is Observable<ReactElement> (a reactive sequence of elements, in other words, view).

Function component subscribes that Observable of elements and create a new React component class, which can be used normally by React.createElement and ReactDOM.render.

Notice that although class is mentioned here, you don't have to use it. That's why Cycle-React was made. We took functions over classes and mutable states.

You can learn more about the concept behind applyToDOM and Cycle from André's amazing presentation: "What if the user was a function?"

React component example

import {component} from 'cycle-react/rxjs';
import Rx from 'rxjs/Rx';
import React from 'react';
import ReactDOM from 'react-dom';

// "component" returns a native React component which can be used normally
// by "React.createElement".
const Counter = component('Counter', (interactions, props) =>
  props.pluck('counter').map(counter =>
    <h3>Seconds Elapsed: {counter}</h3>
  )
);

const Timer = component('Timer', () =>
  Rx.Observable.interval(1000).map(i =>
    <Counter counter={i} />
  )
);

ReactDOM.render(
  <Timer />,
  document.querySelector('.js-container')
);

RxJS v4 & v5

For using RxJS v4, import cycle-react with import {component} from 'cycle-react/rx'. In other words, use cycle-react/rx instead of cycle-react/rxjs. We plan to support more Observable implementations in the same way.

Learn more

Cycle-React is a React-style implementation of Cycle.js, so we have the same concept of handling user interactions. Learn more on: http://cycle.js.org/dialogue.html

In addition, we're working on the documentation site for Cycle-React with more useful examples, too. Stay tuned!

React Native

Example can be found at examples/native

import {component} = require('cycle-react/rxjs');
import {Observable} = require('rxjs/Rx');
const Hello = component('Hello', () =>
  Observable.of(<Text>Hello!</Text>)
);

FAQ

How many files from RxJS 5 are being used in Cycle-React?

Cycle-React has only imported rxjs/Subject and rxjs/BehaviorSubject from RxJS 5. And those two files are only imported if you import cycle-react/rxjs.

Can I use Cycle-React with Flux (e.g. redux)

Absolutely. Since Cycle-React's component creates native React components, there's nothing stopping you from using Flux architecture.

HOWEVER, we don't really recommend to use Flux when you already had Rx or other event stream libraries at your disposal. Instead, we recommend the MVI architecture which also achieves unidirectional data flow. See "Reactive MVC and the Virtual DOM" and "Good bye Flux, welcome Bacon/Rx?" for more details.

Can I use Cycle-React with react-hot-loader?

Yes. And no extra configuration needed.

Example

Can I use Cycle-React with other React components and libraries?

Yes. You can also integrate Cycle-React with your current React apps. Because component creates the native React component for you.

Examples for integrating Cycle-React with other libraries are work in progress.

Meanwhile, See "Working with React" for guidelines.

Run examples

npm run examples starts an HTTP server that shows examples

Community

  • Ask "how do I...?" questions in Cycle-React's Gitter:
    Gitter
  • Propose and discuss significant changes as a GitHub issues

Contributions and thanks

  • @cem2ran for adding the support of React Native
  • @corps for implementing the render scheduler feature

License

The MIT License