Build bulletproof UI components faster

Build Status on CircleCI Known Vulnerabilities codecov License
Storybook Community Backers on Open Collective Sponsors on Open Collective Official Twitter Handle

Storybook is a development environment for UI components.
It allows you to browse a component library, view the different states of each component, and interactively develop and test components. Find out more at

View README for:
latest next

Table of contents

- 📒 Projects
  - 🚇 Sub Projects
  - 🔗Addons
- 👥 Community
  - 👨‍💻 Development scripts
  - 💵 Backers
  - 💸 Sponsors
- :memo: License

Getting Started

Visit Storybook's website to learn more about Storybook, and to get started.


Documentation can be found Storybook's docs site.


Here are some featured examples that you can reference to see how Storybook works:

Storybook comes with a lot of addons for component design, documentation, testing, interactivity, and so on. Storybook's API makes it possible to configure and extend in various ways. It has even been extended to support React Native, Android, iOS, and Flutter development for mobile.


For additional help, join us in the Storybook Discord.


Supported Frameworks


Sub Projects

- CLI - Streamlined installation for a variety of app types
- examples - Code examples to illustrate different Storybook use cases



Deprecated Addons


In order to continue improving your experience, we have to eventually deprecate certain addons in favor of new, better tools.

If you're using info/notes, we highly recommend you to migrate to docs instead, and here is a guide to help you.

If you're using contexts, we highly recommend you to migrate to toolbars and here is a guide to help you.

Badges & Presentation materials

We have a badge! Link it to your live Storybook example.


  1. ```md [![Storybook](](link to site)
  2. ```

If you're looking for material to use in your presentation about storybook, like logo's video material and the colors we use etc, you can find all of that at our brand repo.


- Tweeting via @storybookjs
- Blogging at and Medium
- Chatting on Discord
- Streaming saved at Youtube


We welcome contributions to Storybook!

- 📥 Pull requests and 🌟 Stars are always welcome.
- Read our contributing guide to get started,
  or find us on Discord, we will take the time to guide you

Looking for a first issue to tackle?

- We tag issues with Good First Issue when we think they are well suited for people who are new to the codebase or OSS in general.
- Talk to us, we'll find something to suits your skills and learning interest.

Development scripts

Storybook is organized as a monorepo using Lerna. Useful scripts include:

yarn bootstrap

Installs package dependencies and links packages together - using lerna

yarn lint

boolean check if code conforms to linting rules - uses remark & eslint

- yarn lint:js - will check js
- yarn lint:md - will check markdown + code samples
- yarn lint:js --fix - will automatically fix js

yarn test

boolean check if unit tests all pass - uses jest

- yarn run test --core --watch - will run core tests in watch-mode


Become a sponsor and get your logo on our README on Github with a link to your site. \[Become a sponsor]


Support us with a monthly donation and help us continue our activities. \[Become a backer]


-the end-