storybook – storybookjs

SECTION · 01

关键指标一览

Stars 数

90,725

Forks 数

10,292

Watchers 数

90,725

Issue 数

1,756

主要语言

TypeScript

许可证

MIT

仓库所有者

storybookjs

创建时间

2016.03.18

更新时间

2026.07.31

主题标签

SECTION · 03

README 详细介绍

README 原文为英文,如需阅读完整中文内容,建议使用 浏览器翻译插件(如 Edge 浏览器自带翻译、Google 翻译扩展)进行整页翻译。

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

View README for:

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](https://next--630511d655df72125520f051.chromatic.com/) | ![React](code/renderers/react) |
| Angular | ![Storybook demo](https://next--6322ce6af69825592bbb28fc.chromatic.com/) | ![Angular](code/frameworks/angular/) |
| Vue 3 | ![Storybook demo](https://next--630513346a8e284ae244d415.chromatic.com/) | ![Vue 3](code/renderers/vue3/) |
| Web components | ![Storybook demo](https://next--638db5bf49adfdfe8cf545e0.chromatic.com/) | ![Svelte](code/renderers/web-components) |
| React Native | ![](/) | ![React Native](https://github.com/storybookjs/react-native) |
| HTML | ![Storybook demo](https://next--63dd39a158cf6fc05199b4bb.chromatic.com/) | ![HTML](code/renderers/html) |
| Ember | ![](/) | ![Ember](code/frameworks/ember/) |
| Svelte | ![Storybook demo](https://next--630873996e4e3557791c069c.chromatic.com/) | ![Svelte](code/renderers/svelte) |
| Preact | ![Storybook demo](https://next--63b588a512565bfaace15e7c.chromatic.com/) | ![Preact](code/renderers/preact) |
| Qwik | ![](/) | ![Qwik](https://github.com/literalpie/storybook-framework-qwik) |
| SolidJS | ![](/) | ![SolidJS](https://github.com/solidjs-community/storybook) |
| Android, iOS, Flutter | ![](/) | ![Native](https://github.com/storybookjs/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

Tweeting via @storybookjs
Blogging at storybook.js.org and Medium
Chatting on Discord
Videos and streams at YouTube

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](https://github.com/storybookjs/storybook/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) 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.