@menseb/react-context v1.0.2

React Context

A simple package to use the reducer pattern with React Context.

Installation

npm i @menseb/react-context

How to use

• Import the module

import createReactContext from '@menseb/react-context';
// or
import { createReactContext } from '@menseb/react-context';

• Create your actions (required)

export const actions = {
    foo: (state, arguments) => {
        const { bar } = state;

        const { baz } = arguments;

        return { ...state, bar: baz };
    }
}

• Create your initial value (optional)

export const initial = { bar: false };

• Create your configuration function (optional)

export function config(initial) {
    const { bar } = initial;

    return { bar: !bar };
}

• Export your context

export const Context = createReactContext({
    actions,
    config,
    initial,
});

// const { Consumer, Povider, useReactContext } = Context;

• Import your context and setup its Provider

import Context from 'path/to/my/context.js';
import App from 'path/to/my/app.js';

render(
    <Context.Provider>
        <App>
    </Context.Provider>,
    document.getElementById('root')
);

• Use your context with Consumer or hook

import Context from 'path/to/my/context.js';

export default function App() {
    return (
        <Context.Consumer>
            {({ api, state }) => (
                <>
                    <p>{`state: ${state}`}</p>
                    <button onClick={() => api.foo({ baz: true })}>
                        Click
                    </button>
                </>
            )}
        </Context.Consumer>
    );
}

// or

export default function App() {
    const { api, state } = Context.useReactContext();

    function click() {
        return api.foo({ baz: true });
    }

    return (
        <>
            <p>{`state: ${state}`}</p>
            <button onClick={click}>
                Click
            </button>
        </>
    );
}

ISC License

ISC License

Copyright (c) 2020, Sébastien Menard

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.