Add to the integration catalog

Storybook has two types of integrations, addons and recipes, which are listed in the integration catalog.

Addons

Storybook addons are 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 a npm package that follows these requirements:

• package.json with module information and addon metadata
• README.md file with installation and configuration instructions
• /dist directory containing transpiled ES5 code
• preset.js file written as an ES5 module at the root level

Addon metadata

We rely on metadata to organize your addon in the catalog. You must add the storybook-addon as the first keyword, followed by your addon's category. Additional keywords will be used in search and as tags.

Customize your addon's appearance by adding the storybook property with the following fields.

Use the list below as a reference when filling in the values for both the supportedFrameworks and unsupportedFrameworks fields.

• react
• vue
• angular
• web-components
• ember
• html
• svelte
• preact
• react-native

{
  "name": "storybook-addon-example",
  "version": "1.0.0",
  "description": "Outline all elements with CSS to help with layout placement and alignment",
  "repository": {
    "type": "git",
    "url": "https://github.com/chromaui/storybook-addon-example"
  },
  "author": "winkerVSbecks",
  "keywords": ["storybook-addon", "style", "debug", "layout", "css"],
  "storybook": {
    "displayName": "Outline",
    "unsupportedFrameworks": ["vue"],
    "supportedFrameworks": ["react", "angular"],
    "icon": "https://yoursite.com/addon-icon.png"
  }
}

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. However, there may be a slight delay between the time you publish your addon and when it's listed. If your addon doesn't appear in the catalog after a short period, check it to ensure it includes the required fields, keywords, and information outlined in the above sections. This information is essential for the catalog to index and display your addon correctly. You can also run the following command to confirm that the latest npm version includes the catalog metadata:

npm view your-addon-package-name --json

If everything looks correct, but your addon is still missing from the catalog, please open an issue in the Storybook documentation repository. Include the npm package URL (including the latest version), the package repository, and the command output to help the team investigate further and resolve any potential indexing issues.

Recipes

Recipes are a set of instructions to integrate third-party libraries into Storybook in cases where an addon does not exist or the integration requires some manual effort.

Who owns them?

Recipes are written and maintained by the Storybook team. We create recipes based on community popularity, tool maturity, and stability of the integration. Our goal is to ensure that recipes continue to work over time.

Not finding the recipe that you want? If it's popular in the community, our docs team will write one. In the mean time, try searching for a solution — it's likely that someone has the same requirements as you do. You can also help us out by writing recipes on your own site which speeds up the research process.

Request a recipe

If you'd like to request a recipe, open a new discussion in our GitHub repo. We'll review your request, and if it's popular, we'll add it to our backlog and prioritize it.

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