mirror of
https://github.com/storybookjs/storybook.git
synced 2025-04-05 02:41:08 +08:00
9571fe1572
# Conflicts: # addons/actions/package.json # addons/events/package.json # addons/events/src/index.ts # addons/ondevice-notes/package.json # dev-kits/addon-roundtrip/package.json # examples/dev-kits/package.json # examples/html-kitchen-sink/package.json # lib/client-api/package.json # lib/client-api/src/client_api.ts # lib/client-api/src/typings.d.ts # lib/client-api/tsconfig.json # lib/ui/src/index.js # yarn.lock
Storybook Notes Addon for react-native
The Notes Addon allows you to write notes (text or markdown) for your stories in Storybook.
Installation
yarn add -D @storybook/addon-ondevice-notes
Configuration
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';
Usage
Use the notes parameter to add a note to stories:
import { storiesOf } from '@storybook/react-native';
import Component from './Component';
storiesOf('Component', module).add('with some emoji', () => <Component />, {
notes: 'A very simple component',
});
See the crna-kitchen-sink app for more examples.