storybook-addon-recoil-flow/README.md

Shows a graph of the current recoil state

# storybook-addon-recoil-flow

Adds a panel to monitor the entire state of recoil for your story.

![Recoil Flow Logo](/images/logo.png)

## Setup

### Method 1: The Recoil Root is provided by another decorator addon

The addon can be installed by just installing via npm / yarn then adding `"storybook-addon-recoil-flow"` to the `addons` array in `./storybook/main.js`.
Ensure that this addon & whichever one is providing the RecoilRoot are in the correct order.

### Method 2: The Recoil Root is provided by a decorator within the story

- Install via npm / yarn
- Add `storybook-addon-recoil-flow/dist/register` to the addons array
- Import `withRecoilFlow` from `storybook-addon-recoil-flow/dist/decorator` within your story and put it into the `decorators` array (in the right order)

### Method 3: Just use the `RecoilRoot` provided by the decorator

- Install via npm / yarn
- The decorator provides a `RecoilRoot` with `overrides` set to false so the method in 1 will work without another decorator (but you'll not be able to set up a custom initialiser)

![Screenshot 1](/images/screenshot_1.png)

![Screenshot 2](/images/screenshot_2.png)

## Parameters

The `recoilFlow` parameter has the following optional options:

```js
  recoilFlow: {
    filter: {
      keys: ["AtomOne"],
      showConnected: true,
    },
  },
```

The `keys` array gets used in a `.startsWith` to filter out nodes so the long generated SelectorFamilyKeys can be matched with just the manually entered bit.

`showConnected` will show nodes which are connected to those in the `keys` array as well (defaults to true)


## Known issues
- if the plug-in panel is _after_ certain other plugins (e.g "Interactions" there's a bug in Storybook's css which'll cause this plugin to render improperly.