加入直播:周四,美国东部时间上午11点,Storybook 9 发布 & AMA (问答会)

Storybook 上下文插件

在 Github 上查看

目录

开始使用

访问Storybook 官网,了解更多关于 Storybook 的信息并开始使用。

文档

文档可在Storybook 文档网站上找到。

示例

查看组件百科,了解领先团队如何使用 Storybook。

使用storybook.new 在 Stackblitz 中快速创建一个示例项目。

Storybook 包含许多用于组件设计、文档、测试、交互等方面的插件。Storybook 的 API 允许以各种方式进行配置和扩展。它甚至已被扩展以支持 React Native、Android、iOS 和 Flutter 等移动开发。

社区

如需额外帮助,请在该仓库的 GitHub Discussions 中分享您的问题。

项目

支持的框架

渲染器 演示
React Storybook demo React
Angular Storybook demo Angular
Vue 3 Storybook demo Vue 3
Web components Storybook demo Svelte
React Native React Native
HTML Storybook demo HTML
Ember Ember
Svelte Storybook demo Svelte
Preact Storybook demo Preact
Qwik Qwik
SolidJS SolidJS
Android, iOS, Flutter Native

插件

插件
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 实时示例。

Storybook

[![Storybook](https://cdn.jsdelivr.net.cn/gh/storybookjs/brand@main/badge/badge-storybook.svg)](link to site)

如果您正在寻找可在 Storybook 演示中使用的材料,如徽标、视频素材和我们使用的颜色,您都可以在我们的品牌仓库中找到。

社区

贡献

随时欢迎对 Storybook 做出贡献!

  • 📥 Pull requests 和 🌟 Stars 随时欢迎。
  • 阅读我们的贡献指南以开始,或在 Discord 上找到我们,我们将花时间指导您。

正在寻找第一个要解决的问题吗?

  • 我们认为某些问题适合初次接触代码库或开源软件的人时,会给它们打上 适合首次贡献的问题 标签。
  • 与我们交流,我们会找到适合您技能和学习兴趣的事情。

开发脚本

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 中。 [成为赞助商]

支持者

通过定期捐赠,您可以支持我们和我们的工作。 [成为支持者]

许可证

MIT

-完-

贡献者
  • alexandrebodin
    alexandrebodin
  • codebyalex
    codebyalex
  • dandean
    dandean
  • danielduan
    danielduan
  • dannyhw
    dannyhw
  • domyen
    domyen
标签