Interactive UI component dev & test: React, React Native, Vue, Angular, Ember
Clone or download
ndelangen Merge pull request #5302 from storybooks/fix/deprecate-a11y-confgurat…

RE-ADD a 'configureA11Y' which is deprecated for backwards compatibility
Latest commit 4deaf14 Jan 19, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Merge changes from next into 5.0 Jan 9, 2019
.github Merge pull request #5075 from storybooks/tech/try-github-workflos Jan 14, 2019
.teamcity Merge changes from next into 5.0 Jan 9, 2019
__mocks__ Add unit test for flow parser in StorySource Dec 14, 2018
addons Merge pull request #5302 from storybooks/fix/deprecate-a11y-confgurat… Jan 19, 2019
app v5.0.0-alpha.6 Jan 18, 2019
ci/action-a CHANGE chmod to executable of Jan 15, 2019
docs CLEANUP Jan 18, 2019
examples-native/crna-kitchen-sink FIX crna example Jan 15, 2019
examples ADD special entry-points for vue and react for addon-centered. Jan 18, 2019
lib Merge pull request #5295 from storybooks/fix/file-system-host Jan 19, 2019
media Replace demo.gif in apps Aug 16, 2018
packs Remove the `test-cra` example app. Aug 22, 2017
scripts Merge changes from next into 5.0 Jan 9, 2019
.babelrc.js Merge branch 'next' into tech/overhaul-ui Dec 13, 2018
.bettercodehub.yml Add storyshot as a test file Aug 1, 2018
.editorconfig Missing svelte editor config Jul 25, 2018
.eslintignore Unfinished things Dec 17, 2018
.eslintrc.js RENAME selectedAddonPanel to selectedPanel Dec 29, 2018
.gitignore CHANGE output of dll to lib/core so it's easier to reference Nov 26, 2018
.mailmap Update .mailmap Mar 8, 2018
.npmignore Consolidate all the copied demo.gif to one place Aug 1, 2018
.prettierrc Fix problems from reverted cleanup Oct 31, 2018
.remarkignore Add to remarkignore Sep 18, 2018
.remarkrc.js Major version upgrades for devDependencies Jan 27, 2018
.spelling REFACTOR client/preview/start Sep 4, 2018 chore: Changed ADDONS_SUPPORT to be in chronological order; reading i… Dec 10, 2018 5.0.0-alpha.6 changelog Jan 18, 2019 Add Code of Conduct as recommended by GitHub Nov 9, 2017 Rename publish command to avoid confusion Jan 16, 2019 Fixed links to Jun 7, 2017
LICENSE Merge branch 'next' into tech/overhaul-ui Nov 28, 2018 Fix typos and grammatical errors in markdown documents Dec 5, 2018 Merge branch 'next' into release/5.0 Jan 13, 2019 Merge pull request #5075 from storybooks/tech/try-github-workflos Jan 14, 2019 Fix typos and grammatical errors in markdown documents Dec 5, 2018 Fix typos and grammatical errors in markdown documents Dec 5, 2018
dangerfile.js Update dangerfile to block conflicting labels Nov 21, 2018
jest.config.js Merge changes from next into 5.0 Jan 9, 2019
lerna.json v5.0.0-alpha.6 Jan 18, 2019
netlify.toml FIX the failing netlify builds Dec 21, 2017
package.json Merge branch 'next' into tech/router Jan 17, 2019
prettier.config.js CLEANUP && ADD eslint-html-plugin && FIX lint issues && CHANGE pretti… Sep 11, 2018
riot-jest-transformer.json cheating on the riot jest transformer to use babel 7 Aug 28, 2018
tsconfig.json Merge branch '5.0.0' into tech/overhaul-ui Dec 27, 2018
tslint.json FIX gap in layout && FIX lib/addons Dec 27, 2018
yarn.lock Merge branch 'next' into feature/set-title Jan 18, 2019


Build Status on TeamCity Build Status on CircleCI CodeFactor Known Vulnerabilities BCH compliance codecov License

Storybook Slack Backers on Open Collective Sponsors on Open Collective

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.


latest next

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.

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 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.

Table of contents

Getting Started

First install storybook:

cd my-react-app
npx -p @storybook/cli sb init

If you'd rather set up your project manually, take a look at our Slow Start Guide.

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.

Storybook v2.x migration note: If you're using Storybook v2.x and want to shift to 4.x version the easiest way is:

cd my-storybook-v2-app
npx -p @storybook/cli sb init

It runs a codemod to update all package names. Read all migration details in our Migration Guide

For full documentation on using Storybook visit:

For additional help, join us in our Discord or Slack


Supported Frameworks

Framework Demo
React v4.0.0 React
React Native - React Native
Vue v4.0.0 Vue
Angular v4.0.0 Angular
Polymer v4.0.0 Polymer
Mithril v4.0.0 Mithril
Marko v4.0.0 Marko
HTML v4.0.0 HTML
Svelte v4.0.0 Svelte
Riot v4.0.0 Riot
Ember v4.0.0 Ember
Preact v4.0.0 Preact

Sub Projects

  • 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
centered Center the alignment of your components within the Storybook UI
cssresources Dynamically add/remove css resources to the component iframe
events Interactively fire events to components that respond to EventEmitter
graphql Query a GraphQL server within Storybook stories
google-analytics Reports google analytics on stories
info Annotate stories with extra component usage information
jest View the results of components' unit tests in Storybook
knobs Interactively edit component prop data in the Storybook UI
links Create links between stories
notes Annotate Storybook stories with notes
options Customize the Storybook UI in code
storyshots Easy 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

See Addon / Framework Support Table

Badges & Presentation materials

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


[![Storybook](](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 press repo.



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're 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

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

  • 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-