storybookjs/storybook


UI component dev & test: React, Vue, Angular, React Native, Ember, Web Components & more!

https://storybook.js.org

License: MIT

Language: TypeScript

Keywords: angular, components, design-systems, documentation, ember, javascript, library, marko, polymer, react, react-native, storybook, styleguide, svelte, testing, ui, ui-components, vue, web-components, webpack


Storybook

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.

Intro

README for:
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: 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.

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.1.0 React
React Native - React Native
Vue v5.1.0 Vue
Angular v5.1.0 Angular
Polymer v5.1.0 Polymer
Mithril v5.1.0 Mithril
Marko v5.1.0 Marko
HTML v5.1.0 HTML
Svelte v5.1.0 Svelte
Riot v5.1.0 Riot
Ember v5.1.0 Ember
Preact v5.1.0 Preact

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
contexts Interactively inject component contexts for stories in the Storybook UI
cssresources Dynamically add/remove css resources to the component iframe
design assets View images, videos, weblinks alongside your story
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

[![Storybook](https://cdn.jsdelivr.net/gh/storybookjs/brand@master/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 press 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'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

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-

Project Statistics

Sourcerank 24
Repository Size 183 MB
Stars 41,334
Forks 3,477
Watchers 656
Open issues 430
Dependencies 4,902
Contributors 646
Tags 642
Created
Last updated
Last pushed

Top Contributors See all

Norbert de Langen Filipp Riabchun Michael Shilman dependencies.io bot Arunoda Susiripala Igor Thanish Tom Coleman dependabot-bot Daniel Duan Aruna Herath Kai Rรถder Dominic Nguyen Carlos Vega Alex Wilson Chak Shun Yu Gytis Vinclovas Benoit Dion Gaรซtan Maisse Gavin King

Packages Referencing this Repo

@storybook/addon-viewport
Storybook addon to change the viewport size to mobile
Latest release 5.2.0-alpha.29 - Updated - 41.3K stars
@digitalmaster/addon-storyshots
StoryShots is a Jest Snapshot Testing Addon for Storybook.
Latest release 3.3.0-alpha.3 - Updated - 41.3K stars
@storybook/polymer
Storybook for Polymer: Develop Polymer components in isolation with Hot Reloading.
Latest release 5.2.0-beta.21 - Updated - 41.3K stars
@morgs32/addon-knobs
Storybook Addon Prop Editor Component
Latest release 1.0.20 - Updated - 41.3K stars
@widget-dev/react
Storybook for React: Develop React Component in isolation with Hot Reloading.
Latest release 0.1.5 - Updated - 41.3K stars
@enjoylife/react
Storybook for React: Develop React Component in isolation with Hot Reloading.
Latest release 3.1.0-rc.1 - Updated - 41.3K stars
@ntucker/storybook
React Storybook: Isolate React Component Development with Hot Reloading.
Latest release 2.35.8 - Published - 41.3K stars
@enjoylife/reactstorybook
Storybook for React: Develop React Component in isolation with Hot Reloading.
Latest release 3.1.2 - Updated - 41.3K stars
@storybook/addon-backgrounds
A storybook addon to show different backgrounds for your preview
Latest release 5.3.0-alpha.0 - Updated - 41.3K stars
jrmurad-addon-storyshots
StoryShots is a Jest Snapshot Testing Addon for Storybook.
Latest release 3.2.3 - Published - 41.3K stars
@storybook/vue
Storybook for Vue: Develop Vue Component in isolation with Hot Reloading.
Latest release 5.2.0-beta.18 - Updated - 41.3K stars
@storybook/addon-comments
Comments addon for Storybook
Latest release 3.3.0-alpha.2 - Updated - 41.3K stars
@storybook/components
Core Storybook Components
Latest release 5.3.0-alpha.0 - Updated - 41.3K stars
@ouihelp/storybook-react
Storybook for React: Develop React Component in isolation with Hot Reloading.
Latest release 5001011.0.0 - Published - 41.3K stars
@majik/storybook-react-faster
Storybook for React: Develop React Component in isolation with Hot Reloading.
Latest release 5.1.3 - Published - 41.3K stars
@oleg97/storybook-react-native
A better way to develop React Native Components for your app
Latest release 5.1.0-alpha.22 - Updated - 41.3K stars
@storybook/addon-decorator
decorator addon for storybook
Latest release 5.2.0-beta.17 - Updated - 41.3K stars
@beisen/storybook-addon-knobs
Storybook Addon Prop Editor Component
Latest release 4.0.3 - Updated - 41.3K stars
@storybook/addon-contexts
Storybook Addon Contexts
Latest release 5.3.0-alpha.0 - Updated - 41.3K stars
@znemz/addon-knobs
Storybook Addon Prop Editor Component
Latest release 5.2.0-alpha.31 - Published - 41.3K stars

Recent Tags See all

v5.2.1 September 17, 2019
v5.3.0-alpha.0 September 17, 2019
v5.2.0 September 14, 2019
v5.2.0-rc.11 September 10, 2019
v5.2.0-rc.10 September 09, 2019
v5.2.0-rc.9 September 08, 2019
v5.2.0-rc.8 September 07, 2019
v5.2.0-rc.7 September 07, 2019
v5.2.0-rc.6 September 05, 2019
v5.2.0-rc.6 September 05, 2019
v5.2.0-rc.5 September 04, 2019
v5.2.0-rc.4 September 03, 2019
v5.2.0-rc.3 September 03, 2019
v5.2.0-rc.2 September 01, 2019
v5.2.0-rc.1 August 31, 2019

Interesting Forks See all

yutiansut/storybook
Interactive UI component dev & test: React, React Native, Vue, Angular
JavaScript - MIT - Last pushed - 1 stars

Something wrong with this page? Make a suggestion

Last synced: 2019-07-02 09:20:38 UTC

Login to resync this repository