jsDocs.io logo

@storybook/react

  • Version 6.3.7
  • Published
  • 98.5 kB
  • 23 dependencies
  • MIT license

Install

npm i @storybook/react
yarn add @storybook/react
pnpm add @storybook/react

Overview

Storybook for React: Develop React Component in isolation with Hot Reloading.

Index

Variables

Type Aliases

Variables

variable addDecorator

const addDecorator: any;

    variable addParameters

    const addParameters: any;

      variable configure

      const configure: (loader: any, module: any) => void;

        variable forceReRender

        const forceReRender: () => void;

          variable getStorybook

          const getStorybook: () => IStorybookSection[];

            variable raw

            const raw: () => any;

              variable setAddon

              const setAddon: (addon: any) => void;

                variable storiesOf

                const storiesOf: any;

                  Type Aliases

                  type ComponentMeta

                  type ComponentMeta<
                      T extends keyof JSX.IntrinsicElements | JSXElementConstructor<any>
                  > = Meta<ComponentProps<T>>;

                  • For the common case where a component's stories are simple components that receives args as props:

                    export default { ... } as ComponentMeta<typeof Button>;

                  type ComponentStory

                  type ComponentStory<
                      T extends keyof JSX.IntrinsicElements | JSXElementConstructor<any>
                  > = Story<ComponentProps<T>>;

                  • For the common case where a story is a simple component that receives args as props:

                    const Template: ComponentStory<typeof Button> = (args) => <Button {...args} />

                  type DecoratorFn

                  type DecoratorFn = Parameters<typeof addDecorator>[0];

                    type Meta

                    type Meta<Args = DefaultArgs> = BaseMeta<ReactComponent> &
                        Annotations<Args, ReactReturnType>;

                    • Metadata to configure the stories for a component.

                      See Also

                      • [Default export](https://storybook.js.org/docs/formats/component-story-format/#default-export)

                    type Story

                    type Story<Args = DefaultArgs> = BaseStory<Args, ReactReturnType> &
                        Annotations<Args, ReactReturnType>;

                    • Story function that represents a component example.

                      See Also

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

                    Package Files (4)

                    Dependencies (23)

                    Dev Dependencies (3)

                    Peer Dependencies (3)

                    Badge

                    To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                    You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@storybook/react.

                    • Markdown
                      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@storybook/react)
                    • HTML
                      <a href="https://www.jsdocs.io/package/@storybook/react"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>