目录
开始使用
访问 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 资源 |
| 设计资源 | 在你的 story 旁边查看图片、视频和网页链接 |
| docs | 为你的组件添加高质量文档 |
| events | 交互式地向响应 EventEmitter 的组件触发事件 |
| google-analytics | 报告 story 的 Google Analytics 数据 |
| graphql | 在 Storybook stories 中查询 GraphQL 服务器 |
| jest | 在 Storybook 中查看组件单元测试结果 |
| links | 创建 stories 之间的链接 |
| measure | 在 Storybook UI 中可视化检查布局和盒模型 |
| outline | 在 Storybook UI 中可视化调试 CSS 布局和对齐 |
| 查询参数 | 模拟查询参数 |
| 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 做出贡献！
正在寻找要解决的第一个问题？
- 我们将那些我们认为非常适合刚接触代码库或开源软件的人的问题标记为
。 - 联系我们，我们会找到适合您的技能和学习兴趣的事情。
开发脚本
Storybook 是一个 monorepo。有用的脚本包括：
yarn start
运行带有测试 stories 的 sandbox 模板 Storybook
yarn task
同上，但提供选项来自定义 sandbox（例如，选择其他框架）
yarn lint
检查代码是否符合 linting 规则的布尔值检查 - 使用 remark 和 eslint
yarn lint:js- 将检查 js 文件yarn lint:md- 将检查 markdown + 代码示例yarn lint:js --fix- 将自动修复 js 文件
yarn test
检查单元测试是否全部通过的布尔值检查 - 使用 jest
yarn run test --core --watch- 将在 watch 模式下运行核心测试
赞助商
成为赞助商，您的标志和网站 URL 将出现在我们在 Github 上的 README 中。 [成为赞助商]
支持者
通过定期捐赠，您可以支持我们和我们的工作。 [成为支持者]
许可证
-结束-
