Package Exports

react-localstorage

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-localstorage) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

React-LocalStorage

Simply synchronize a component's state with localStorage, when available.

Usage

A simple component:

var React = require('react');
var LocalStorageMixin = require('react-localstorage');

var TestComponent = module.exports = React.createClass({
  displayName: 'TestComponent',
  // This is all you need to do
  mixins: [LocalStorageMixin],

  getInitialState: function() {
    return {counter: 0};
  },

  onClick: function() {
    this.setState({counter: this.state.counter + 1});
  },

  render: function() {
    return (
      <span onClick={this.onClick}>{this.state.counter}</span>
    );
  }
});

Options

The key that state is serialized to under localStorage is chosen with the following code:

key = component.props.localStorageKey || component.displayName || 'react-localstorage';

If you are synchronizing multiple components with the same displayName to localStorage, you must set a unique localStorageKey prop on the component.