Logo for jsDocs.io

@storybook/html

  • Version 9.0.12
  • Published
  • 38.1 kB
  • 2 dependencies
  • MIT license

Install

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

Overview

Storybook HTML renderer

Index

Functions

Interfaces

Type Aliases

Functions

function setProjectAnnotations

setProjectAnnotations: (
    projectAnnotations:
        | NamedOrDefaultProjectAnnotations<any>
        | NamedOrDefaultProjectAnnotations<any>[]
) => NormalizedProjectAnnotations<HtmlRenderer>;

  • Function that sets the globalConfig of your storybook. The global config is the preview module of your .storybook folder.

    It should be run a single time, so that your global config (e.g. decorators) is applied to your stories when using composeStories or composeStory.

    Example:

    // setup-file.js
    import { setProjectAnnotations } from '@storybook/preact';
    import projectAnnotations from './.storybook/preview';
    

    setProjectAnnotations(projectAnnotations);

    Parameter projectAnnotations

    E.g. (import projectAnnotations from '../.storybook/preview')

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/api/csf#default-export)

            type Preview

            type Preview = ProjectAnnotations<HtmlRenderer>;

              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/api/csf#named-story-exports)

                type StoryObj

                type StoryObj<TArgs = Args> = StoryAnnotations<HtmlRenderer, TArgs>;

                • Story object that represents a CSFv3 component example.

                  See Also

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

                Package Files (2)

                Dependencies (2)

                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>