gem-hunter
Language: TypeScript
Storybook is the industry standard workshop for building, documenting, and testing UI components in isolation
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 storybook.js.org!
View README for:
Visit Storybook's website to learn more about Storybook and to get started.
Documentation can be found on Storybook's docs site.
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.
For additional help, share your issue in the repo's GitHub Discussions.
| Renderer | Demo | |
|---|---|---|
| React | ||
| Angular | ||
| Vue 3 | ||
| Web components | ||
| React Native | ||
| HTML | ||
| Ember | ||
| Svelte | ||
| Preact | ||
| Qwik | ||
| SolidJS | ||
| Android, iOS, Flutter |
| 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.
If you're using info/notes, we highly recommend you migrate to docs instead, and here is a guide to help you.
If you're using contexts, we highly recommend you migrate to toolbars and here is a guide to help you.
If you're using addon-storyshots, we highly recommend you migrate to the Storybook test-runner and here is a guide to help you.
We have a badge! Link it to your live Storybook example.
[](link to site)
If you're looking for material to use in your Storybook presentation, such as logos, video material, and the colors we use, you can find it all on our brand repo.
Contributions to Storybook are always welcome!
Looking for a first issue to tackle?
Storybook is organized as a monorepo. 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 jsyarn lint:md - will check markdown + code samplesyarn lint:js --fix - will automatically fix jsboolean check if unit tests all pass - uses jest
yarn run test --core --watch - will run core tests in watch-modeBecome a sponsor to have your logo and website URL on our README on Github. [Become a sponsor]
By making a recurring donation, you can support us and our work. [Become a backer]
-the end-