目录
开始
访问 Storybook 网站，了解更多关于 Storybook 的信息并开始使用。
文档
文档可在 Storybook 文档网站上找到。
示例
查看组件百科，了解领先团队如何使用 Storybook。
使用storybook.new 在 Stackblitz 中快速创建一个示例项目。
Storybook 附带许多插件，用于组件设计、文档、测试、交互等等。Storybook 的 API 使其能够以各种方式进行配置和扩展。它甚至已扩展到支持 React Native、Android、iOS 和 Flutter 移动开发。
社区
如需额外帮助，请在仓库的 GitHub Discussions 中分享您的问题。
项目
支持的框架
| 渲染器 | 演示 | |
|---|---|---|
| React |  |
 |
| Angular |  |
 |
| Vue 3 |  |
 |
| Web 组件 |  |
 |
| React Native |  |
 |
| HTML |  |
 |
| Ember |  |
 |
| Svelte |  |
 |
| Preact |  |
 |
| Qwik |  |
 |
| SolidJS |  |
 |
| Android, iOS, Flutter |  |
 |
插件
| 插件 | |
|---|---|
| a11y | 在 Storybook 中测试组件的用户可访问性 |
| actions | 在 Storybook UI 中，当用户与组件交互时记录操作 |
| backgrounds | 允许用户在 Storybook UI 中选择背景 |
| cssresources | 动态向组件 iframe 添加/删除 CSS 资源 |
| design assets | 在您的 story 旁边查看图片、视频和网页链接 |
| docs | 为您的组件添加高质量文档 |
| events | 交互式地向响应 EventEmitter 的组件触发事件 |
| google-analytics | 报告 stories 的 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 的沙盒模板 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-mode 下运行 core tests
赞助商
成为赞助商，让您的标志和网站 URL 显示在我们 Github 的 README 上。[成为赞助商]
支持者
通过定期捐赠，您可以支持我们和我们的工作。[成为支持者]
许可证
-结束-
