storybookjs/storybook

Storybook is a frontend workshop for building UI components and pages in isolation. Thousands of teams use it for UI development, testing, and documentation. Find out more at storybook.js.org !
View README for:
Table of contents
- 🚀 Getting Started
- 📒 Projects
- 🛠 Supported Frameworks & Examples
- 🔗Addons
- 🏅 Badges & Presentation materials
- 👥 Community
- 👏 Contributing
- 👨‍💻 Development scripts
- 💸 Sponsors
- 💵 Backers
- :memo: License
Getting Started
Visit Storybook's website to learn more about Storybook and to get started.
Documentation
Documentation can be found on Storybook's docs site.
Examples
View Component Encyclopedia to see how leading teams use Storybook.
Use storybook.new to quickly create an example project in Stackblitz.
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.
Community
For additional help, share your issue in the repo's GitHub Discussions.
Projects
Supported Frameworks
| Renderer | Demo | |
| -------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| React | | |
| Angular | | |
| Vue 3 | | |
| Web components | | |
| React Native | | |
| HTML | | |
| Ember | | |
| Svelte | | |
| Preact | | |
| Qwik | | |
| SolidJS | | |
| Android, iOS, Flutter | | |
Addons
| Addons | |
| ------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| a11y | Test components for user accessibility in Storybook |
| actions | Log actions as users interact with components in the Storybook UI |
| backgrounds | Let users choose backgrounds in the Storybook UI |
| cssresources | Dynamically add/remove CSS resources to the component iframe |
| design assets | View images, videos, and weblinks alongside your story |
| docs | Add high quality documentation to your components |
| events | Interactively fire events to components that respond to EventEmitter |
| google-analytics | Reports google analytics on stories |
| graphql | Query a GraphQL server within Storybook stories |
| jest | View the results of components' unit tests in Storybook |
| links | Create links between stories |
| measure | Visually inspect the layout and box model within the Storybook UI |
| outline | Visually debug the CSS layout and alignment within the Storybook UI |
| query params | Mock query params |
| viewport | Change display sizes and layouts for responsive components using Storybook |
See Addon / Framework Support Table
To continue improving your experience, we have to eventually deprecate or remove certain addons in favor of new and better tools.