Addon API

Core Addon API

This is the core addon API. This is how to get the addon API:

addons.getChannel()

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 for events.

addons.register()

This method allows you to register an addon and get the storybook API. You can do this only in the Manager App. See how we can use this:

Now you'll get an instance to our StorybookAPI. See the api docs for Storybook API regarding using that.

addons.add()

This method allows you to add a panel to Storybook. (Storybook's Action Logger is a panel). You can do this only in the Manager App. See how you can use this method:

The render function is called with active and key. The active value will be true when the panel is focused on the UI.

As you can see, you can set any React Component as the panel. Currently, it's one line of text. But you can do anything you want. It's a good practice to specify the panel title with the title key. You can use any plain text with it.

makeDecorator API

Use the makeDecorator API to create decorators in the style of the official addons. Like so:

The options to makeDecorator are:

  • name: The name of the export (e.g. withFoo)
  • parameterName: The name of the parameter your addon uses. This should be unique.
  • skipIfNoParametersOrOptions: Don't run your decorator if the user hasn't set options (via .addDecorator(withFoo(options)))) or parameters (.add('story', () => <Story/>, { foo: 'param' }), or .addParameters({ foo: 'param' })).
  • allowDeprecatedUsage: support the deprecated "wrapper" usage (.add('story', () => withFoo(options)(() => <Story/>))).
  • wrapper: your decorator function. Takes the storyFn, context, and both the options and parameters (as defined in skipIfNoParametersOrOptions above).

πŸ’‘ If the story's parameters include { foo: { disable: true } } (where foo is the parameterName of your addon), your decorator will not be called.


Storybook hooks

Writing addons can be simplified a lot by using these Storybook hooks:

useStorybookState

It allows full access to the entire storybook state. Your component will re-render whenever the storybook state changes.

If you use this, remember your component will be re-rendered a lot, and you may need to optimize for that using React.memo or useMemo or PureComponent.

useStorybookApi

It allows full access to the storybook API.

Details on the Storybook API are further down.

useChannel

Allows both setting subscriptions to events and getting the emitter for emitting custom events to the channel.

The messages can be listened to on both the iframe and the manager side.

useAddonState

Extremely useful for addons that need to persist in some form of state.

Storybook may unmount your addon component, so keeping local state might not work well.

Also, some addons consist of multiple parts, some parts in a panel, some in the toolbar, etc.

With this hook, addons can access the same portion of the state, persisted even if the components are unmounted.

useParameter

This hook gets you the current story's parameter.

If the parameter isn't set, the default value (second argument) is returned instead.

useGlobals

Extremely useful hook for addons that rely on Storybook Globals.

It allows you to retrieve and update any Storybook Globals you want.

If you use this hook, remember that your component will render a lot, and you may need to optimize for that using React.memo or useMemo or useCallback.

useArgs

You can use this handy Storybook hook in your addon if you need to read or update args.


Storybook API

Storybook API allows you to access different functionalities of Storybook UI. You can move an instance to the Storybook API when registering an addon.

Let's have a look at API methods.

api.selectStory()

With this method, you can select a story via an API. This method accepts two parameters.

  1. story kind name
  2. story name (optional)

Let's say you've got a story like this:

This is how you can select the above story:

api.selectInCurrentKind()

Same as selectStory, but accepts a story inside current kind as the only parameter:

api.setQueryParams()

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:

πŸ’‘ If you need to remove a query param, use null for that. For example, we need to remove the bbc query param. See below how to do it:

api.getQueryParam()

This method allows you to get a query param set by the above API setQueryParams. For example, we need to get the bbc query param. Then this is how we do it:

api.getUrlState(overrideParams)

This method allows you to get the application URL state with some changed params. For example, if you want to get a link to a particular story:

api.on(eventName, fn)

This method allows you to register a handler function called whenever the user navigates between stories.

addons.setConfig(config)

This method allows you to override the default Storybook UI configuration (e.g., set up a theme or hide UI elements):

The following table details how to use the API values:

NameTypeDescriptionExample Value
isFullscreenBooleanShow story component as full screenfalse
showNavBooleanDisplay panel that shows a list of storiestrue
showPanelBooleanDisplay panel that shows addon configurationstrue
panelPositionString/ObjectWhere to show the addon panelbottom or right
enableShortcutsBooleanEnable/disable shortcutstrue
showToolbarBooleanShow/hide tool bartrue
themeObjectStorybook Theme, see next sectionundefined
selectedPanelStringId to select an addon panelstorybook/actions/panel
initialActiveStringSelect the default active tab on Mobilesidebar or canvas or addons
sidebarObjectSidebar options, see below{ showRoots: false }
toolbarObjectModify the tools in the toolbar using the addon id{ fullscreen: { hidden: false } } }

The following options are configurable under the sidebar namespace:

NameTypeDescriptionExample Value
showRootsBooleanDisplay the top-level nodes as a "root" in the sidebarfalse
collapsedRootsArraySet of root node IDs to visually collapse by default['misc', 'other']
renderLabelFunctionCreate a custom label for tree nodes; must return a ReactNode(item) => <abbr title="...">{item.name}</abbr>

The following options are configurable under the toolbar namespace:

NameTypeDescriptionExample Value
idStringToggle visibility for toolbar item{ hidden: false }