目录
开始使用
访问 Storybook 的网站，了解更多关于 Storybook 的信息并开始使用。
文档
文档可在 Storybook 的文档网站上找到。
示例
查看 组件百科全书，了解领先团队如何使用 Storybook。
使用 storybook.new 在 Stackblitz 中快速创建一个示例项目。
Storybook 附带了许多用于组件设计、文档、测试、交互性等方面的插件。Storybook 的 API 使其可以通过各种方式进行配置和扩展。甚至已扩展到支持 React Native、Android、iOS 和 Flutter 的移动开发。
社区
如需更多帮助，请在仓库的 GitHub Discussions 中分享您的问题。
项目
支持的框架
| 渲染器 | 演示 | |
|---|---|---|
| React |  |
 |
| Angular |  |
 |
| Vue 3 |  |
 |
| Web components |  |
 |
| React Native |  |
 |
| HTML |  |
 |
| Ember |  |
 |
| Svelte |  |
 |
| Preact |  |
 |
| Qwik |  |
 |
| SolidJS |  |
 |
| Android, iOS, Flutter |  |
 |
插件
| 插件 | |
|---|---|
| a11y | 在 Storybook 中测试组件的用户可访问性 |
| actions | 在 Storybook UI 中记录用户与组件交互时的操作 |
| backgrounds | 让用户在 Storybook UI 中选择背景 |
| cssresources | 动态地向组件 iframe 添加/删除 CSS 资源 |
| design assets | 与您的故事一起查看图片、视频和网页链接 |
| docs | 为您的组件添加高质量的文档 |
| events | 交互式地向响应 EventEmitter 的组件触发事件 |
| google-analytics | 报告关于故事的谷歌分析数据 |
| graphql | 在 Storybook 故事中查询 GraphQL 服务器 |
| jest | 在 Storybook 中查看组件单元测试的结果 |
| links | 在故事之间创建链接 |
| measure | 在 Storybook UI 中直观检查布局和盒模型 |
| outline | 在 Storybook UI 中直观调试 CSS 布局和对齐 |
| query params | 模拟查询参数 |
| viewport | 使用 Storybook 更改响应式组件的显示尺寸和布局 |
查看 插件/框架支持表
为了持续改善您的体验，我们最终不得不弃用或移除某些插件，转而采用新的、更好的工具。
如果您正在使用 info/notes，强烈建议您迁移到 docs，这里有一个指南可以帮助您。
如果您正在使用 contexts，强烈建议您迁移到 toolbars，这里有一个指南可以帮助您。
如果您正在使用 addon-storyshots，强烈建议您迁移到 Storybook test-runner，这里有一个指南可以帮助您。
徽章与演示材料
我们有一个徽章！将其链接到您的实时 Storybook 示例。
[](link to site)
如果您正在寻找用于 Storybook 演示的材料，例如标志、视频素材以及我们使用的颜色，您可以在我们的 品牌仓库 中找到所有这些内容。
社区
- 通过 @storybookjs 发推文
- 在 storybook.js.org 和 Medium 上写博客
- 在 Discord 上聊天
- 在 YouTube 上观看视频和直播
贡献
始终欢迎对 Storybook 的贡献！
正在寻找第一个要解决的问题？
- 我们将问题标记为
，因为我们认为这些问题非常适合刚接触代码库或对开源软件 (OSS) 不熟悉的人。 - 与我们交流，我们会找到适合您技能和学习兴趣的内容。
开发脚本
Storybook 以 monorepo 形式组织。有用的脚本包括
yarn start
运行带有测试故事的沙箱模板 Storybook
yarn task
如上，但提供自定义沙箱的选项（例如选择其他框架）
yarn lint
布尔值检查代码是否符合 linting 规则 - 使用 remark 和 eslint
yarn lint:js- 将检查 jsyarn lint:md- 将检查 markdown + 代码示例yarn lint:js --fix- 将自动修复 js
yarn test
布尔值检查单元测试是否全部通过 - 使用 jest
yarn run test --core --watch- 将在 watch 模式下运行核心测试
赞助商
成为赞助商，让您的标志和网站 URL 出现在我们的 Github README 上。[成为赞助商]
支持者
通过定期捐赠，您可以支持我们和我们的工作。[成为支持者]
许可
-结束-
