Skip to content
UI component dev & test: React, Vue, Angular, React Native, Ember, Web Components & more!
TypeScript JavaScript HTML Kotlin Shell Vue Other
Branch: next
Clone or download
shilman Merge pull request #7841 from storybookjs/7840-root-hidden-bug
Addon-docs: Force hidden attribute on #root element
Latest commit 05b1df9 Aug 22, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.ci/danger ADD a danger workflow Feb 8, 2019
.circleci Merge branch 'next' into 7101-convert-mdx-to-module Jul 15, 2019
.github Update nodejs.yml Aug 19, 2019
.teamcity/OpenSourceProjects_Storybook Merge branch 'next' into pr/6472 Jun 27, 2019
__mocks__ Add unit test for flow parser in StorySource Dec 14, 2018
addons v5.2.0-beta.39 Aug 22, 2019
app v5.2.0-beta.39 Aug 22, 2019
dev-kits v5.2.0-beta.39 Aug 22, 2019
docs 5.2.0-beta.39 next.json version file Aug 22, 2019
examples-native/crna-kitchen-sink v5.2.0-beta.39 Aug 22, 2019
examples Merge pull request #7647 from lonyele/feature/remove-no-dll-on-examples Aug 22, 2019
lib Addon-docs: Force hidden attribute on #root element Aug 22, 2019
media Replace old intro animation with new hotness Mar 20, 2019
packs Remove the `test-cra` example app. Aug 22, 2017
scripts Fix some more typos Jul 22, 2019
.babelrc.js source-loader: separate server and client code Jul 20, 2019
.bettercodehub.yml Add storyshot as a test file Aug 1, 2018
.editorconfig Missing svelte editor config Jul 25, 2018
.eslintignore Merge branch 'next' into 7101-convert-mdx-to-module Jul 15, 2019
.eslintrc.js Merge branch 'next' into 7101-convert-mdx-to-module Jul 15, 2019
.gitignore Addon-docs: Add DocsPage automagically Jul 26, 2019
.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 Merge branch 'next' into pr/6472 Jun 27, 2019
.travis.yml attempt to fix travis timeouts Jul 23, 2019
ADDONS_SUPPORT.md Merge branch 'next' into pr/6472 Jun 27, 2019
CHANGELOG.md 5.2.0-beta.39 changelog Aug 22, 2019
CODE_OF_CONDUCT.md Merge branch 'next' into pr/6472 Jun 27, 2019
CONTRIBUTING.md Fix Typos Jul 22, 2019
HISTORY.md Merge branch 'next' into pr/6472 Jun 27, 2019
LICENSE Merge branch 'next' into tech/overhaul-ui Nov 28, 2018
MAINTAINERS.md Fix typos and grammatical errors in markdown documents Dec 5, 2018
MIGRATION.md MIGRATION.md: Fix indentation Aug 2, 2019
README.md Move intro video up Aug 22, 2019
RELEASES.md Merge branch 'next' into pr/6472 Jun 27, 2019
ROADMAP.md Fix typos and grammatical errors in markdown documents Dec 5, 2018
jest.config.js Merge branch 'next' into 7101-convert-mdx-to-module Jul 15, 2019
lerna.json v5.2.0-beta.39 Aug 22, 2019
netlify.toml Merge branch 'next' into pr/6472 Jun 27, 2019
now.json Merge branch 'next' into pr/6472 Jun 27, 2019
package.json Merge branch 'next' into 6975-ui-ts-migration-1 Jul 31, 2019
prettier.config.js UPDATE prettier config && FIX .md files Jan 24, 2019
riot-jest-transformer.json cheating on the riot jest transformer to use babel 7 Aug 28, 2018
svelte-transform.js Merge branch 'next' into pr/6472 Jun 27, 2019
tsconfig.json Merge branch 'next' into 7101-convert-mdx-to-module Jul 15, 2019
yarn.lock REMOVE need for babel-register in our CLI Aug 20, 2019

README.md

Storybook

Build bulletproof UI components faster


Build Status on CircleCI CodeFactor Known Vulnerabilities codecov License
Storybook Slack Backers on Open Collective Sponsors on Open Collective Official 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:
latest next

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

You can’t perform that action at this time.