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

Latest commit

shilman Merge pull request #10290 from storybookjs/fix/9901
Core: Fix source-map strategy for production
Latest commit d4027f0 Apr 3, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.ci/danger CHANGE lodash imports to lodash/* Feb 17, 2020
.circleci FIX circleci missing git Mar 30, 2020
.github RENEW cache in gh-actions Mar 30, 2020
.teamcity Use docker image suited for puppeteer Mar 27, 2020
.vscode Merge branch 'next' into pr/9090 Jan 28, 2020
__mocks__ FIX linting Mar 27, 2020
addons Document addon-viewport disable paramter #10282 Apr 1, 2020
app v6.0.0-alpha.30 Mar 31, 2020
cypress FIX linting Mar 27, 2020
dev-kits v6.0.0-alpha.30 Mar 31, 2020
docs 6.0.0-alpha.30 next.json version file Mar 31, 2020
examples v6.0.0-alpha.30 Mar 31, 2020
lib FIX #9901 Apr 2, 2020
media Replace old intro animation with new hotness Mar 20, 2019
packs Remove the `test-cra` example app. Aug 22, 2017
scripts FIX linting Mar 27, 2020
.babelrc.js Merge branch 'next' into pr/9090 Jan 28, 2020
.bettercodehub.yml Add storyshot as a test file Aug 1, 2018
.editorconfig Missing svelte editor config Jul 25, 2018
.eslintignore Merge branch 'next' into pr/9090 Jan 28, 2020
.eslintrc.js UPDATE to latest version of eslint config Feb 17, 2020
.gitattributes Merge branch 'next' into pr/9090 Jan 28, 2020
.gitignore add dir cleanup and gitignore ts3.5 Feb 19, 2020
.mailmap Update .mailmap Mar 8, 2018
.prettierrc Fix problems from reverted cleanup Oct 31, 2018
.remarkignore Add CHANGELOG.md to remarkignore Sep 18, 2018
.remarkrc.js Use the extracted linting configs Sep 26, 2019
.spelling Merge branch 'next' into pr/6472 Jun 27, 2019
.travis.yml Make travis a no-op Oct 4, 2019
ADDONS_SUPPORT.md Merge branch 'next' into feature/addon-toolbars Mar 12, 2020
CHANGELOG.md 5.3.18 changelog Mar 31, 2020
CODE_OF_CONDUCT.md Merge branch 'next' into pr/6472 Jun 27, 2019
CONTRIBUTING.md Clarify contribution guidelines to next Mar 19, 2020
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 Misleading information on upgrade Mar 31, 2020
README.md Merge branch 'next' into feature/addon-toolbars Mar 12, 2020
RELEASES.md Removed instances of obvious, of course Oct 12, 2019
cypress.json ADD first cypress test Oct 12, 2019
jest.config.js Merge branch 'next' into feature/addon-toolbars Mar 12, 2020
lerna.json v6.0.0-alpha.30 Mar 31, 2020
netlify.toml Merge branch 'next' into feature/addon-toolbars Mar 12, 2020
package.json UPGRADE angular Mar 30, 2020
prettier.config.js ESlint upgrade Oct 3, 2019
riot-jest-transformer.json cheating on the riot jest transformer to use babel 7 Aug 28, 2018
tsconfig.json Merge branch 'next' into pr/9090 Jan 28, 2020
yarn.lock UPGRADE ember Mar 30, 2020

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 API makes it possible 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.3.0 React
React Native - React Native
Vue v5.3.0 Vue
Angular v5.3.0 Angular
Marionette.js - Marionette.js
Mithril v5.3.0 Mithril
Marko v5.3.0 Marko
HTML v5.3.0 HTML
Svelte v5.3.0 Svelte
Riot v5.3.0 Riot
Ember v5.3.0 Ember
Preact v5.3.0 Preact
Rax v5.3.0 Rax

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
docs Add high quality documentation to your components
events Interactively fire events to components that respond to EventEmitter
google-analytics Reports google analytics on stories
graphql Query a GraphQL server within Storybook stories
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
options Customize the Storybook UI in code
query params Mock query params
storyshots 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

Deprecated Addons

Addons
info Annotate stories with extra component usage information
notes Annotate Storybook stories with notes

In order to continue improving your experience, we have to eventually deprecate certain addons in favor of new, better tools.

If you're using info/notes, we highly recommend you to migrate to docs instead, and here is a guide to help you.

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