@storybook/react

Variables

• INTERNAL_DEFAULT_PROJECT_ANNOTATIONS

Functions

• composeStories()
• composeStory()
• setProjectAnnotations()

Interfaces

• ReactMeta

  • story()
• ReactPreview

  • meta()
  • type()
• ReactRenderer

  • component
  • mount
  • storyResult
• ReactStory

  • Component
• ReactTypes

  • parameters

Type Aliases

• AddMocks
• Decorator
• Loader
• Meta
• Preview
• StoryContext
• StoryFn
• StoryObj

Namespaces

• global

  • SymbolConstructor

variable INTERNAL_DEFAULT_PROJECT_ANNOTATIONS

const INTERNAL_DEFAULT_PROJECT_ANNOTATIONS: ProjectAnnotations<ReactRenderer>;

function composeStories

composeStories: <TModule extends Store_CSFExports<ReactRenderer, any>>(
    csfExports: TModule,
    projectAnnotations?: ProjectAnnotations<ReactRenderer>
) => Omit<StoriesWithPartialProps<ReactRenderer, TModule>, keyof Store_CSFExports>;

• Function that will receive a stories import (e.g. import * as stories from './Button.stories') and optionally projectAnnotations (e.g. `import * as projectAnnotations from '../.storybook/preview`) and will return an object containing all the stories passed, but now as a composed component that has all args/parameters/decorators/etc combined and applied to it.

  It's very useful for reusing stories in scenarios outside of Storybook like unit testing.

  Example:

  import { render } from '@testing-library/react';
  import { composeStories } from '@storybook/react';
  import * as stories from './Button.stories';
  
  const { Primary, Secondary } = composeStories(stories);
  
  test('renders primary button with Hello World', () => {
    const { getByText } = render(<Primary>Hello world</Primary>);
    expect(getByText(/Hello world/i)).not.toBeNull();
  });

  Parameter csfExports

  E.g. (import * as stories from './Button.stories')

  Parameter projectAnnotations

  E.g. (import * as projectAnnotations from '../.storybook/preview') this can be applied automatically if you use setProjectAnnotations in your setup files.

function composeStory

composeStory: <TArgs extends Args = Args>(
    story: StoryAnnotationsOrFn<ReactRenderer, TArgs>,
    componentAnnotations: ComponentAnnotations<
        ReactRenderer,
        ComponentProps<TCmpOrArgs>
    >,
    projectAnnotations?: ProjectAnnotations<ReactRenderer>,
    exportsName?: string
) => ComposedStoryFn<ReactRenderer, Partial<TArgs>>;

• Function that will receive a story along with meta (e.g. a default export from a .stories file) and optionally projectAnnotations e.g. (import * as projectAnnotations from '../.storybook/preview) and will return a composed component that has all args/parameters/decorators/etc combined and applied to it.

  It's very useful for reusing a story in scenarios outside of Storybook like unit testing.

  Example:

  import { render } from '@testing-library/react';
  import { composeStory } from '@storybook/react';
  import Meta, { Primary as PrimaryStory } from './Button.stories';
  
  const Primary = composeStory(PrimaryStory, Meta);
  
  test('renders primary button with Hello World', () => {
    const { getByText } = render(<Primary>Hello world</Primary>);
    expect(getByText(/Hello world/i)).not.toBeNull();
  });

  Parameter story

  Parameter componentAnnotations

  E.g. (import Meta from './Button.stories')

  Parameter projectAnnotations

  E.g. (import * as projectAnnotations from '../.storybook/preview') this can be applied automatically if you use setProjectAnnotations in your setup files.

  Parameter exportsName

  In case your story does not contain a name and you want it to have a name.

function setProjectAnnotations

setProjectAnnotations: (
    projectAnnotations:
        | NamedOrDefaultProjectAnnotations<any>
        | NamedOrDefaultProjectAnnotations<any>[]
) => NormalizedProjectAnnotations<ReactRenderer>;

• Function that sets the globalConfig of your storybook. The global config is the preview module of your .storybook folder.

  It should be run a single time, so that your global config (e.g. decorators) is applied to your stories when using composeStories or composeStory.

  Example:

  // setup-file.js
  import { setProjectAnnotations } from '@storybook/react';
  import projectAnnotations from './.storybook/preview';
  
  setProjectAnnotations(projectAnnotations);

  Parameter projectAnnotations

  E.g. (import * as projectAnnotations from '../.storybook/preview')

type AddMocks

type AddMocks<TArgs, DefaultArgs> = Simplify<{
    [T in keyof TArgs]: T extends keyof DefaultArgs
        ? DefaultArgs[T] extends (...args: any) => any & {
              mock: {};
          }
            ? DefaultArgs[T]
            : TArgs[T]
        : TArgs[T];
}>;

type Decorator

type Decorator<TArgs = StrictArgs> = DecoratorFunction<ReactRenderer, TArgs>;

type Loader

type Loader<TArgs = StrictArgs> = LoaderFunction<ReactRenderer, TArgs>;

type Meta

type Meta<TCmpOrArgs = Args> = [TCmpOrArgs] extends [ComponentType<any>]
    ? ComponentAnnotations<ReactRenderer, ComponentProps<TCmpOrArgs>>
    : ComponentAnnotations<ReactRenderer, TCmpOrArgs>;

• Metadata to configure the stories for a component.

  See Also

  • [Default export](https://storybook.js.org/docs/api/csf#default-export)

type Preview

type Preview = ProjectAnnotations<ReactRenderer>;

type StoryContext

type StoryContext<TArgs = StrictArgs> = StoryContext$1<ReactRenderer, TArgs>;

type StoryFn

type StoryFn<TCmpOrArgs = Args> = [TCmpOrArgs] extends [ComponentType<any>]
    ? AnnotatedStoryFn<ReactRenderer, ComponentProps<TCmpOrArgs>>
    : AnnotatedStoryFn<ReactRenderer, TCmpOrArgs>;

• Story function that represents a CSFv2 component example.

  See Also

  • [Named Story exports](https://storybook.js.org/docs/api/csf#named-story-exports)

type StoryObj

type StoryObj<TMetaOrCmpOrArgs = Args> = [TMetaOrCmpOrArgs] extends [
    {
        render?: ArgsStoryFn<ReactRenderer, any>;
        component?: infer Component;
        args?: infer DefaultArgs;
    }
]
    ? Simplify<
          (Component extends ComponentType<any>
              ? ComponentProps<Component>
              : unknown) &
              ArgsFromMeta<ReactRenderer, TMetaOrCmpOrArgs>
      > extends infer TArgs
        ? StoryAnnotations<
              ReactRenderer,
              AddMocks<TArgs, DefaultArgs>,
              SetOptional<TArgs, keyof TArgs & keyof DefaultArgs>
          >
        : never
    : TMetaOrCmpOrArgs extends ComponentType<any>
    ? StoryAnnotations<ReactRenderer, ComponentProps<TMetaOrCmpOrArgs>>
    : StoryAnnotations<ReactRenderer, TMetaOrCmpOrArgs>;

• Story object that represents a CSFv3 component example.

  See Also

  • [Named Story exports](https://storybook.js.org/docs/api/csf#named-story-exports)