@storybook/addon-viewport

  • Version 8.1.3
  • Published
  • 16.6 kB
  • 1 dependency
  • MIT license

Install

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

Overview

Build responsive components by adjusting Storybook’s viewport size and orientation

Index

Variables

variable DEFAULT_VIEWPORT

const DEFAULT_VIEWPORT: string;

    variable INITIAL_VIEWPORTS

    const INITIAL_VIEWPORTS: ViewportMap;

      variable MINIMAL_VIEWPORTS

      const MINIMAL_VIEWPORTS: ViewportMap;

        Interfaces

        interface Viewport

        interface Viewport {}

          property name

          name: string;

            property styles

            styles: Styles;

              property type

              type: 'desktop' | 'mobile' | 'tablet' | 'other';

                interface ViewportAddonParameter

                interface ViewportAddonParameter {}

                  property defaultOrientation

                  defaultOrientation?: 'portrait' | 'landscape';

                    property defaultViewport

                    defaultViewport?: string;

                      property disable

                      disable?: boolean;

                        property viewports

                        viewports?: ViewportMap;

                          interface ViewportMap

                          interface ViewportMap {}

                            index signature

                            [key: string]: Viewport;

                              interface ViewportStyles

                              interface ViewportStyles {}

                                property height

                                height: string;

                                  property width

                                  width: string;

                                    Type Aliases

                                    type Styles

                                    type Styles =
                                    | ViewportStyles
                                    | ((s: ViewportStyles | undefined) => ViewportStyles)
                                    | null;

                                      Package Files (2)

                                      Dependencies (1)

                                      Dev Dependencies (11)

                                      Peer Dependencies (0)

                                      No peer dependencies.

                                      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-viewport.

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