目录
入门
访问 Storybook 网站 了解更多关于 Storybook 的信息并开始使用。
文档
文档可在 Storybook 文档站点 中找到。
示例
查看 组件百科 以了解领先团队如何使用 Storybook。
使用 storybook.new 在 Stackblitz 中快速创建一个示例项目。
Storybook 带有很多用于组件设计、文档、测试、交互等的 插件。Storybook 的 API 使以各种方式配置和扩展成为可能。它甚至已被扩展以支持 React Native、Android、iOS 和 Flutter 的移动开发。
社区
如需更多帮助，请在 仓库的 GitHub 讨论区 中分享您的问题。
项目
支持的框架
| 渲染器 | 演示 | |
|---|---|---|
| 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 | 模拟查询参数 |
| storysource | 在 Storybook UI 中查看故事的代码 |
| 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 作为一个单体仓库进行组织。有用的脚本包括
yarn start
运行一个带有测试故事的沙箱模板 Storybook
yarn task
与上面相同，但允许您自定义沙箱（例如，选择其他框架）
yarn lint
布尔值检查代码是否符合 lint 规则 - 使用 remark 和 eslint
yarn lint:js- 将检查 jsyarn lint:md- 将检查 markdown 和代码示例yarn lint:js --fix- 将自动修复 js
yarn test
布尔值检查所有单元测试是否都通过 - 使用 jest
yarn run test --core --watch- 将在监视模式下运行核心测试
赞助商
成为赞助商，以便在 Github 上的我们的 README 中显示您的徽标和网站 URL。[成为赞助商]
支持者
通过定期捐款，您可以支持我们和我们的工作。[成为支持者]
许可证
- 结束 -
