2017-09-29 23:10:18 +03:00
# Storybook
2017-05-26 11:21:46 +02:00
2018-04-14 01:10:52 +02:00
[](https://teamcity.jetbrains.com/viewType.html?buildTypeId=OpenSourceProjects_Storybook_Build_2& branch_OpenSourceProjects_Storybook=%3Cdefault%3E& tab=buildTypeStatusDiv)
2017-09-29 23:10:18 +03:00
[](https://circleci.com/gh/storybooks/storybook)
[](https://www.codefactor.io/repository/github/storybooks/storybook)
2018-03-16 22:01:06 +02:00
[](https://snyk.io/test/github/storybooks/storybook)
2018-08-21 01:03:26 +03:00
[](https://bettercodehub.com/results/storybooks/storybook)
[](https://codecov.io/gh/storybooks/storybook)
2017-12-22 17:56:24 +01:00
[](https://now-examples-slackin-rrirkqohko.now.sh/)
2018-08-27 19:42:20 +02:00
[](#backers )
2018-08-21 01:03:26 +03:00
[](#sponsors )
[](https://github.com/storybooks/storybook/blob/master/LICENSE)
2018-10-11 03:50:26 +08:00
2018-07-31 19:34:05 +03:00
<!-- [](https://www.browserstack.com/automate/public-build/<badge_key>) -->
2017-05-18 23:59:15 +02:00
2018-10-11 03:50:26 +08:00
---
2017-03-30 00:08:54 +02:00
2017-09-29 23:10:18 +03:00
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.
2017-04-14 21:17:50 +02:00
2017-09-29 23:10:18 +03:00
## Intro
2018-10-11 03:50:26 +08:00
2018-09-25 08:58:32 +02:00
< center >
< img src = "media/storybook-intro.gif" width = "100%" / >
< / center >
2017-04-15 22:38:33 +02:00
2018-08-21 01:13:02 +03:00
README for:
2018-10-11 03:50:26 +08:00
- [](https://github.com/storybooks/storybook)
- [](https://github.com/storybooks/storybook/tree/release/3.4)
2018-08-21 01:13:02 +03:00
2017-09-29 23:10:18 +03:00
Storybook runs outside of your app. This allows you to develop UI components in isolation, which can improve component reuse, testability, and development speed. You can build quickly without having to worry about application-specific dependencies.
2017-04-16 10:16:19 -07:00
2017-09-29 23:10:18 +03:00
Here are some featured examples that you can reference to see how Storybook works: < https: / / storybook . js . org / examples / >
2017-06-29 00:17:37 +03:00
2017-09-29 23:10:18 +03:00
Storybook comes with a lot of [addons ](https://storybook.js.org/addons/introduction/ ) for component design, documentation, testing, interactivity, and so on. Storybook's easy-to-use API makes it easy to configure and extend in various ways. It has even been extended to support React Native development for mobile.
2017-04-16 10:16:19 -07:00
2017-09-29 23:10:18 +03:00
## Table of contents
2017-05-26 11:21:46 +02:00
2018-10-11 03:50:26 +08:00
- 🚀[Getting Started ](#getting-started )
- 📒[Projects ](#projects )
- 🛠[Supported Frameworks & Examples ](#supported-frameworks )
- 🚇[Sub Projects ](#sub-projects )
- 🔗[Addons ](#addons )
- 🏅[Badges & Presentation materials ](#badges--presentation-materials )
- 👥[Community ](#community )
- 👏[Contributing ](#contributing )
- 👨💻[Development scripts ](#development-scripts )
- 💵[Backers ](#backers )
- 💸[Sponsors ](#sponsors )
2017-09-29 23:00:47 +03:00
2017-09-29 23:10:18 +03:00
## Getting Started
2017-09-29 23:00:47 +03:00
2017-09-29 23:10:18 +03:00
First install storybook:
2017-09-29 23:00:47 +03:00
```sh
2017-09-29 23:10:18 +03:00
cd my-react-app
2018-10-26 00:25:17 +08:00
npx -p @storybook/cli@rc sb init
2017-06-29 00:17:37 +03:00
```
2017-07-01 10:39:29 +02:00
2018-10-11 03:50:26 +08:00
If you'd rather set up your project manually, take a look at our [Slow Start Guide ](https://storybook.js.org/basics/slow-start-guide/ ).
2017-10-31 12:04:29 -04:00
2017-09-29 23:10:18 +03:00
Once it's installed, you can `npm run storybook` and it will run the development server on your local machine, and give you a URL to browse some sample stories.
2017-09-29 23:00:47 +03:00
2018-10-11 03:50:26 +08:00
**Storybook v2.x migration note**: If you're using Storybook v2.x and want to shift to 4.x version the easiest way is:
2017-09-29 23:00:47 +03:00
```sh
2017-09-29 23:10:18 +03:00
cd my-storybook-v2-app
2018-10-26 00:25:17 +08:00
npx -p @storybook/cli@rc sb init
2017-09-29 23:00:47 +03:00
```
2017-09-29 23:10:18 +03:00
It runs a codemod to update all package names. Read all migration details in our [Migration Guide ](MIGRATION.md )
2017-09-29 23:00:47 +03:00
2017-09-29 23:10:18 +03:00
For full documentation on using Storybook visit: [storybook.js.org ](https://storybook.js.org )
2017-09-29 23:00:47 +03:00
2018-01-09 11:04:32 -05:00
For additional help, join us [in our Slack ](https://now-examples-slackin-rrirkqohko.now.sh/ )
2017-09-29 23:10:18 +03:00
## Projects
2017-09-29 23:00:47 +03:00
2018-02-18 16:04:38 +03:00
### Supported Frameworks
2017-09-29 23:00:47 +03:00
2018-10-11 03:50:26 +08:00
| Framework | Demo latest | Demo prerelease | |
| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| [React ](app/react ) | [v3.4.x ](https://release-3-4--storybooks-official.netlify.com ), [v3.3.x ](https://release-3-3--storybooks-official.netlify.com ) | [v4.0.0-alpha ](https://storybooks-official.netlify.com ) | [](app/react) |
| [React Native ](app/react-native ) | - | - | [](app/react-native) |
| [Vue ](app/vue ) | [v3.4.x ](https://release-3-4--storybooks-vue.netlify.com/ ), [v3.3.x ](https://release-3-3--storybooks-vue.netlify.com/ ) | [v4.0.0-alpha ](https://storybooks-vue.netlify.com/ ) | [](app/vue) |
| [Angular ](app/angular ) | [v3.4.x ](https://release-3-4--storybooks-angular.netlify.com/ ), [v3.3.x ](https://release-3-3--storybooks-angular.netlify.com/ ) | [v4.0.0-alpha ](https://storybooks-angular.netlify.com/ ) | [](app/angular) |
| [Polymer ](app/polymer ) | [v3.4.x ](https://release-3-4--storybooks-polymer.netlify.com/ ) | [v4.0.0-alpha ](https://storybooks-polymer.netlify.com/ ) | [](app/polymer) |
| [Mithril ](app/mithril ) < sup > alpha</ sup > | - | [v4.0.0-alpha ](https://storybooks-mithril.netlify.com/ ) | [](app/mithril) |
| [Marko ](app/marko ) < sup > alpha</ sup > | - | [v4.0.0-alpha ](https://storybooks-marko.netlify.com/ ) | [](app/marko) |
| [HTML ](app/html ) < sup > alpha</ sup > | - | [v4.0.0-alpha ](https://storybooks-html.netlify.com/ ) | [](app/html) |
| [Svelte ](app/svelte ) < sup > alpha</ sup > | - | [v4.0.0-alpha ](https://storybooks-svelte.netlify.com/ ) | [](app/svelte) |
| [Riot ](app/riot ) < sup > alpha</ sup > | - | [v4.0.0-alpha ](https://storybooks-riot.netlify.com/ ) | [](app/riot) |
2018-10-17 12:30:51 +03:00
| [Ember ](app/ember ) < sup > alpha</ sup > | - | [v4.0.0-alpha ](https://storybooks-ember.netlify.com/ ) | [](app/ember) |
2018-09-25 08:58:32 +02:00
2017-09-29 23:10:18 +03:00
### Sub Projects
2017-09-29 23:00:47 +03:00
2018-10-11 03:50:26 +08:00
- [CLI ](lib/cli ) - Streamlined installation for a variety of app types
- [examples ](examples ) - Code examples to illustrate different Storybook use cases
2017-09-29 23:00:47 +03:00
2017-09-29 23:10:18 +03:00
### Addons
2017-09-29 23:00:47 +03:00
2018-10-16 12:26:01 +03:00
| Addons | |
2018-10-16 12:26:48 +03:00
| ------------------------------------------- | -------------------------------------------------------------------------- |
2018-10-16 12:26:01 +03:00
| [a11y ](addons/a11y/ ) | Test components for user accessibility in Storybook |
| [actions ](addons/actions/ ) | Log actions as users interact with components in the Storybook UI |
| [backgrounds ](addons/backgrounds/ ) | Let users choose backgrounds in the Storybook UI |
| [centered ](addons/centered/ ) | Center the alignment of your components within the Storybook UI |
| [events ](addons/events/ ) | Interactively fire events to components that respond to EventEmitter |
| [graphql ](addons/graphql/ ) | Query a GraphQL server within Storybook stories |
| [google-analytics ](addons/google-analytics ) | Reports google analytics on stories |
| [info ](addons/info/ ) | Annotate stories with extra component usage information |
| [jest ](addons/jest/ ) | View the results of components' unit tests in Storybook |
| [knobs ](addons/knobs/ ) | Interactively edit component prop data in the Storybook UI |
| [links ](addons/links/ ) | Create links between stories |
| [notes ](addons/notes/ ) | Annotate Storybook stories with notes |
| [options ](addons/options/ ) | Customize the Storybook UI in code |
| [storyshots ](addons/storyshots/ ) | Easy snapshot testing for components in Storybook |
| [storysource ](addons/storysource/ ) | View the code of your stories within the Storybook UI |
| [viewport ](addons/viewport/ ) | Change display sizes and layouts for responsive components using Storybook |
2017-09-29 23:10:18 +03:00
2018-02-18 16:04:38 +03:00
See [Addon / Framework Support Table ](ADDONS_SUPPORT.md )
2018-09-27 21:37:29 +02:00
## Badges & Presentation materials
2018-08-23 21:50:58 +03:00
We have a badge ! Link it to your live Storybook example.
```md
[](link to site)
```
2018-09-27 21:37:29 +02:00
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 [press repo ](https://github.com/storybooks/press ).
2018-09-18 09:29:28 -05:00
## Community
2018-10-11 03:50:26 +08:00
- Tweeting via [@storybookjs ](https://twitter.com/storybookjs )
- Blogging at [Medium ](https://medium.com/storybookjs )
- Chatting on [Slack ](https://now-examples-slackin-rrirkqohko.now.sh/ )
- Discussions on [Discord ](https://discord.gg/sMFvFsG )
- Streaming saved at [Youtube ](https://www.youtube.com/channel/UCr7Quur3eIyA_oe8FNYexfg )
2018-09-18 09:29:28 -05:00
2017-09-29 23:10:18 +03:00
## Contributing
2018-08-21 01:03:26 +03:00
[](https://github.com/storybooks/storybook/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
2017-09-29 23:10:18 +03:00
We welcome contributions to Storybook!
2018-10-11 03:50:26 +08:00
- ⇄ Pull requests and ★ Stars are always welcome.
- Read our [contributing guide ](CONTRIBUTING.md ) to get started.
2017-09-29 23:10:18 +03:00
### Development scripts
#### `yarn bootstrap`
> Installs package dependencies and links packages together - using lerna
#### `yarn run publish`
> Push a release to git and npm
> will ask for version in interactive mode - using lerna.
#### `yarn lint`
> boolean check if code conforms to linting rules - uses remark & eslint
2018-10-11 03:50:26 +08:00
- `yarn lint:js` - will check js
- `yarn lint:md` - will check markdown + code samples
2017-09-29 23:10:18 +03:00
2018-10-11 03:50:26 +08:00
- `yarn lint:js --fix` - will automatically fix js
2017-09-29 23:10:18 +03:00
#### `yarn test`
> boolean check if unit tests all pass - uses jest
2018-10-11 03:50:26 +08:00
- `yarn run test --core --watch` - will run core tests in watch-mode
2017-09-29 23:10:18 +03:00
### Sponsors
Become a sponsor and get your logo on our README on Github with a link to your site. \[[Become a sponsor ](https://opencollective.com/storybook#sponsor )]
< a href = "https://opencollective.com/storybook/sponsor/0/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/0/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/1/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/1/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/2/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/2/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/3/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/3/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/4/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/4/avatar.svg" > < / a >
2018-05-19 02:08:29 +02:00
< a href = "https://applitools.com/" target = "_blank" > < img src = "https://file-xvimrfykua.now.sh/" > < / a >
2017-09-29 23:10:18 +03:00
< a href = "https://opencollective.com/storybook/sponsor/5/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/5/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/6/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/6/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/7/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/7/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/8/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/8/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/9/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/9/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/10/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/10/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/11/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/11/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/12/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/12/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/13/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/13/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/14/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/14/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/15/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/15/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/16/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/16/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/17/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/17/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/18/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/18/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/19/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/19/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/20/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/20/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/21/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/21/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/22/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/22/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/23/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/23/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/24/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/24/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/25/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/25/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/26/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/26/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/27/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/27/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/28/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/28/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/sponsor/29/website" target = "_blank" > < img src = "https://opencollective.com/storybook/sponsor/29/avatar.svg" > < / a >
2018-05-05 22:08:04 -04:00
2018-05-19 02:11:42 +02:00
### Backers
Support us with a monthly donation and help us continue our activities. \[[Become a backer ](https://opencollective.com/storybook#backer )]
< a href = "https://opencollective.com/storybook/backer/0/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/0/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/1/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/1/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/2/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/2/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/3/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/3/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/4/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/4/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/5/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/5/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/6/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/6/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/7/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/7/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/8/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/8/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/9/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/9/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/10/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/10/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/11/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/11/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/12/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/12/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/13/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/13/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/14/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/14/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/15/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/15/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/16/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/16/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/17/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/17/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/18/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/18/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/19/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/19/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/20/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/20/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/21/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/21/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/22/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/22/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/23/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/23/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/24/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/24/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/25/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/25/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/26/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/26/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/27/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/27/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/28/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/28/avatar.svg" > < / a >
< a href = "https://opencollective.com/storybook/backer/29/website" target = "_blank" > < img src = "https://opencollective.com/storybook/backer/29/avatar.svg" > < / a >
2018-05-05 22:08:04 -04:00
## License
[MIT ](https://github.com/storybooks/storybook/blob/master/LICENSE )
