Interactive UI component dev & test: React, React Native, Vue, Angular, Ember
Switch branches/tags
Clone or download
wuweiweiwu Merge pull request #4452 from human-readable/master
bug-fix-jest-addon-undefined-file-extension
Latest commit b174859 Oct 20, 2018
Permalink
Failed to load latest commit information.
.circleci Some teamcity maintenance Oct 13, 2018
.github Move crna-kitchen-sink to examples-native folder Oct 13, 2018
.teamcity TeamCity change in 'Open-source projects / Storybook' project: parame… Oct 15, 2018
__mocks__ Use prettier parsers to parse ast for js and ts. Mar 21, 2018
addons Merge pull request #4452 from human-readable/master Oct 20, 2018
app Merge pull request #4343 from tomepejo/master Oct 19, 2018
docs Merge pull request #4483 from mccullochk/faq-link Oct 18, 2018
examples-native/crna-kitchen-sink Move crna-kitchen-sink to examples-native folder Oct 13, 2018
examples Bump copy-webpack-plugin from 4.5.3 to 4.5.4 Oct 19, 2018
lib Merge pull request #4477 from storybooks/dependabot/npm_and_yarn/webp… Oct 18, 2018
media Replace demo.gif in apps Aug 16, 2018
packs Remove the `test-cra` example app. Aug 22, 2017
scripts Some teamcity maintenance Oct 13, 2018
.babelrc Add codemod Oct 17, 2018
.bettercodehub.yml Add storyshot as a test file Aug 1, 2018
.editorconfig Missing svelte editor config Jul 25, 2018
.eslintignore Initial move to babel 7 Jun 9, 2018
.eslintrc.js Move crna-kitchen-sink to examples-native folder Oct 13, 2018
.gitignore Use relative URLs for acceptance stories Apr 15, 2018
.mailmap Update .mailmap Mar 8, 2018
.npmignore Consolidate all the copied demo.gif to one place Aug 1, 2018
.remarkignore Add CHANGELOG.md to remarkignore Sep 18, 2018
.remarkrc.js Major version upgrades for devDependencies Jan 27, 2018
.spelling Svelte missing from markdown spell check Jul 25, 2018
ADDONS_SUPPORT.md Add notes about google analytics in ADDONS_SUPPORT.md and README.md Oct 16, 2018
CHANGELOG.md 4.0.0-rc.1 changelog Oct 18, 2018
CODE_OF_CONDUCT.md Add Code of Conduct as recommended by GitHub Nov 9, 2017
CONTRIBUTING.md Removed few instances of --reactnative prop. Oct 8, 2018
HISTORY.md Fixed links to storybook.js.org. Jun 7, 2017
LICENSE Single source of truth for LICENCE for all packages May 16, 2017
MAINTAINERS.md [docs] add maintainers guide to help define process Oct 4, 2018
MIGRATION.md Move storybook to rc (release canddiate) Oct 18, 2018
README.md Move storybook to rc (release canddiate) Oct 18, 2018
RELEASES.md Major version upgrades for devDependencies Jan 27, 2018
ROADMAP.md minor cleanup Oct 3, 2018
dangerfile.js Close down new features until we're done with the 4.0 release Oct 15, 2018
jest.config.js Fix duplicate manual mocks in jest Oct 13, 2018
lerna.json v4.0.0-rc.1 Oct 18, 2018
netlify.toml FIX the failing netlify builds Dec 21, 2017
package.json Bump jest-image-snapshot from 2.5.0 to 2.6.0 Oct 19, 2018
riot-jest-transformer.json cheating on the riot jest transformer to use babel 7 Aug 28, 2018
tsconfig.json Set compiling target to es5 (the default is es3) Jan 29, 2018
tslint.json REMOVE unneeded tslint config Aug 14, 2018
yarn.lock Merge pull request #4492 from storybooks/dependabot/npm_and_yarn/copy… Oct 19, 2018

README.md

Storybook

Build Status on TeamCity Build Status on CircleCI CodeFactor Known Vulnerabilities BCH compliance codecov Storybook Slack Backers on Open Collective Sponsors on Open Collective License


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:

  • Alpha
  • Latest

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@rc 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@rc 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
React Native - - React Native
Vue v3.4.x, v3.3.x v4.0.0-alpha Vue
Angular v3.4.x, v3.3.x v4.0.0-alpha Angular
Polymer v3.4.x v4.0.0-alpha Polymer
Mithril alpha - v4.0.0-alpha Mithril
Marko alpha - v4.0.0-alpha Marko
HTML alpha - v4.0.0-alpha HTML
Svelte alpha - v4.0.0-alpha Svelte
Riot alpha - v4.0.0-alpha Riot
Ember alpha - v4.0.0-alpha Ember

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

Community

Contributing

Good First Issue

We welcome contributions to Storybook!

  • ⇄ Pull requests and ★ Stars are always welcome.
  • Read our contributing guide to get started.

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

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