| title |
|---|
Viewport |
The Viewport toolbar item allows you to adjust the dimensions of the iframe your story is rendered in. It makes it easy to develop responsive UIs.
Out of the box, the Viewport addon offers you a standard set of viewports that you can use.
If you want to change the default set of viewports, you can set the global parameters.viewport parameter in your .storybook/preview.js:
<CodeSnippets paths={[ 'common/storybook-preview-change-viewports.js.mdx', 'common/storybook-preview-change-viewports.ts.mdx', ]} />
The viewport global can take an object with the following keys:
| Field | Type | Description | Default Value |
|---|---|---|---|
| defaultViewport | String | Sets the default viewport | 'responsive' |
| disable | Boolean | Disables the viewport | N/A |
| viewports | Object | The configuration object for the viewport | {} |
The viewports object needs the following keys:
| Field | Type | Description | Example values |
|---|---|---|---|
| name | String | Name for the viewport | 'Responsive' |
| styles | Object | Sets Inline styles to be applied to the story | {width:0,height:0} |
| type | String | Type of the device (e.g. desktop, mobile, or tablet) | desktop |
By default, Storybook uses a minimal set of viewports to get you started. But you're not restricted to these. The addon offers a more granular list of devices that you can use.
Change your .storybook/preview.js to the following:
<CodeSnippets paths={[ 'common/storybook-preview-granular-viewports.js.mdx', 'common/storybook-preview-granular-viewports.ts.mdx', ]} />
Start your Storybook, and you'll see the new devices that you can use.
See here the complete list of devices and their configurations.
If you have either a specific viewport or a list of viewports that you need to use, you can modify your .storybook/preview.js file and include them:
<CodeSnippets paths={[ 'common/storybook-preview-viewport-add-devices.js.mdx', ]} />
Make the following change to use them in your Storybook:
<CodeSnippets paths={[ 'common/storybook-preview-viewport-use-new-devices.js.mdx', 'common/storybook-preview-viewport-use-new-devices.ts.mdx', ]} />
Once you start Storybook, you'll see your new viewports and devices.
If you need, you can also add these two to another list of viewports.
For instance, if you want to use these two with the minimal set of viewports, you can do it like so:
<CodeSnippets paths={[ 'common/storybook-preview-merge-viewports.js.mdx', 'common/storybook-preview-merge-viewports.ts.mdx', ]} />
Both viewports (Kindle Fire 2 and Kindle Fire HD) will feature in the list of devices by merging them into the MINIMAL_VIEWPORTS.
There are cases where it's not practical for you to use a specific visual viewport on a global scale, and you need it to adjust it to an individual story.
Update your story through parameters to include your viewports at a component level or for a specific story:
<CodeSnippets paths={[ 'react/my-component-story-configure-viewports.js.mdx', 'react/my-component-story-configure-viewports.ts.mdx', 'vue/my-component-story-configure-viewports.js.mdx', 'vue/my-component-story-configure-viewports.ts.mdx', 'angular/my-component-story-configure-viewports.ts.mdx', 'web-components/my-component-story-configure-viewports.js.mdx', 'web-components/my-component-story-configure-viewports.ts.mdx', 'svelte/my-component-story-configure-viewports.js.mdx', ]} usesCsf3 csf2Path="essentials/viewport#snippet-my-component-story-configure-viewports" />
- Previous viewport: shift + v
- Next viewport: v
- Reset viewport: alt + v
If you need, you can edit them on the shortcuts page.