框架的功能支持
Storybook 与许多流行的前端框架集成。我们尽力保持各个框架之间的功能对等,但对于我们这个规模不大的团队来说,支持每个框架是很棘手的。
下面是一个全面的表格,列出了哪些框架集成支持哪些功能。如果您希望在您的框架中支持某个功能,我们欢迎 pull request。
核心框架
核心框架有专门的维护者或贡献者负责维护集成。因此,您可以在这些框架中使用大多数 Storybook 功能。
React | Vue 3 | Angular | Web Components | |
---|---|---|---|---|
Essentials | ||||
Actions | ✅ | ✅ | ✅ | ✅ |
Backgrounds | ✅ | ✅ | ✅ | ✅ |
文档 | ✅ | ✅ | ✅ | ✅ |
Viewport | ✅ | ✅ | ✅ | ✅ |
Controls | ✅ | ✅ | ✅ | ✅ |
Measure | ✅ | ✅ | ✅ | ✅ |
Outline | ✅ | ✅ | ✅ | ✅ |
插件 | ||||
A11y | ✅ | ✅ | ✅ | ✅ |
组件测试 | ✅ | ✅ | ✅ | ✅ |
测试运行器 | ✅ | ✅ | ✅ | ✅ |
测试覆盖率 | ✅ | ✅ | ✅ | ✅ |
CSS 资源 | ✅ | ✅ | ✅ | ✅ |
设计资产 | ✅ | ✅ | ✅ | ✅ |
Events | ✅ | ✅ | ✅ | ✅ |
Google analytics | ✅ | ✅ | ✅ | ✅ |
GraphQL | ✅ | ✅ | ||
Jest | ✅ | ✅ | ✅ | ✅ |
Links | ✅ | ✅ | ✅ | ✅ |
Queryparams | ✅ | ✅ | ✅ | ✅ |
Storysource | ✅ | ✅ | ✅ | ✅ |
文档 | ||||
CSF Stories | ✅ | ✅ | ✅ | ✅ |
自动文档 | ✅ | ✅ | ✅ | ✅ |
文档块 - ArgTypes | ✅ | ✅ | ✅ | ✅ |
文档块 - Canvas | ✅ | ✅ | ✅ | ✅ |
文档块 - ColorPalette | ✅ | ✅ | ✅ | ✅ |
文档块 - Controls | ✅ | ✅ | ✅ | ✅ |
文档块 - Description | ✅ | ✅ | ✅ | ✅ |
文档块 - IconGallery | ✅ | ✅ | ✅ | ✅ |
文档块 - Markdown | ✅ | ✅ | ✅ | ✅ |
文档块 - Meta | ✅ | ✅ | ✅ | ✅ |
文档块 - Primary | ✅ | ✅ | ✅ | ✅ |
文档块 - Source | ✅ | ✅ | ✅ | ✅ |
文档块 - Story | ✅ | ✅ | ✅ | ✅ |
文档块 - Stories | ✅ | ✅ | ✅ | ✅ |
文档块 - Subtitle | ✅ | ✅ | ✅ | ✅ |
文档块 - Title | ✅ | ✅ | ✅ | ✅ |
文档块 - Typeset | ✅ | ✅ | ✅ | ✅ |
文档块 - Unstyled | ✅ | ✅ | ✅ | ✅ |
文档块 - UseOf | ✅ | ✅ | ✅ | ✅ |
内联 Stories | ✅ | ✅ | ✅ | ✅ |
社区框架
社区框架的贡献者较少,这意味着它们可能不如核心框架那样是最新的。如果您在工作中使用这些框架之一,请考虑为 Storybook 的集成做出贡献。
Ember | HTML | Svelte | Preact | Qwik | SolidJS | |
---|---|---|---|---|---|---|
Essentials | ||||||
Actions | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Backgrounds | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
文档 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Viewport | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Controls | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Measure | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Outline | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
插件 | ||||||
A11y | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
组件测试 | ✅ | ✅ | ✅ | ✅ | ✅ | |
测试运行器 | ✅ | ✅ | ✅ | ✅ | ✅ | |
测试覆盖率 | ✅ | ✅ | ✅ | ✅ | ✅ | |
CSS 资源 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
设计资产 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Events | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Google analytics | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
GraphQL | ||||||
Jest | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Links | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Queryparams | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Storysource | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
文档 | ||||||
CSF Stories | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
自动文档 | ✅ | ✅ | ✅ | ✅ | ✅ | |
文档块 - ArgTypes | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
文档块 - Canvas | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
文档块 - ColorPalette | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
文档块 - Controls | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
文档块 - Description | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
文档块 - IconGallery | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
文档块 - Markdown | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
文档块 - Meta | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
文档块 - Primary | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
文档块 - Source | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
文档块 - Story | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
文档块 - Stories | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
文档块 - Subtitle | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
文档块 - Title | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
文档块 - Typeset | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
文档块 - Unstyled | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
文档块 - UseOf | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
内联 Stories | ✅ | ✅ |
已弃用
为了使 Storybook 生态系统与当前前端开发状态保持一致,以下功能和插件现已弃用,不再维护,并将在未来版本的 Storybook 中移除。
功能 | 状态 |
---|---|
Knobs | Knobs 插件已在 Storybook 6.3 版本发布时正式弃用,并且不再积极维护。我们建议改用Controls。 |
Storyshots | Storyshots 插件已在 Storybook 7.6 版本发布时正式弃用,不再积极维护,并在 Storybook 8 中移除。请参阅迁移指南,了解可用的替代方案。 |
StoriesOf | storiesOf API 已在 Storybook 8 版本发布时正式移除,并且不再维护。我们建议改用 CSF API 来编写 stories。有关更多信息,请参阅迁移指南。 |