Logo for jsDocs.io

@storybook/html

  • Version 7.0.18
  • Published
  • 43.6 kB
  • 6 dependencies
  • MIT license

Install

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

Overview

Storybook HTML renderer

Index

Variables

Interfaces

Type Aliases

Variables

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;

          Interfaces

          interface HtmlRenderer

          interface HtmlRenderer extends WebRenderer {}

            property component

            component: string | HTMLElement | ArgsStoryFn<HtmlRenderer>;

              property storyResult

              storyResult: StoryFnHtmlReturnType;

                Type Aliases

                type Decorator

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

                  type Loader

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

                    type Meta

                    type Meta<TArgs = Args> = ComponentAnnotations<HtmlRenderer, 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 Preview

                    type Preview = ProjectAnnotations<HtmlRenderer>;

                      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)

                        Deprecated

                        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<HtmlRenderer, TArgs>;

                        type StoryFn

                        type StoryFn<TArgs = Args> = AnnotatedStoryFn<HtmlRenderer, 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<HtmlRenderer, 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)

                        Package Files (2)

                        Dependencies (6)

                        Dev Dependencies (1)

                        Peer Dependencies (1)

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

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