| title | sidebar | ||||
|---|---|---|---|---|---|
Addon API |
|
Storybook's API allows developers to interact programmatically with Storybook. With the API, developers can build and deploy custom addons and other tools that enhance Storybook's functionality.
Our API is exposed via two distinct packages, each one with a different purpose:
@storybook/manager-apiused to interact with the Storybook manager UI or access the Storybook API.@storybook/preview-apiused to control and configure the addon's behavior.
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
The add method allows you to register the type of UI component associated with the addon (e.g., panels, toolbars, tabs). For a minimum viable Storybook addon, you should provide the following arguments:
type: The type of UI component to register.title: The title to feature in the Addon Panel.render: The function that renders the addon's UI component.
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
The render function is called with `active`. The `active` value will be true when the panel is focused on the UI.Serves as the entry point for all addons. It allows you to register an addon and access the Storybook API. For example:
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
Now you'll get an instance to our StorybookAPI. See the api docs for Storybook API regarding using that.
Get an instance to the channel to communicate with the manager and the preview. You can find this in both the addon register code and your addon’s wrapper component (where used inside a story).
It has a NodeJS EventEmitter compatible API. So, you can use it to emit events and listen to events.
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
Use the makeDecorator API to create decorators in the style of the official addons. Like so:
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
If the story's parameters include `{ exampleParameter: { disable: true } }` (where `exampleParameter` is the `parameterName` of your addon), your decorator will not be called.The makeDecorator API requires the following arguments:
name: Unique name to identify the custom addon decorator.parameterName: Sets a unique parameter to be consumed by the addon.skipIfNoParametersOrOptions: (Optional) Doesn't run the decorator if the user hasn't options either via decorators or parameters.wrapper: your decorator function. Takes thegetStory,context, and both theoptionsandparameters(as defined inskipIfNoParametersOrOptionsabove).
Storybook's API allows you to access different functionalities of Storybook UI.
The selectStory API method allows you to select a single story. It accepts the following two parameters; story kind name and an optional story name. For example:
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
This is how you can select the above story:
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
Similar to the selectStory API method, but it only accepts the story as the only parameter.
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
This method allows you to set query string parameters. You can use that as temporary storage for addons. Here's how you define query params:
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
Additionally, if you need to remove a query parameter, set it as null instead of removing them from the addon. For example:
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
Allows retrieval of a query parameter enabled via the setQueryParams API method. For example:
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
This method allows you to get the application URL state, including any overridden or custom parameter values. For example:
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
This method allows you to register a handler function called whenever the user navigates between stories.
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
This method allows you to override the default Storybook UI configuration (e.g., set up a theme or hide UI elements):
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
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 toolbar | 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 } } |
The following options are configurable under the sidebar namespace:
| Name | Type | Description | Example Value |
|---|---|---|---|
| showRoots | Boolean | Display the top-level nodes as a "root" in the sidebar | false |
| collapsedRoots | Array | Set of root node IDs to visually collapse by default | ['misc', 'other'] |
| renderLabel | Function | Create a custom label for tree nodes; must return a ReactNode | (item, api) => <abbr title="...">{item.name}</abbr> |
The following options are configurable under the toolbar namespace:
| Name | Type | Description | Example Value |
|---|---|---|---|
| id | String | Toggle visibility for toolbar item | { hidden: false } |
To help streamline addon development and reduce boilerplate code, the API exposes a set of hooks to access Storybook's internals. These hooks are an extension of the @storybook/manager-api package.
It allows access to Storybook's internal state. Similar to the useglobals hook, we recommend optimizing your addon to rely on React.memo, or the following hooks; useMemo, useCallback to prevent a high volume of re-render cycles.
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
The useStorybookApi hook is a convenient helper to allow you full access to the Storybook API methods.
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
Allows setting subscriptions to events and getting the emitter to emit custom events to the channel.
The messages can be listened to on both the iframe and the manager.
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
The useAddonState is a useful hook for addons that require data persistence, either due to Storybook's UI lifecycle or for more complex addons involving multiple types (e.g., toolbars, panels).
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
The useParameter retrieves the current story's parameters. If the parameter's value is not defined, it will automatically default to the second value defined.
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
Extremely useful hook for addons that rely on Storybook Globals. It allows you to obtain and update global values. We also recommend optimizing your addon to rely on React.memo, or the following hooks; useMemo, useCallback to prevent a high volume of re-render cycles.
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
Hook that allows you to retrieve or update a story's args.
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
Learn more about the Storybook addon ecosystem
- Types of addons for other types of addons
- Writing addons for the basics of addon development
- Presets for preset development
- Integration catalog for requirements and available recipes
- API reference to learn about the available APIs