New
Code coverage with Storybook test runnerAutomate with Chromatic
Star74,802
Back to Create an Addon
React
Chapters
  • Introduction
  • Setup
  • Register addon
  • Track state
  • Decorators
  • Preset
  • Add to catalog
  • Conclusion

Setup

Get started with the Addon Kit

We'll use the Addon Kit to bootstrap our project. It gives you everything you need to build a Storybook addon:

  • ๐Ÿ“ Live-editing in development mode
  • โš›๏ธ React/JSX support for the UI
  • ๐Ÿ“ฆ Transpiling and bundling with Babel
  • ๐Ÿท Plugin metadata
  • ๐Ÿšข Release management with Auto

To start, click the Use this template button on the Addon Kit repository. This will generate a new repository for you with all the Addon Kit code.

addon kit

Next, clone your repository and install dependencies.

Copy
yarn

The Addon Kit uses TypeScript by default. However, we'll use the eject command to convert the boilerplate code to JavaScript for the purposes of this tutorial.

Copy
yarn eject-ts

This will convert all code to JS. It is a destructive process, so we recommended running this before you start writing any code.

Finally, start the development mode. This starts up Storybook and runs babel in watch mode.

Copy
yarn start

The addon code lives in the src directory. The included boilerplate code demonstrates the three UI paradigms and other concepts such as managing state and interacting with a story. We'll explore this in more detail in the next few sections.

Keep your code in sync with this chapter. View d3b6651 on GitHub.
Is this free guide helping you? Tweet to give kudos and help other devs find it.
Next Chapter
Register addon
Build the addon UI and register it in Storybook
โœ๏ธ Edit on GitHub โ€“ PRs welcome!
Join the community
5,870 developers and counting
WhyWhy StorybookComponent-driven UI
Open source software
Storybook

Maintained by
Chromatic
Special thanks to Netlify and CircleCI