Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 1.76 KB

README.md

File metadata and controls

41 lines (28 loc) · 1.76 KB

Storybook Addon Notes

Greenkeeper badge Build Status CodeFactor Known Vulnerabilities BCH compliance codecov Storybook Slack

Storybook Addon Notes allows you to write notes for your stories in Storybook.

This addon works with Storybook for: React.

Storybook Addon Notes Demo

Getting Started

npm i --save-dev @storybook/addon-notes

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

Add following content to it:

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

Then write your stories like this:

import { storiesOf } from '@storybook/react';
import { withNotes } from '@storybook/addon-notes';

import Component from './Component';

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