[opensourcedex]

storybook is a free, open source documentation & knowledge base project written in TypeScript and released under MIT. It has 91,428 GitHub stars, 10,495 forks and 1,831 open issues, and was last pushed 2 hours ago. On this registry it ranks #1 of 100 tracked projects in Documentation & Knowledge Base, with 5 head-to-head comparisons available. It gained 247 stars over the last 30 tracked days.

What is storybook?

Storybook is an open-source, MIT-licensed frontend workshop, written in TypeScript, for building, documenting, and testing UI components and pages in isolation, aimed at frontend engineers and design-system teams working in React, Angular, Vue, Svelte, React Native, HTML, and other supported renderers.

What it is

Storybook renders individual UI components and pages outside the full application, letting developers build, test, and document each one on its own. The registry files it under Content & Publishing / Documentation & Knowledge Base, and the project calls itself the industry standard workshop for building, documenting, and testing UI components in isolation. It ships as framework-specific packages, including @storybook/react, @storybook/angular, @storybook/vue3, @storybook/web-components, @storybook/react-native, @storybook/html, and @storybook/ember, each wiring the same workshop into a different renderer.

The concrete problem it solves is that UI work is normally entangled with the running application: a developer boots the whole app, navigates to a page, and contrives state just to see one component in one condition. Storybook replaces that with an isolated canvas driven by stories, small files that describe component states. Because it spans React, Angular, Vue 3, web components, React Native, HTML, and Ember, it acts as one shared surface for component development, visual testing, and living documentation, and it is also used to maintain design systems and styleguides.

Key capabilities

  • Isolated rendering of components and pages through the stories format, so any UI state can be developed without the surrounding application.
  • First-party renderers for React, Angular, Vue 3, web components, React Native, HTML, and Ember, published as packages such as @storybook/react and @storybook/angular.
  • A documented addon system covering component design, documentation, testing, and interactivity.
  • A configuration and extension API that allows the workshop to be reshaped beyond default behaviour.
  • Extension to mobile platforms, with the model carried into React Native, Android, iOS, and Flutter.
  • A Component Encyclopedia showcase on storybook.js.org presenting how leading teams use the project.
  • storybook.new, a hosted entry point that spins up an example project in Stackblitz.

Who uses it and how

  • Thousands of teams use it, per the project's own description, for UI development, testing, and documentation as a shared frontend workflow.
  • Design-system and styleguide maintainers use it as the published surface where component states, variants, and usage are documented for the wider organisation.
  • Component authors use stories to develop and test one state at a time instead of exercising the whole application.
  • Mobile teams use the React Native and broader Android, iOS, and Flutter extensions to apply the same isolated-component workflow outside the browser.
  • Newcomers use storybook.new to reach a working example project in Stackblitz without a local install.

Getting started

The README directs users to storybook.js.org to get started and to storybook.js.org/docs for documentation, with storybook.new as a hosted route to an example project in Stackblitz. Installation is per renderer through the published packages, such as @storybook/react.

How it compares

No list of paid or proprietary products that Storybook replaces appears in the facts, and no directly comparable tool is named either. Within this registry it stands alone in its category as the frontend workshop for isolated component development.

When to use it — and when not to

Storybook fits frontend and design-system teams already working in one of its supported renderers who want component isolation, testing, and documentation in one place. It is a poor fit for projects outside frontend UI work, or for teams unwilling to maintain an extra development surface beside their application. Adopters should weigh the health signals honestly: an MIT licence, roughly 91,000 stars and 10,400 forks, but also about 1,831 open issues and a README that largely points to the external website rather than carrying setup instructions itself.

project readme (upstream, from github) — read inline

Storybook

Build bulletproof UI components faster


Build Status on CircleCI codecov License
Storybook Community Backers on Open Collective Sponsors on Open Collective Official Twitter Handle OpenSSF Scorecard

Storybook is a frontend workshop for building UI components and pages in isolation. Thousands of teams use it for UI development, testing, and documentation. Find out more at storybook.js.org!

View README for:
latest next

Table of contents

Getting Started

Visit Storybook's website to learn more about Storybook and to get started.

Documentation

Documentation can be found on Storybook's docs site.

Examples

View Component Encyclopedia to see how leading teams use Storybook.

Use storybook.new to quickly create an example project in Stackblitz.

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, Android, iOS, and Flutter development for mobile.

Community

For additional help, share your issue in the repo's GitHub Discussions.

Projects

Supported Frameworks

Renderer Demo
React Storybook demo React
Angular Storybook demo Angular
Vue 3 Storybook demo Vue 3
Web components Storybook demo Svelte
React Native React Native
HTML Storybook demo HTML
Ember Ember
Svelte Storybook demo Svelte
Preact Storybook demo Preact
Qwik Qwik
SolidJS SolidJS
Android, iOS, Flutter Native

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
cssresources Dynamically add/remove CSS resources to the component iframe
design assets View images, videos, and 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
links Create links between stories
measure Visually inspect the layout and box model within the Storybook UI
outline Visually debug the CSS layout and alignment within the Storybook UI
query params Mock query params
viewport Change display sizes and layouts for responsive components using Storybook

See Addon / Framework Support Table

To continue improving your experience, we have to eventually deprecate or remove certain addons in favor of new and better tools.

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

If you're using contexts, we highly recommend you migrate to toolbars and here is a guide to help you.

If you're using addon-storyshots, we highly recommend you migrate to the Storybook test-runner 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@main/badge/badge-storybook.svg)](link to site)

If you're looking for material to use in your Storybook presentation, such as logos, video material, and the colors we use, you can find it all on our brand repo.

Community

Contributing

Contributions to Storybook are always welcome!

  • 📥 Pull requests and 🌟 Stars are always welcome.
  • Read our contributing guide to get started, or find us on Discord, we 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 that suits your skills and learning interests.

Development scripts

Storybook is organized as a monorepo. Useful scripts include:

yarn start

Runs a sandbox template storybook with test stories

yarn task

As above, but gives you options to customize the sandbox (e.g. selecting other frameworks)

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 to have your logo and website URL on our README on Github. [Become a sponsor]

Backers

By making a recurring donation, you can support us and our work. [Become a backer]

License

MIT

-the end-

Frequently asked questions

Is storybook free to use?

storybook is open source under the MIT licence. There is no licence fee and no seat count — you can self-host it or, where the project offers one, pay a vendor for a managed version instead.

What does storybook do?

Storybook is the industry standard workshop for building, documenting, and testing UI components in isolation

What is storybook written in?

storybook is primarily written in TypeScript. Its source is publicly available at https://github.com/storybookjs/storybook, and it has 91,428 GitHub stars.