StoriesOf API

Edit this page

storiesOf is Storybook’s API for adding stories. Up until Storybook 5.2, it has been the primary way to create stories in Storybook.

In Storybook 5.2 we introduced a simpler and more portable Component Story Format, and all future tools and infrastructure will be oriented towards CSF. Therefore, we recommend migrating your stories out of storiesOf API, and even provide automated tools to do this.

That said, the storiesOf API is not deprecated. For the time being most existing Storybooks use the storiesOf API, and therefore we plan to support it for the foreseeable future.

storiesOf API

A Storybook is a collection of stories. Each story represents a single visual state of a component. For an overview of storybook story concepts, see “Writing Stories”.

Here’s a basic story file in the storiesOf API:

import React from 'react';
import { storiesOf } from '@storybook/react';
import { action } from '@storybook/addon-actions';
import Button from '../components/Button';

storiesOf('Button', module)
  .add('with text', () => <Button onClick={action('clicked')}>Hello Button</Button>)
  .add('with some emoji', () => (
    <Button onClick={action('clicked')}>
      <span role="img" aria-label="so cool">
        😀 😎 👍 💯
      </span>
    </Button>
  ));

The string argument to storiesOf is the component title. If you pass a string like 'Widgets|Button/Button' it can also be used to position your component’s story within Storybook’s story hierarchy.

Each .add call takes a story name, a story function that returns a renderable object (JSX in the case of React), and optionally some parameters, which are described below.

Decorators and parameters

Decorators and parameters can be specified globally, at the component level, or locally at the story level.

Global decorators are parameters are specified in the Storybook config:

addDecorator(storyFn => <blink>{storyFn()}</blink>);
addParameters({ foo: 1 });

Component-level decorators and parameters are supported as chained API calls:

storiesOf('Button', module)
.addDecorator(withKnobs)
.addParameters({ notes: someNotes });

Story-level parameters are provided as a third argument to .add:

storiesOf('Button', module).add(
'with text',
() => <Button onClick={action('clicked')}>Hello Button</Button>,
{ notes: someNotes }
);

And finally, story-level decorators are provided via parameters:

storiesOf('Button', module).add(
'with text',
() => <Button onClick={action('clicked')}>Hello Button</Button>,
{ decorators: withA11y }
);

Component Story Format migration

To make it easier to adopt the new Component Story Format (CSF), we’ve created an automatic migration tool to transform storiesOf API to Module format.

sb migrate storiesof-to-csf --glob src/**/*.stories.js

For more information, see the CLI’s Codemod README.