@storybook/vue

  • Version 6.4.14
  • Published
  • 53.9 kB
  • 17 dependencies
  • MIT license

Install

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

Overview

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

Index

Variables

variable addDecorator

const addDecorator: any;

    variable addParameters

    const addParameters: any;

      variable configure

      const configure: (loader: Loadable, module: NodeModule) => 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 Meta

                  type Meta<TArgs = Args> = ComponentAnnotations<VueFramework, TArgs>;
                  • 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<TArgs = Args> = StoryFn<TArgs>;
                  • Story function that represents a CSFv2 component example.

                    See Also

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

                      NOTE that in Storybook 7.0, this type will be renamed to StoryFn and replaced by the current StoryObj type.

                  type StoryFn

                  type StoryFn<TArgs = Args> = AnnotatedStoryFn<VueFramework, TArgs>;
                  • Story function that represents a CSFv2 component example.

                    See Also

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

                  type StoryObj

                  type StoryObj<TArgs = Args> = StoryAnnotations<VueFramework, TArgs>;
                  • Story function that represents a CSFv3 component example.

                    See Also

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

                  type VueFramework

                  type VueFramework = {
                  component: Component<any, any, any, any> | AsyncComponent<any, any, any, any>;
                  storyResult: StoryFnVueReturnType;
                  };

                    Package Files (3)

                    Dependencies (17)

                    Dev Dependencies (4)

                    Peer Dependencies (6)

                    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/vue.

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