@kadira/storybook-addon-notes

Write notes for your Storybook stories.

Stats

StarsIssuesVersionUpdatedCreatedSize
@kadira/storybook-addon-notes
3401.0.15 years ago5 years agoMinified + gzip package size for @kadira/storybook-addon-notes in KB

Readme

Storybook Addon Notes

This Storybook addon allows you to write notes for your stories.

Storybook Addon Notes Demo

Getting Started

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

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

Add following content to it:

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

Then write your stories like this:

import React from 'react';
import { storiesOf, action } from '@kadira/storybook';
import Button from './Button';
import { WithNotes } from '@kadira/storybook-addon-notes';

storiesOf('Button', module)
  .add('with text', () => (
    <WithNotes notes={'This is a very simple Button and you can click on it.'}>
      <Button onClick={action('clicked')}>Hello Button</Button>
    </WithNotes>
  ))
  .add('with some emoji', () => (
    <WithNotes notes={'Here we use some emoji as the Button text. Isn\'t it look nice?'}>
      <Button onClick={action('clicked')}>😀 ğŸ˜Ž 👍 💯</Button>
    </WithNotes>
  ));

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.