Repository files navigation

Build bulletproof UI components faster

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 atstorybook.js.org!

View README for:

• 🚀Getting Started
• 📒Projects
  • 🛠Supported Frameworks & Examples
  • 🔗Addons
• 🏅Badges & Presentation materials
• 👥Community
• 👏Contributing
  • 👨‍💻Development scripts
  • 💸Sponsors
  • 💵Backers
• 📝License

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

Documentation can be found onStorybook's docs site.

ViewComponent Encyclopedia to see how leading teams use Storybook.

Usestorybook.new to quickly create an example project in Stackblitz.

Storybook comes with a lot ofaddons 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.

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

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

SeeAddon / 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 todocs instead, andhere is a guide to help you.

If you're using contexts, we highly recommend you migrate totoolbars andhere is a guide to help you.

If you're using addon-storyshots, we highly recommend you migrate to the Storybooktest-runner andhere is a guide to help you.

We have a badge! Link it to your live Storybook example.

[![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 ourbrand repo.

• Tweeting via@storybookjs
• Blogging atstorybook.js.org andMedium
• Chatting onDiscord
• Videos and streams atYouTube

Contributions to Storybook are always welcome!

• 📥 Pull requests and 🌟 Stars are always welcome.
• Read ourcontributing guide to get started,or find us onDiscord, we will take the time to guide you.

Looking for a first issue to tackle?

• We tag issues with 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 interest.

Storybook is organized as a monorepo. Useful scripts include:

Runs a sandbox template storybook with test stories

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

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

boolean check if unit tests all pass - uses jest

• yarn run test --core --watch - will run core tests in watch-mode

Become a sponsor to have your logo and website URL on our README on Github. [Become a sponsor]

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

MIT

-the end-