Github url

storybook

by storybookjs

storybookjs /storybook

πŸ““ The UI component explorer. Develop, document, & test for React, Vue, Angular, Ember, Web Componen...

51.4K Stars 5.0K Forks Last release: 3 months ago (v5.3.19) MIT License 29.1K Commits 837 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Storybook

Build bulletproof UI components faster

Build Status on CircleCICodeFactorKnown VulnerabilitiescodecovLicense
Storybook SlackBackers on Open CollectiveSponsors on Open CollectiveOfficial Twitter Handle

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.

View README for:
latestnext

Intro

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 API makes it possible 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: storybook.js.org

For additional help, join us in our Discord or Slack

Projects

Supported Frameworks

| Framework | Demo | | | -------------------------------- | --------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | | React | v5.3.0 | React | | React Native | - | React Native | | Vue | v5.3.0 | Vue | | Angular | v5.3.0 | Angular | | Marionette.js | - | Marionette.js | | Mithril | v5.3.0 | Mithril | | Marko | v5.3.0 | Marko | | HTML | v5.3.0 | HTML | | Svelte | v5.3.0 | Svelte | | Riot | v5.3.0 | Riot | | Ember | v5.3.0 | Ember | | Preact | v5.3.0 | Preact | | Rax | v5.3.0 | Rax |

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 | | 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 | | knobs | Interactively edit component prop data in the Storybook UI | | links | Create links between stories | | 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 |

See Addon / Framework Support Table

Deprecated Addons

| Addons | | | ---------------------------------------------------------------------------------- | -------------------------------------------------------- | | info | Annotate stories with extra component usage information | | notes | Annotate Storybook stories with notes | | contexts | Addon for driving your components under dynamic contexts | | 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.

If you're using info/notes, we highly recommend you to migrate to docs instead, and here is a guide to help you.

If you're using contexts, we highly recommend you to migrate to toolbars and here is a guide to help you.

Badges & Presentation materials

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

Storybook

[![Storybook](https://cdn.jsdelivr.net/gh/storybookjs/[email protected]/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.

Community

Contributing

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

Storybook is organized as a monorepo using Lerna. Useful scripts include:

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

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]

Backers

Support us with a monthly donation and help us continue our activities. [Become a backer]

License

MIT

-the end-

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.