• Version 7.6.17
  • Published
  • 48.7 kB
  • 8 dependencies
  • MIT license


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


Storybook Vue renderer



variable configure

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

    variable forceReRender

    const forceReRender: () => void;

      variable raw

      const raw: () => any;

        variable storiesOf

        const storiesOf: any;


          interface VueRenderer

          interface VueRenderer extends WebRenderer {}

            property component

            component: Component<any, any, any, any> | AsyncComponent<any, any, any, any>;

              property storyResult

              storyResult: StoryFnVueReturnType;

                Type Aliases

                type Decorator

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

                  type Loader

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

                    type Meta

                    type Meta<TCmpOrArgs = Args> = ComponentAnnotations<
                    • Metadata to configure the stories for a component.

                      See Also

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

                    type Preview

                    type Preview = ProjectAnnotations<VueRenderer>;

                      type Story

                      type Story<TArgs = Args> = StoryFn<TArgs>;
                      • See Also

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


                        Use StoryFn instead. Use StoryObj if you want to migrate to CSF3, which uses objects instead of functions to represent stories. You can read more about the CSF3 format here: https://storybook.js.org/blog/component-story-format-3-0/

                        Story function that represents a CSFv2 component example.

                      type StoryContext

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

                        type StoryFn

                        type StoryFn<TCmpOrArgs = Args> = AnnotatedStoryFn<
                        • 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<TMetaOrCmpOrArgs = Args> = TMetaOrCmpOrArgs extends {
                        render?: ArgsStoryFn<VueRenderer, any>;
                        component?: infer C;
                        args?: infer DefaultArgs;
                        ? TMetaOrCmpOrArgs extends Component<any>
                        ? StoryAnnotations<VueRenderer, ComponentPropsOrProps<TMetaOrCmpOrArgs>>
                        : Simplify<
                        ComponentProps<C> & ArgsFromMeta<VueRenderer, TMetaOrCmpOrArgs>
                        > extends infer TArgs
                        ? StoryAnnotations<
                        SetOptional<TArgs, Extract<keyof TArgs, keyof DefaultArgs>>
                        : never
                        : StoryAnnotations<VueRenderer, ComponentPropsOrProps<TMetaOrCmpOrArgs>>;
                        • 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)

                        Package Files (2)

                        Dependencies (8)

                        Dev Dependencies (3)

                        Peer Dependencies (4)


                        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
                        • 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>