Interactive UI component dev & test: React, React Native, Vue, Angular, Ember
Switch branches/tags
3407-repro 3972-options-knob-on-next 4848-new-example-format add-navbar add-polymer3-support add-react-error-overlay add-typings addon-api-concept addon-knob-vue-decoratorless addon-readme addon-resources core/remove-basic-config dd/babel-plugin-react-docgen-2 dependabot/npm_and_yarn/docs/gatsby-plugin-sharp-2.0.14 dependabot/npm_and_yarn/react-native-modal-datetime-picker-6.0.0 docs-v2-babel docs-v2-highlights docs-v2-monaco docs-v2 docs-v2.1 docs/add-versions-json docusaurus feature/add-navbar-refactor feature/add-navbar feature/custom-react-scripts fix/husky-deprecation fix/react-scripts-latest-fixture issue-3972-options-knob knobs-objects knobs/v2 master ndelange/hoisting-rn ndelangen/RN-fixattempt1 ndelangen/RN-fixattempt2 ndelangen/RN-fixattempt3 ndelangen/RN-fixattempt4 ndelangen/RN-fixattempt5 ndelangen/config-refactor ndelangen/docs-in-official ndelangen/hoisting-rn-attempt1 ndelangen/new-layoutsystem ndelangen/nicer-official-demo ndelangen/reactnext ndelangen/replace-html-webpack-plugin-v2 ndelangen/replace-html-webpack-plugin ndelangen/revert-tgz-file-dependencies ndelangen/temp2 new-docs next ng-dynamic-template oblador/fix-metro-flags-rn-57 on-device-addons on-device-ui-all-prs patch-1 poc/addon-editor poc/liveedit-addon poc/liveedit-in-storysource-old poc/liveedit-in-storysource pr/JalilArfaoui/3909 pr/hipstersmoothie/4704 pr/kkemple/4482 pr/maacky/4856 presets/default-webpack react-native-on-device react-native/use-core-for-server redux-ui refactoring/remove-mantra-ui-overhaul-routing refactoring/remove-mantra-ui-overhaul refactoring/remove-mantra release/3.3 release/3.4 release/4.0 release/4.1 repro-instruction-update rn-tab-open shilman/angular-cli-example shilman/remove-withevents shilman/3.2.12-release snyk-fix-1n1s5x snyk-fix-iu4xwt snyk-fix-m3aahq snyk-fix-ncwvxj snyk-fix-pek1pb snyk-fix-q1x0k4 snyk-fix-rum9x7 snyk-fix-wmry50 storysource-with-deps tech/emotion10 tech/overhaul-ui-store tech/overhaul-ui tech/try-github-workflos tmeasday/add-refs-to-stories tmeasday/check-react-access-3.4 tmeasday/embed-preview-context try-to-fix-master typescript-poc
Nothing to show
Clone or download
wuweiweiwu Merge pull request #4507 from janssen92/addon-knobs-fix-missing-key
Addon-Knob: Add missing key property in Panel
Latest commit 2cc36de Dec 9, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci REMOVE quiet flag for tests for RN, (it's always silent) Nov 8, 2018
.github Comment out notes per CRA's PR template Nov 5, 2018
.teamcity FIX dll cache on teamcity (maybe) Nov 28, 2018
__mocks__ Use prettier parsers to parse ast for js and ts. Mar 21, 2018
addons Merge pull request #4507 from janssen92/addon-knobs-fix-missing-key Dec 9, 2018
app v4.1.0-alpha.11 Dec 5, 2018
docs Merge pull request #4936 from storybooks/dependabot/npm_and_yarn/docs… Dec 6, 2018
examples-native/crna-kitchen-sink Merge pull request #4729 from storybooks/dependabot/npm_and_yarn/exam… Nov 28, 2018
examples Merge pull request #4929 from storybooks/fix-angular-storyshots Dec 5, 2018
lib v4.1.0-alpha.11 Dec 5, 2018
media Replace demo.gif in apps Aug 16, 2018
packs Remove the `test-cra` example app. Aug 22, 2017
scripts Run prettier Dec 4, 2018
.babelrc.js Fix RN binaries Dec 4, 2018
.bettercodehub.yml Add storyshot as a test file Aug 1, 2018
.editorconfig Missing svelte editor config Jul 25, 2018
.eslintignore FIX linting Nov 26, 2018
.eslintrc.js CHANGE webpack configs, dev & static build for performance Nov 23, 2018
.gitignore CHANGE output of dll to lib/core so it's easier to reference Nov 26, 2018
.mailmap Update .mailmap Mar 8, 2018
.npmignore Consolidate all the copied demo.gif to one place Aug 1, 2018
.prettierrc Fix problems from reverted cleanup Oct 31, 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 updated readme's and storyshot Oct 30, 2018
CHANGELOG.md 4.0.12 changelog Dec 5, 2018
CODE_OF_CONDUCT.md Add Code of Conduct as recommended by GitHub Nov 9, 2017
CONTRIBUTING.md Fix typos and grammatical errors in markdown documents Dec 5, 2018
HISTORY.md Fixed links to storybook.js.org. Jun 7, 2017
LICENSE Revert "Update LICENSE" Nov 22, 2018
MAINTAINERS.md Fix typos and grammatical errors in markdown documents Dec 5, 2018
MIGRATION.md Fix typo/grammer Dec 7, 2018
README.md Fix typos and grammatical errors in markdown documents Dec 5, 2018
RELEASES.md Fix typos and grammatical errors in markdown documents Dec 5, 2018
ROADMAP.md Fix typos and grammatical errors in markdown documents Dec 5, 2018
dangerfile.js Update dangerfile to block conflicting labels Nov 21, 2018
jest.config.js Resolve config from CLI and add tests Dec 3, 2018
lerna.json v4.1.0-alpha.11 Dec 5, 2018
netlify.toml FIX the failing netlify builds Dec 21, 2017
package.json Merge remote-tracking branch 'origin/next' into core/smaller-code-blocks Dec 4, 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 remote-tracking branch 'origin/next' into core/smaller-code-blocks Dec 4, 2018

README.md

Storybook

Build Status on TeamCity 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 v4.0.0 React
React Native - React Native
Vue v4.0.0 Vue
Angular v4.0.0 Angular
Polymer v4.0.0 Polymer
Mithril v4.0.0 Mithril
Marko v4.0.0 Marko
HTML v4.0.0 HTML
Svelte v4.0.0 Svelte
Riot v4.0.0 Riot
Ember v4.0.0 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
cssresources Dynamically add/remove css resources to the component iframe
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