Skip to content

Commit

Permalink
Docs: Improve layout customisations docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Sidnioulz
Sidnioulz committed Feb 1, 2025
1 parent fd38b47 commit 87a4311
Show file tree
Hide file tree
Showing 4 changed files with 74 additions and 21 deletions.
39 changes: 37 additions & 2 deletions docs/_snippets/storybook-config-layout.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,45 @@ addons.setConfig({
initialActive: 'sidebar',
layoutCustomisations: {
showSidebar(state, defaultValue) {
return (state.storyId === 'landing') ? false : defaultValue;
return state.storyId === 'landing' ? false : defaultValue;
},
showToolbar(state, defaultValue) {
return (state.viewMode === 'docs') ? false : defaultValue;
return state.viewMode === 'docs' ? false : defaultValue;
},
},
sidebar: {
showRoots: false,
collapsedRoots: ['other'],
},
toolbar: {
title: { hidden: false },
zoom: { hidden: false },
eject: { hidden: false },
copy: { hidden: false },
fullscreen: { hidden: false },
},
});
```

```ts filename=".storybook/manager.ts" renderer="common" language="ts"
import { addons, type State } from '@storybook/manager-api';

addons.setConfig({
navSize: 300,
bottomPanelHeight: 300,
rightPanelWidth: 300,
panelPosition: 'bottom',
enableShortcuts: true,
showToolbar: true,
theme: undefined,
selectedPanel: undefined,
initialActive: 'sidebar',
layoutCustomisations: {
showSidebar(state: State, defaultValue: boolean) {
return state.storyId === 'landing' ? false : defaultValue;
},
showToolbar(state: State, defaultValue: boolean) {
return state.viewMode === 'docs' ? false : defaultValue;
},
},
sidebar: {
Expand Down
2 changes: 1 addition & 1 deletion docs/_snippets/storybook-manager-sidebar-hide-on-landing.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ addons.setConfig({
},
},
});
```
```
19 changes: 18 additions & 1 deletion docs/_snippets/storybook-manager-toolbar-hide-on-docs.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,21 @@
```js filename="./storybook/manager.js" renderer="common" language="js"
import { addons } from '@storybook/manager-api';

addons.setConfig({
layoutCustomisations: {
// Always hide the toolbar on docs pages, and respect user preferences elsewhere.
showToolbar(state, defaultValue) {
if (state.viewMode === 'docs') {
return false;
}

return defaultValue;
},
},
});
```

```ts filename="./storybook/manager.ts" renderer="common" language="ts"
import { addons, type State } from '@storybook/manager-api';

addons.setConfig({
Expand All @@ -13,4 +30,4 @@ addons.setConfig({
},
},
});
```
```
35 changes: 18 additions & 17 deletions docs/configure/user-interface/features-and-behavior.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,20 @@ To control the layout of Storybook’s UI you can use `addons.setConfig` in your

The following table details how to use the API values:

| Name | Type | Description | Example Value |
| --------------------- | --------------- | ------------------------------------------------------- | --------------------------------------- |
| **navSize** | Number (pixels) | The size of the sidebar that shows a list of stories | `300` |
| **bottomPanelHeight** | Number (pixels) | The size of the addon panel when in the bottom position | `200` |
| **rightPanelWidth** | Number (pixels) | The size of the addon panel when in the right position | `200` |
| **panelPosition** | String | Where to show the addon panel | `'bottom'` or `'right'` |
| **enableShortcuts** | Boolean | Enable/disable shortcuts | `true` |
| **showToolbar** | Boolean | Show/hide tool bar | `true` |
| **theme** | Object | Storybook Theme, see next section | `undefined` |
| **selectedPanel** | String | Id to select an addon panel | `'storybook/actions/panel'` |
| **initialActive** | String | Select the default active tab on Mobile | `'sidebar'` or `'canvas'` or `'addons'` |
| **sidebar** | Object | Sidebar options, see below | `{ showRoots: false }` |
| **toolbar** | Object | Modify the tools in the toolbar using the addon id | `{ fullscreen: { hidden: false } } ` |
| Name | Type | Description | Example Value |
| ------------------------ | --------------- | ------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| **navSize** | Number (pixels) | The size of the sidebar that shows a list of stories | `300` |
| **bottomPanelHeight** | Number (pixels) | The size of the addon panel when in the bottom position | `200` |
| **rightPanelWidth** | Number (pixels) | The size of the addon panel when in the right position | `200` |
| **panelPosition** | String | Where to show the addon panel | `'bottom'` or `'right'` |
| **enableShortcuts** | Boolean | Enable/disable shortcuts | `true` |
| **showToolbar** | Boolean | Show/hide tool bar | `true` |
| **theme** | Object | Storybook Theme, see next section | `undefined` |
| **selectedPanel** | String | Id to select an addon panel | `'storybook/actions/panel'` |
| **initialActive** | String | Select the default active tab on Mobile | `'sidebar'` or `'canvas'` or `'addons'` |
| **layoutCustomisations** | Object | Layout customisation options, see below | `{ showSidebar: ({ viewMode }, defaultValue) => viewMode === 'docs' ? false : defaultValue` }` |
| **sidebar** | Object | Sidebar options, see below | `{ showRoots: false }` |
| **toolbar** | Object | Modify the tools in the toolbar using the addon id | `{ fullscreen: { hidden: false } } ` |

The following options are configurable under the `sidebar` namespace:

Expand All @@ -48,7 +49,7 @@ The following options are configurable under the `layoutCustomisations` namespac
| Name | Type | Description | Example Value |
| --------------- | -------- | --------------------------------- | ----------------------------------------------------------------------------- |
| **showSidebar** | Function | Toggle visibility for the sidebar | `({ storyId }, defaultValue) => storyId === 'landing' ? false : defaultValue` |
| **showToolbar** | Function | Toggle visibility for the toolbar | `({ viewMode }, defaultValue) => viewMode === 'docs' ? false : defaultValue` |
| **showToolbar** | Function | Toggle visibility for the toolbar | `({ viewMode }, defaultValue) => viewMode === 'docs' ? false : defaultValue` |

<Callout variant="warning">
The `showSidebar` and `showToolbar` functions let you hide parts of the UI that are essential to Storybook's functionality. If misused, they can make navigation impossible. When hiding the sidebar, ensure the displayed page provides an alternative means of navigation.
Expand All @@ -58,9 +59,9 @@ The following options are configurable under the `layoutCustomisations` namespac

Storybook's UI is highly customizable. Its API and configuration options, available via the `showSidebar` and `showToolbar` functions, allow you to control how the sidebar and toolbar elements are displayed. Both functions will enable you to include some default behavior and can be overridden to customize the UI to your needs.

### Overriding the sidebar
### Override sidebar visibility

If you need to configure the sidebar's default behavior, you can use the `showSidebar` function. This function enables you to configure its visibility and other properties to customize the sidebar's behavior. Below are the available options and an overview of how to use them.
The sidebar, present on the left of the screen, contains the search function and navigation menu. Users may show or hide it with a keyboard shortcut. If you want to force the sidebar to be visible or hidden in certain places, you can define a `showSidebar` function in `layoutCustomisations`. Below are the available parameters passed to this function and an overview of how to use them.

| Name | Type | Description | Example Value |
| ------------------------ | -------- | -------------------------------------------------------------- | ------------------------------------- |
Expand All @@ -83,7 +84,7 @@ If you need to configure the sidebar's default behavior, you can use the `showSi

<Callout variant="warning">

If you're using the `showSidebar` function to hide the sidebar, ensure the displayed page provides an alternative means of navigation.
If you're hiding the sidebar through `showSidebar`, ensure the displayed page provides an alternative means of navigation.

</Callout>

Expand Down

0 comments on commit 87a4311

Please sign in to comment.