npm install @storybook/addon-preview-wrapper
Build bulletproof UI components faster
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 https://storybook.js.org.
Table of contents
- 🚀 Getting Started
- 📒 Projects
- 🏅 Badges & Presentation materials
- 👥 Community
- 👏 Contributing
- :memo: License
Visit Storybook's website to learn more about Storybook and to get started.
Documentation can be found Storybook's docs site.
View Component Encyclopedia to see how leading teams use Storybook.
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.
|?||TODO, the link below will break|
|Android, iOS, Flutter|
- CLI - Streamlined installation for a variety of app types
- examples - Code examples to illustrate different Storybook use cases
|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, 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|
|storyshots||Snapshot testing for components in Storybook|
|storysource||View the code of your stories within the Storybook UI|
|viewport||Change display sizes and layouts for responsive components using Storybook|
|contexts||Addon for driving your components under dynamic contexts|
|info||Annotate stories with extra component usage information|
|knobs||Interactively edit component prop data in the Storybook UI|
|notes||Annotate Storybook stories with notes|
|options||Customize the Storybook UI in code|
In order to continue improving your experience, we have to eventually deprecate certain addons in favor of new, better tools.
Badges & Presentation materials
We have a badge! Link it to your live Storybook example.
[![Storybook](https://cdn.jsdelivr.net/gh/storybookjs/brand@main/badge/badge-storybook.svg)](link to site)
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 storybook.js.org and Medium
- Chatting on Discord
- Videos and streams 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 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.
Storybook is organized as a monorepo using Lerna. Useful scripts include:
Runs a sandbox template storybook with test stories
As above, but gives you options to customize the sandbox (e.g. selecting other frameworks)
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
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]