/redux-branch

Branches for Redux.

Primary LanguageJavaScriptMIT LicenseMIT

Redux Branch

NPM version Build status Test coverage

Table of Contents

Introduction

One of the biggest sources of confusion when learning to use Redux is knowing when to use the component's local state versus the global Redux state. Although there are many advantages to using a single store, there are also some disadvantages:

  • Dynamically structured state is impossible.
  • Global variables are bad.
  • Performance suffers as your state tree gets larger.

We can get around these limitations by using "branches". A branch is just a local store whose state is merged on top of the parent. This allows each component to have its own Redux store while still being able to interact with the parent store. (Note: It's important that the structure of the global Redux state is an object.)

By default, dispatched actions are passed through to the parent store. To handle an action in the local store, specify the action type in the localActions parameter when calling branch().

Live example

http://codepen.io/stephenbunch/pen/ALakoz

branch(storeFactory, [localActions])

import React, { PropTypes } from 'react';
import { createStore, combineReducers } from 'redux';
import { connect } from 'react-redux';
import { branch } from 'redux-branch';

const counterReducer = (state = 0, action) => {
  switch (action.type) {
    case 'INCREMENT':
      return state + 1;
    case 'DECREMENT':
      return state - 1;
    default:
      return state;
  }
};
const reducer = combineReducers({ count: counterReducer });

const increment = () => ({ type: 'INCREMENT' });
const decrement = () => ({ type: 'DECREMENT' });

const stateToProps = state => state;
const dispatchToProps = { increment, decrement };

class Counter extends React.Component {
  static propTypes = {
    count: PropTypes.number,
    increment: PropTypes.func,
    decrement: PropTypes.func,
  };

  render() {
    return (
      <div>
        <button onClick={this.props.decrement}>-</button>
        {' '}{this.props.count}{' '}
        <button onClick={this.props.increment}>+</button>
      </div>
    );
  }
}

const provide = branch(
  // Specify a factory for creating our local store.
  () => createStore(reducer),

  // By default, all actions pass through to the parent store (assuming a parent
  // store exists.) To handle actions within our local store, we must specify
  // the action types that we want to capture.
  ['INCREMENT', 'DECREMENT']
);

export default provide(connect(stateToProps, dispatchToProps)(Counter));