JavaScript HTML Kotlin TypeScript Vue Objective-C Other
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.circleci Creating svelte test and integration locations to match vue Jun 17, 2018
.github Svelte missing from autolabeler Jul 25, 2018
.teamcity Merge branch 'master' into svelte-support Aug 6, 2018
__mocks__ Use prettier parsers to parse ast for js and ts. Mar 21, 2018
addons Don't pass connection error if images don't match Aug 17, 2018
app Replace demo.gif in apps Aug 16, 2018
docs Removed obsolete travis references Aug 18, 2018
examples Merge pull request #3967 from storybooks/tmeasday/error-events Aug 15, 2018
lib Merge pull request #4030 from storybooks/remove-deprecated-db-params Aug 17, 2018
media Replace demo.gif in apps Aug 16, 2018
packs Remove the `test-cra` example app. Aug 22, 2017
scripts Removed obsolete travis references Aug 18, 2018
.babelrc Replace require_context.js with babel-plugin-require-context-hook Jun 12, 2018
.bettercodehub.yml Add storyshot as a test file Aug 1, 2018
.bithoundrc ignore more of these shelljs packages Nov 16, 2017
.editorconfig Missing svelte editor config Jul 25, 2018
.eslintignore Migrate all apps to Webpack 4 Mar 4, 2018
.eslintrc.js FIX linting issues after eslint upgrade (partial fix) Aug 5, 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
.remarkrc.js Major version upgrades for devDependencies Jan 27, 2018
.spelling Svelte missing from markdown spell check Jul 25, 2018
ADDONS_SUPPORT.md Storyshot support marked as supported Jun 24, 2018
CHANGELOG.md 4.0.0-alpha.16 changelog Aug 6, 2018
CODE_OF_CONDUCT.md Add Code of Conduct as recommended by GitHub Nov 9, 2017
CONTRIBUTING.md Merge remote-tracking branch 'origin/master' into svelte-support Aug 1, 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
MIGRATION.md Document generic addons and knobs select migration Aug 3, 2018
README.md Replace demo.gif in apps Aug 16, 2018
RELEASES.md Major version upgrades for devDependencies Jan 27, 2018
ROADMAP.md Merge branch 'master' into Hypnosphi-patch-1 Feb 18, 2018
dangerfile.js Set branch version to MAJOR Mar 19, 2018
dependencies.yml Fix eslint warnings Jun 5, 2018
jest.config.js Merge remote-tracking branch 'origin/master' into svelte-support Jul 30, 2018
lerna.json v4.0.0-alpha.16 Aug 6, 2018
netlify.toml FIX the failing netlify builds Dec 21, 2017
package.json Bring "tslint-plugin-prettier" back Aug 6, 2018
tsconfig.json Set compiling target to es5 (the default is es3) Jan 29, 2018
tslint.json Remove redundant tslint rule Feb 17, 2018
yarn.lock Merge pull request #3770 from plumpNation/svelte-support Aug 9, 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


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

Storybook Screenshot

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:

npm i -g @storybook/cli
cd my-react-app
getstorybook

The -g global install is used to run our cli tool in your project directory to generate templates for your existing projects. To avoid the global install and start 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 3.x version the easiest way is:

npm i -g @storybook/cli
cd my-storybook-v2-app
getstorybook

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

Sub Projects

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

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

Live Examples

4.0.alpha

Note, this is an Alpha version which may not be well tested. Features in this version are not final.

3.4

3.3

Contributing

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