README.md

Storybook Addon On Device Notes

Storybook Addon On Device Notes allows you to write notes (text or markdown) for your stories in Storybook.

Framework Support

Getting Started

NOTE: Documentation on master branch is for alpha version, stable release is on release/4.0

yarn add -D @storybook/addon-ondevice-notes

Then create a file called rn-addons.js in your storybook config.

Add following content to it:

import '@storybook/addon-ondevice-notes/register';

Then import rn-addons.js next to your getStorybookUI call.

import './rn-addons';

Then add the withNotes decorator to all stories in your config.js:

// Import from @storybook/X where X is your framework
import { addDecorator } from '@storybook/react-native';
import { withNotes } from '@storybook/addon-ondevice-notes';

addDecorator(withNotes);

You can use the notes parameter to add a note to each story:

import { storiesOf } from '@storybook/react-native';

import Component from './Component';

storiesOf('Component', module).add('with some emoji', () => <Component />, {
  notes: 'A very simple component',
});