@storybook/addon-info

Storybook Info Addon

Storybook Info Addon will show additional information for your stories in Storybook. Useful when you want to display usage or other types of documentation alongside your story.

This addon works with Storybook for: React.

Usage

Install the following npm module:

npm i -D @storybook/addon-info

Then set the addon in the place you configure storybook like this:

import { configure, setAddon } from '@storybook/react';
import infoAddon from '@storybook/addon-info';

setAddon(infoAddon);

configure(function () {
  //...
}, module);

Then create your stories with the .addWithInfo API.

import React from 'react';
import Component from './Component';
import { storiesOf } from '@storybook/react';

storiesOf('Component')
  .addWithInfo(
    'simple usage',
    `This is the basic usage with the button with providing a label to show the text.`,
    () => (
      <Component>Click the "?" mark at top-right to view the info.</Componentp>
    ),
  );

Have a look at this example stories to learn more about the addWithInfo API.

The FAQ

Components lose their names on static build

Component names also get minified with other javascript code when building for production. When creating components, set the displayName static property to show the correct component name on static builds.