Storybook addons are listed in the catalog and distributed via npm. The catalog is populated by querying npm's registry for Storybook-specific metadata in package.json.
Add your addon to the catalog by publishing an npm package that follows these requirements:
package.jsonwith module information and addon metadataREADME.mdfile with installation and configuration instructions/distdirectory containing transpiled ES5 codepreset.jsfile written as an ES5 module at the root level
Get a refresher on how to write a Storybook addon.
Addon metadata
We rely on metadata to organize your addon in the catalog. You must add the storybook-addons as the first keyword, followed by your addon's category. Additional keywords will be used in search and as tags.
| Property | Description | Example |
|---|---|---|
name | Addon package name | storybook-addon-outline |
description | Addon description | Outline all elements with CSS to help with layout placement and alignment |
author | Name of the author | winkerVSbecks |
keywords | List of keywords to describe the addon | ["storybook-addons","style","debug"] |
repository | Addon repository | {"type": "git","url": "https://github.com/someone/my-addon" } |
Customize your addon's appearance by adding the storybook property with the following fields.
| Property | Description | Example |
|---|---|---|
displayName | Display name | Outline |
icon | Link to custom icon for the addon (SVG are not supported) | https://yoursite.com/outline-icon.png |
unsupportedFrameworks | List of unsupported frameworks | ["vue"] |
supportedFrameworks | List of supported frameworks | ["react", "angular"] |
Use the table below as a reference when filling in the values for both the supportedFrameworks and unsupportedFrameworks metadata properties.
| react | vue | angular |
|---|---|---|
| web-components | ember | html |
| aurelia | preact | svelte |
| marionette | react-native |
The package.json above appears like below in the catalog. See an example of a production package.json here.
How long does it take for my addon to show up in the catalog?
Once you publish the addon, it will appear in the catalog. There may be a delay between the time you publish your addon and when it's listed in the catalog. If your addon doesn't show up within 24 hours, open an issue.
