Storybook

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.

Intro

README for:

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: https://storybook.js.org/examples/

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.

🚀Getting Started
📒Projects
- 🛠Supported Frameworks & Examples
- 🚇Sub Projects
- 🔗Addons
🏅Badges & Presentation materials
👥Community
👏Contributing
- 👨‍💻Development scripts
- 💵Backers
- 💸Sponsors

Getting Started

First install storybook:

cd my-react-app
npx -p @storybook/cli@alpha 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@alpha 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: storybook.js.org

For additional help, join us in our Slack

Projects

Supported Frameworks

Framework	Demo latest	Demo prerelease
React	v3.4.x, v3.3.x	v4.0.0-alpha
React Native	-	-
Vue	v3.4.x, v3.3.x	v4.0.0-alpha
Angular	v3.4.x, v3.3.x	v4.0.0-alpha
Polymer	v3.4.x	v4.0.0-alpha
Mithril ^alpha	-	v4.0.0-alpha
Marko ^alpha	-	v4.0.0-alpha
HTML ^alpha	-	v4.0.0-alpha
Svelte ^alpha	-	v4.0.0-alpha
Riot ^alpha	-	v4.0.0-alpha
Ember	-	v4.0.0-alpha

Sub Projects

CLI - Streamlined installation for a variety of app types
examples - Code examples to illustrate different Storybook use cases

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
centered	Center the alignment of your components within the Storybook UI
events	Interactively fire events to components that respond to EventEmitter
graphql	Query a GraphQL server within Storybook 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](https://github.com/storybooks/press/blob/master/badges/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 press repo.