@storybook/html

  • Version 6.5.12
  • Published
  • 43.1 kB
  • 18 dependencies
  • MIT license

Install

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

Overview

Storybook for HTML: View HTML snippets 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 HtmlFramework

                  type HtmlFramework = {
                  component: HTMLElement;
                  storyResult: StoryFnHtmlReturnType;
                  };

                    type Meta

                    type Meta<TArgs = Args> = ComponentAnnotations<HtmlFramework, 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<HtmlFramework, 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<HtmlFramework, 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 (3)

                    Dependencies (18)

                    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>