@storybook/addon-viewport

  • Version 8.5.3
  • Published
  • 26.9 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 INITIAL_VIEWPORTS_DATA

      const INITIAL_VIEWPORTS_DATA: {
      readonly iphone5: {
      readonly name: 'iPhone 5';
      readonly styles: { readonly height: '568px'; readonly width: '320px' };
      readonly type: 'mobile';
      };
      readonly iphone6: {
      readonly name: 'iPhone 6';
      readonly styles: { readonly height: '667px'; readonly width: '375px' };
      readonly type: 'mobile';
      };
      readonly iphone6p: {
      readonly name: 'iPhone 6 Plus';
      readonly styles: { readonly height: '736px'; readonly width: '414px' };
      readonly type: 'mobile';
      };
      readonly iphone8p: {
      readonly name: 'iPhone 8 Plus';
      readonly styles: { readonly height: '736px'; readonly width: '414px' };
      readonly type: 'mobile';
      };
      readonly iphonex: {
      readonly name: 'iPhone X';
      readonly styles: { readonly height: '812px'; readonly width: '375px' };
      readonly type: 'mobile';
      };
      readonly iphonexr: {
      readonly name: 'iPhone XR';
      readonly styles: { readonly height: '896px'; readonly width: '414px' };
      readonly type: 'mobile';
      };
      readonly iphonexsmax: {
      readonly name: 'iPhone XS Max';
      readonly styles: { readonly height: '896px'; readonly width: '414px' };
      readonly type: 'mobile';
      };
      readonly iphonese2: {
      readonly name: 'iPhone SE (2nd generation)';
      readonly styles: { readonly height: '667px'; readonly width: '375px' };
      readonly type: 'mobile';
      };
      readonly iphone12mini: {
      readonly name: 'iPhone 12 mini';
      readonly styles: { readonly height: '812px'; readonly width: '375px' };
      readonly type: 'mobile';
      };
      readonly iphone12: {
      readonly name: 'iPhone 12';
      readonly styles: { readonly height: '844px'; readonly width: '390px' };
      readonly type: 'mobile';
      };
      readonly iphone12promax: {
      readonly name: 'iPhone 12 Pro Max';
      readonly styles: { readonly height: '926px'; readonly width: '428px' };
      readonly type: 'mobile';
      };
      readonly iphoneSE3: {
      readonly name: 'iPhone SE 3rd generation';
      readonly styles: { readonly height: '667px'; readonly width: '375px' };
      readonly type: 'mobile';
      };
      readonly iphone13: {
      readonly name: 'iPhone 13';
      readonly styles: { readonly height: '844px'; readonly width: '390px' };
      readonly type: 'mobile';
      };
      readonly iphone13pro: {
      readonly name: 'iPhone 13 Pro';
      readonly styles: { readonly height: '844px'; readonly width: '390px' };
      readonly type: 'mobile';
      };
      readonly iphone13promax: {
      readonly name: 'iPhone 13 Pro Max';
      readonly styles: { readonly height: '926px'; readonly width: '428px' };
      readonly type: 'mobile';
      };
      readonly iphone14: {
      readonly name: 'iPhone 14';
      readonly styles: { readonly height: '844px'; readonly width: '390px' };
      readonly type: 'mobile';
      };
      readonly iphone14pro: {
      readonly name: 'iPhone 14 Pro';
      readonly styles: { readonly height: '852px'; readonly width: '393px' };
      readonly type: 'mobile';
      };
      readonly iphone14promax: {
      readonly name: 'iPhone 14 Pro Max';
      readonly styles: { readonly height: '932px'; readonly width: '430px' };
      readonly type: 'mobile';
      };
      readonly ipad: {
      readonly name: 'iPad';
      readonly styles: { readonly height: '1024px'; readonly width: '768px' };
      readonly type: 'tablet';
      };
      readonly ipad10p: {
      readonly name: 'iPad Pro 10.5-in';
      readonly styles: { readonly height: '1112px'; readonly width: '834px' };
      readonly type: 'tablet';
      };
      readonly ipad11p: {
      readonly name: 'iPad Pro 11-in';
      readonly styles: { readonly height: '1194px'; readonly width: '834px' };
      readonly type: 'tablet';
      };
      readonly ipad12p: {
      readonly name: 'iPad Pro 12.9-in';
      readonly styles: { readonly height: '1366px'; readonly width: '1024px' };
      readonly type: 'tablet';
      };
      readonly galaxys5: {
      readonly name: 'Galaxy S5';
      readonly styles: { readonly height: '640px'; readonly width: '360px' };
      readonly type: 'mobile';
      };
      readonly galaxys9: {
      readonly name: 'Galaxy S9';
      readonly styles: { readonly height: '740px'; readonly width: '360px' };
      readonly type: 'mobile';
      };
      readonly nexus5x: {
      readonly name: 'Nexus 5X';
      readonly styles: { readonly height: '660px'; readonly width: '412px' };
      readonly type: 'mobile';
      };
      readonly nexus6p: {
      readonly name: 'Nexus 6P';
      readonly styles: { readonly height: '732px'; readonly width: '412px' };
      readonly type: 'mobile';
      };
      readonly pixel: {
      readonly name: 'Pixel';
      readonly styles: { readonly height: '960px'; readonly width: '540px' };
      readonly type: 'mobile';
      };
      readonly pixelxl: {
      readonly name: 'Pixel XL';
      readonly styles: { readonly height: '1280px'; readonly width: '720px' };
      readonly type: 'mobile';
      };
      };

        variable MINIMAL_VIEWPORTS

        const MINIMAL_VIEWPORTS: ViewportMap;

          Interfaces

          interface Config

          interface Config {}

            property disable

            disable: boolean;

              property options

              options: Record<string, ModernViewport>;

                interface ModernViewport

                interface ModernViewport {}

                  property name

                  name: string;

                    property styles

                    styles: ViewportStyles;

                      property type

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

                        interface Viewport

                        interface Viewport {}

                          property name

                          name: string;

                            property styles

                            styles: Styles;

                              property type

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

                                interface ViewportStyles

                                interface ViewportStyles {}

                                  property height

                                  height: string;

                                    property width

                                    width: string;

                                      Type Aliases

                                      type GlobalState

                                      type GlobalState = {
                                      value: string | undefined;
                                      isRotated: boolean;
                                      };

                                        type GlobalStateUpdate

                                        type GlobalStateUpdate = Partial<GlobalState>;

                                          type InitialViewportKeys

                                          type InitialViewportKeys = keyof typeof INITIAL_VIEWPORTS_DATA;

                                            type Styles

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

                                              type ViewportMap

                                              type ViewportMap = Record<string, Viewport>;

                                                Package Files (1)

                                                Dependencies (1)

                                                Dev Dependencies (5)

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