A library combining tools to develop with a FLUX architecture
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
build
releases
src
.gitignore
.travis.yml
LICENSE
README.md
bower.json
gulpfile.js
package.json
test.html

README.md

flux-react

A React JS flux expansion based on experiences building www.jsfridge.com and www.jflux.io. Read more about FLUX over at Facebook Flux. I wrote an article about it here: My experiences building a FLUX application and the background for version 2.6.0 and up is here: An alternative render strategy with FLUX and React JS

What is it all about?

It can be difficult to get going with React JS and FLUX as there is no complete framework with all the tools you need. This project will help you get going with the FLUX parts and it has a boilerplate with a browserify workflow, flux-react-boilerplate.

How to install

Download from releases/ folder of the repo, use npm install flux-react or bower install flux-react, but I recommend using the boilerplate located here: flux-react-boilerplate. It has everything set up for you.

API

flux.debug

var flux = require('flux-react');
flux.debug();

Puts React on the global scope, which triggers the React dev tools in Chrome

flux.createActions()

var flux = require('flux-react');
var actions = flux.createActions([
	'addTodo',
	'removeTodo'
]);
actions.addTodo(); // Trigger action
actions.removeTodo(0); // Pass any number of arguments

Use them inside components or other parts of your architecture. The only way to reach a store is through an action.

flux.createStore()

var flux = require('flux-react');
var MyStore = flux.createStore({});

Creates a store.

state

var flux = require('flux-react');
var MyStore = flux.createStore({
	todos: []
});

Add state properties directly to your store.

actions

var flux = require('flux-react');
var actions = require('./actions.js');
var MyStore = flux.createStore({
	todos: []
	actions: [
		actions.addTodo
	]
});

List what actions the store should handle. They will map to handler with the same name.

handler

var flux = require('flux-react');
var actions = require('./actions.js');
var MyStore = flux.createStore({
	todos: []
	actions: [
		actions.addTodo
	],
	addTodo: function (title) {
		this.todos.push({title: title, completed: false});
	}
});

Based on the name of the action, add a handler that will run when the action is triggered. Any arguments passed to the action will be available in the handler.

events

var flux = require('flux-react');
var actions = require('./actions.js');
var MyStore = flux.createStore({
	todos: []
	actions: [
		actions.addTodo
	],
	addTodo: function (title) {
		this.todos.push({title: title, completed: false});
		this.emit('todos.add');
	}
});

flux-react uses EventEmitter2 which allows for more granular control of events. Instead of always triggering a change event or/and trigger a specific event you will now always trigger a specifically named event. It is recommended to namespace your events related to the state you are changing. In the current example "todos" is the state name and "add" is what we did to that state. That becomes "todos.add". Look at component to see how you can use this to optimize your rendering.

exports

var flux = require('flux-react');
var actions = require('./actions.js');
var MyStore = flux.createStore({
	todos: [],
	actions: [
		actions.addTodo
	],
	addTodo: function (title) {
		this.todos.push({title: title, completed: false});
		this.emit('todos.add');
	},
	exports: {
		getTodos: function () {
			return this.todos
		}
	}
});

Methods defined in exports will be returned by createStore. Components or other parts of the architecture can use it to get state from the store. The methods are bound to the store, meaning "this.todos" points to the state "todos".

Note! Values returned by an export method will be deep cloned. Meaning that the state of a store is immutable. You can not do changes to a returned value and expect that to be valid inside your store also. You have to trigger an action to change the state of a store.

mixins

var flux = require('flux-react');
var actions = require('./actions.js');

var MyMixin = {
	actions: [
		actions.removeTodo
	],
	removeTodo: function (index) {
		this.state.todos.splice(index, 1);
		this.emit('todos.remove');
	}
};

var MyStore = flux.createStore({
	todos: [],
	mixins: [MyMixin],
	actions: [
		actions.addTodo
	],
	addTodo: function (title) {
		this.todos.push({title: title, completed: false});
		this.emit('todos.add');
	},
	exports: {
		getTodos: function () {
			return this.todos
		}
	}
});

Mixins helps you handle big stores. You do not want to divide your stores within one section of your application as they very quickly become dependant on each other. That can result in circular dependency problems. Use mixins instead and create big stores. state, actions, handlers and exports will be merged with the main store as expected.

ProTip! In big stores it is a good idea to create a StatesMixin that holds all possible state properties in your store. That makes it very easy to look up what states are available to you.

var flux = require('flux-react');

var StateMixin = {
	someState: true,
	stateA: 'foo',
	stateB: 'bar',
	stateC: []
};

var MyStore = flux.createStore({
	mixins: [StateMixin, OtherMixin, MoreMixin],
	exports: {
		getSomeState: function () {
			return this.someState;
		}
	}
});

listener

var React = require('react');
var MyStore = require('./MyStore.js');
var MyComponent = React.createClass({
	componentWillMount: function () {
		MyStore.onAny(this.updateState); // On any events triggered from the store
		MyStore.on('todos.add', this.updateState); // When specific event is triggered from the store
		MyStore.on('todos.*', this.updateState); // When events related to todos are triggered from the store
		MyStore.once('todos.add', this.updateState); // Trigger only once
		MyStore.many('todos.remove', 5, this.updateState); // Trigger only 5 times
	},
	componentWillUnmount: function () {
		MyStore.offAny(this.updateState); // Remove all events listener
		MyStore.off('todos.add', this.updateState); // Remove any other type of listener
	},
	updateState: function () {
		this.setState({
		  todos: MyStore.getTodos()
		});
	},
	render: function () {
		return (
			<div>Number of todos: {this.state.getTodos().length}</div>
		);
	}
});

Add and remove listeners to handle updates from the store

RenderMixin

If you want to know more about this feature, read the following article: An alternative render strategy with FLUX and React JS. The main point is that React JS will most likely rerender your whole application on every change event in your stores. You can control this behavior by adding the RenderMixin to your components. Instead of a component automatically rerenders all child components it will only do that if the props or state of the component actually has changed. It is important that you move state from the store to the state of the component, like in the example below. That ensures that the mixin can evaluate the need for a render.

var React = require('react');
var flux = require('flux-react');
var MyStore = require('./MyStore.js');
var MyComponent = React.createClass({
	mixins: [flux.RenderMixin],
	componentWillMount: function () {
		MyStore.on('todos.*', this.updateState);
	},
	componentWillUnmount: function () {
		MyStore.off('todos.*', this.updateState);
	},
	updateState: function () {
	  this.setState({
	    todos: MyStore.getTodos()
	  });
	},
	render: function () {
		return (
			<div>Number of todos: {this.state.todos.length}</div>
		);
	}
});

Add and remove listeners to handle updates from the store

Changes

2.6.4

  • Fixed AMD support (Thanks @VictorBlomberg)

2.6.2

  • Optimized RenderMixin with shallow check

2.6.1

  • Added feature detection on ArrayBuffer, Blob and File. Thanks to @rdjpalmer

2.6.0

  • Added RenderMixin to give you an alternative optimized render strategy

2.5.1

  • Added eventemitter2 to package.json

2.5.0

  • Changed to EventEmitter2 to allow more granular control of changes in store
  • Updated documentation with examples
  • Old API still works

License

flux-react is licensed under the MIT license.

The MIT License (MIT)

Copyright (c) 2014 Christian Alfoni

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.