@kadira/storybook-addon-notes

    1.0.1 • Public • Published

    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>
      ));

    Install

    npm i @kadira/storybook-addon-notes

    DownloadsWeekly Downloads

    26

    Version

    1.0.1

    License

    MIT

    Last publish

    Collaborators

    • madushan1000
    • kadira_user
    • thinkholic
    • pahans
    • roonyh
    • mnmtanish
    • arunoda