Logo for jsDocs.io

@storybook/addon-backgrounds

  • Version 8.6.12
  • Published
  • 45.4 kB
  • 3 dependencies
  • MIT license

Install

npm i @storybook/addon-backgrounds
yarn add @storybook/addon-backgrounds
pnpm add @storybook/addon-backgrounds

Overview

Switch backgrounds to view components in different settings

Index

Functions

Interfaces

Functions

function _default

_default: () => core_dist_types.ProjectAnnotations<core_dist_types.Renderer>;

    Interfaces

    interface BackgroundsGlobals

    interface BackgroundsGlobals {}

      property backgrounds

      backgrounds: GlobalState;

      • Backgrounds configuration

        See Also

        • https://storybook.js.org/docs/essentials/backgrounds#globals

      interface BackgroundsParameters

      interface BackgroundsParameters {}

        property backgrounds

        backgrounds: {
            /** Default background color */
            default?: string;
            /** Remove the addon panel and disable the addon's behavior */
            disable?: boolean;
            /** Configuration for the background grid */
            grid?: Partial<GridConfig>;
            /** Available background colors */
            values?: Array<Background>;
        };

        • Backgrounds configuration

          See Also

          • https://storybook.js.org/docs/essentials/backgrounds#parameters

        Package Files (1)

        Dependencies (3)

        Dev Dependencies (4)

        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/addon-backgrounds.

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