目录
开始使用
访问 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 | 报告故事的 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 的贡献！
正在寻找第一个着手解决的问题？
- 当我们认为某个问题非常适合新手或刚接触开源项目的人解决时，我们会用
标签标记它。 - 与我们联系，我们会找到适合您技能和学习兴趣的内容。
开发脚本
Storybook 以 Monorepo 形式组织。有用的脚本包括：
yarn start
运行一个带有测试故事的沙盒模板 Storybook
yarn task
同上，但提供了选项来定制沙盒（例如选择其他框架）
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 中。 [成为赞助商]
支持者
通过定期捐赠，您可以支持我们和我们的工作。 [成为支持者]
许可
- 结束 -
