simple-react-state v0.0.7

simple-react-state

A simple react state manager based on react hooks and react-redux which makes working with both local and global states completely painless it also works pretty well with nested states.

Installing

yarn add simple-react-state

Getting Started

Using global state

import React from 'react';
import {
    Provider, configureStore, useGlobalState
} from 'simple-react-state';


let initialState = {
    user: {
        email: ""
    }
};

let store = configureStore({
    initialState: initialState
});

function UserInfo(props){
    const [user, updateUser] = useGlobalState('user');

    let setUserEmail = (e) => {
        updateUser({
            type: 'ASSIGN',
            field: 'email',
            value: e.target.value
        });
    }

    return (
        <div>
            User Email: {user.email}
            <br/>
            <input type="text" name="email" value={user.email} onChange={setUserEmail} />
        </div>
    );
}

const App = <Provider store={store}><UserInfo/></Provider>
ReactDOM.render(App, document.querySelector("#root"));

Using local state for the same example

//No need for Provider or configureStore because 
//we are not using global state here
import React from 'react';
import { useLocalState } from 'simple-react-state';


function UserInfo(props){
    const [user, updateUser] = useLocalState({email: ""})

    let setUserEmail = (e) => {
        updateUser({
            type: 'ASSIGN',
            field: 'email',
            value: e.target.value
        });
    }

    return (
        <div>
            User Email: {user.email}
            <br/>
            <input type="text" name="email" value={user.email} onChange={setUserEmail} />
        </div>
    );
}

const App = <UserInfo/>
ReactDOM.render(App, document.querySelector("#root"));

Supported action types are ASSIGN, PUSH, POP, REMOVE and FILTER. ASSIGN is for assigning a value to a field, PUSH, POP, REMOVE and FILTER are for arrays, these action types correspond with array methods.

setState

simple-react-state allows you to set global state with setState method from store object as

store.setState({
    type: 'ASSIGN',
    field: 'your field',
    value: 'your value'
});

Note: This should be used outside of your component.

With this in mind the first example above could be re-written to

import React from 'react';
import {
    Provider, configureStore,
    useGlobalState, useLocalState
} from 'simple-react-state';


let store = configureStore({});

store.setState(
    type: 'ASSIGN',
    field: 'user',
    value: {email: ''}
)

function UserInfo(props){
    const [user, updateUser] = useGlobalState('user');

    let setUserEmail = (e) => {
        updateUser({
            type: 'ASSIGN',
            field: 'email',
            value: e.target.value
        });
    }

    return (
        <div>
            User Email: {user.email}
            <br/>
            <input type="text" name="email" value={user.email} onChange={setUserEmail} />
        </div>
    );
}

const App = <Provider store={store}><UserInfo/></Provider>
ReactDOM.render(App, document.querySelector("#root"));

useGlobalState hook

useGlobalState works much like useState hook but it accepts a selection string and returns an array of three items which are state, updateState and dispatch, in most cases you will be using the first two items(state and updateState), the last item(dispatch) is for dispatching custom actions if you will have any. For example if you have a store with data like

{
    user: {
        name: 'Yezy',
        age: 24,
        account: {
            id: '23334',
            balance: 433.3
        }
    }
}

you can use useGlobalState hook to select a deeply nested state like

[age, updateAge, dispatch] = useGlobalState('user.age')

[account, updateAccount, dispatch] = useGlobalState('user.account')

[balance, updateBalance, dispatch] = useGlobalState('user.account.balance')

Note: If you pass nothing to useGlobalState the whole store is selected.

useLocalState hook

useLocalState works just like useState hook too, it accepts initial state as an argument except it returns an array of local state and updateState function(not setState like in useState hook).

let user = {
    name: 'Yezy',
    age: 24,
    account: {
        id: '23334',
        balance: 433.3
    }
}

[user, updateUser] = useLocalState(user)

updateState

updateState function works the same on both useGlobalState and useLocalState hooks, it dispatches an action to perform update on state, an action dispatched should have the following format

updateState({
    type: 'update type',
    field: 'your field',
    value: 'your value'
})

where type can be ASSIGN, PUSH, POP, REMOVE or FILTER

ASSIGN is the default action type, so if you haven't passed the type of your action that one will be used, therefore with this in mind

updateUser({
    field: 'email',
    value: 'user@email.com'
})

is the same as

updateUser({
    type: 'ASSIGN',
    field: 'email',
    value: 'user@email.com'
})

Pretty cool, right?