@jamesbliss/storybook-state v0.0.1

Storybook state

Getting Started

npm install --save @sambego/storybook-state

First you will need to create a new store, to save the state and handle updates. You can add all properties which you component expects, and the State component will propagate them to your component. Once you've created the store, yo can wrap your components in a State component and pass along the store.

In the example below we create a modal which will expect an active property. When clicking on the button we will update the store, which in turn will update the property active on the modal;

import React from 'react';
import { storiesOf } from "@storybook/react";
import { State, Store} from '@sambego/storybook-state';

const store = new Store({
    active: false,
});

storiesOf('Button', module).add('with text', () => (
    <div>
        <State store={store}>
            <Modal>
                Modal content
            </Modal>
        </State>
        <Button onClick={() => store.set({ active: !store.get('active') })} />
    </div>
));

Store

The store has a few methods you can use to get and update the state.

When creating a new instance, you can pass along the initial state.

const store = new Store({
    foo: 'bar',
    active: true,
    items: ['item 1', 'item 2'],
})

You can retrieve a state from the store by using the get() method.

store.get('foo') // will return 'bar'
store.get('active') // will return true
store.get('items') // will return ['item 1', 'item 2']

You can update the store by using the set() method.

store.set({
    active: false,
    bar: 'foo',
});

You can subscribe to changes in the store by using the subscribe() method. You can register a callback, which will have the updated state as the first parameter whenever the state updates.

store.subscribe(state => // Do something with the updated state.

State component

The state component accepts one property, an instance of Store. All properties that depend on the state, or should update on state changes, should be added in the Store, and will be propagated to your component by the <State /> component.

<State store={store}>
    <StateDependendComponent />
</State>