What & why

This is a library which takes advantage of the advanced HOC technique to pass a global state called shelfs to all the components, therefore making it possible to share events between components even in complex project hiearchies.

Here are some reasons why react-shelfs came into existense :

• Most flux pattern frameworks have a high learning curve and take time to grasp.
• There are too many terms to learn and memorize especially in the case of Redux
• Setting up a redux project for the first time can be quite hasseling

Now here are some of react-shelfs traits and features :

• Simplistic and easy to use
• Dynamic store in which the dev can shape the parameters to his needs
• Possibility of saving and restoring the store to/from localStorage
• No state required

Demos : react-redux TODO vs react-shelfs TODO

• Redux: https://stackblitz.com/edit/redux-todo?embed=1&file=index.js
• Shelfs: https://stackblitz.com/edit/react-ehvet5?embed=1&file=index.js

Installing

npm i --save react-shelfs

Getting started

Import

import React,{Component} from "react";
import {shelfsProvider,shelfs} from "react-shelfs";

Initiate store

...
const store = (action, shelfs = { rank: 21, health: 100 }) => {
  switch (action) {
    case "RESTORE_HEALTH":
      shelfs.health = Math.min(shelfs.health + 20, 100);
      return shelfs;
    case "TAKE_DAMAGE":
      shelfs.health = Math.max(shelfs.health - 20, 0);
      return shelfs;
    default: return shelfs;
  }
}
shelfs.init(store);

Wrap your components and have fun

...
class Restore extends Component {
  addHealth() {
    shelfs.call("RESTORE_HEALTH");
  }
  render() {
    return (
      <button onClick={this.addHealth}>Restore health</button>
    );
  }
}

class Damage extends Component {
  substractHealth() {
    shelfs.call("TAKE_DAMAGE");
  }
  render() {
    return (
      <button onClick={this.substractHealth}>Take damage</button>
    );
  }
}
const Monitor = () => (
  <div >
    <Damage/>
    <Restore />
    <h2>Health {shelfs.get().health}</h2>
  </div>
);
export default shelfsProvider(Monitor);

Documentation

shelfs.init(store)

Initiates the global state with the store function

shelfs.call(action)

Calls an action that is present inside the store

shelfs.get()

Returns the global state object

shelfs.save(name)

Saves the current store state to the local storage

shelfs.restore(name)

Returns the last saved store state

License

Copyright (c) 2017 Slackercode

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.