@4geeksacademy/react-flux-dash

Helping Students with React + Flux development

Stats

StarsIssuesVersionUpdatedCreatedSize
@4geeksacademy/react-flux-dash
3.0.23 years ago4 years agoMinified + gzip package size for @4geeksacademy/react-flux-dash in KB

Readme

React Flux Dash

Version Downloads/week License

Learning flux is hard, using it is cumbersome. Hopefully it will become easier with this library!

Also, learning redux is harder, so this is state library that make your life easier

Dash are a series of coding guidelines and principles to code in a easy, conventional, clean and expressive way.

The principles and guidelines supporting this Library are:

  1. Define a Store should be an easy step, keeping the power of a "Single source of thruth"
  2. Data and event propagation should be done in a declarative way
  3. Views should be developer in a reactive way.
  4. Multiple Stores are allowed for better organization
  5. We keep flux as it should be unidirectaional, so there is no coupling between the Action and the Views, neither between the Actions and the Store, neither between the Store and the View
  6. The Store state is implicit: The last value of all the events on the Store.

Installation

  1. Run on your terminal the following command:
    $ npm install @4geeksacademy/react-flux-dash --save
    
  2. To import the library anywhere you would like to use it:
    import Flux from '@4geeksacademy/react-flux-dash';
    

Let's build a Flux Workflow for authentication

1) First, declare your Store

import Flux from '@4geeksacademy/react-flux-dash';

class SessionStore extends Flux.DashStore{
    constructor(){
        super();
        // Declare an Event
        this.addEvent("onLogout");
        // Or Declare an event with some imutable transformation logic
        this.addEvent("login", (state) => {
            // Do something with the data before propagating the Event
            return Object.assign(state, {"key": "value"})
        });
        // Or Declare an event with some plain transformation logic
        this.addEvent("login", (state) => {
            state.some_other_property = "Some other Data";
            return Object.assign(state, {"key": "value"})
        });
    }
}
export default new SessionStore();

2) Registering with the Store changes

import React from 'react';
import SessionStore from '/path/to/store';

class View extends React.Component {
      constructor(){
          super();
      }

      componentDidMount() {
          const me = this;
          this.loginSubscription = SessionStore.subscribe("login", (state) => {
              // Do something usefull with the Event Data
              me.userName = state.user.name;
          });
          // Register some method
          this.logoutSubscription = SessionStore.subscribe("logout", this.logOutEvent().bind(this));
      }

      logOutEvent(state){
        //DO something with the state or the state of the Store
        const storeState = SessionStore.getState()
      }

      componentWillUnMount() {
          // Don't forget to release the subscription
          this.loginSubscription.unsubscribe();
          this.logoutSubscription.unsubscribe();
      }
  }

3) Define some action that will trigger the event

import Flux from '@4geeksacademy/react-flux-dash';

const authenticateAction = (username, password)=> {
      // Don't forget to Validate the data ex: username !=== undefined
      let dataToSave = {
          authenticated: true
      }
      Flux.dispatchEvent('login', dataToSave)
}

export default {authenticateAction};

4) Glue all together using the Action from the View

import React from 'react';
import SessionStore from '/path/to/store';
import {authenticateAction} from 'path/to/action';

class View extends React.Component {
      constructor(){
          super();
      }

      componentDidMount() {
          const me = this;
          this.loginSubscription = SessionStore.subscribe("login", (state) => {
              // Do something usefull with the Event Data
              me.userName = state.user.name;
          });
          // Register some method
          this.logoutSubscription = SessionStore.subscribe("logout", this.logOutEvent().bind(this));
      }

      logOutEvent(state){
        //DO something with the state or the state of the Store
        const storeState = SessionStore.getState()
      }

      componentWillUnMount() {
          // Don't forget to release the subscription
          this.loginSubscription.unsubscribe();
          this.logoutSubscription.unsubscribe();
      }

      login(){
        authenticateAction(this.state.username, this.state.password);
      }

  }

ChangeLog:

v 3.0.0

  • Add a clearState method for the Store to set all Values to null
  • Add a parameter to the subscription, to request the last value of the Event if wanted
  • Add a Helper React View, to subscribe and unsubscribe to the Store wanted

Contributors

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.