标签允许您控制 Storybook 中包含哪些故事,从而实现对同一组故事的不同使用方式。例如,您可以使用标签将测试包含在/排除在 测试运行器 中。对于更复杂的用例,请参阅下面的 方案 部分。
以下标签在每个 Storybook 项目中都可用
标签 | 默认应用? | 描述 |
---|
autodocs | 否 | 标记为 autodocs 的故事将包含在 文档页面 中。如果 CSF 文件不包含至少一个标记为 autodocs 的故事,则该组件将不会生成文档页面。 |
dev | 是 | 标记为 dev 的故事将在 Storybook 的侧边栏中渲染。 |
test | 是 | 标记为 test 的故事目前不会影响 Storybook 的 UI,但可用于过滤 测试运行器。 |
dev
和 test
标签会自动隐式地应用于 Storybook 项目中的每个故事。
标签可以是任何静态(即不是动态创建的)字符串,可以是 内置标签,也可以是您自己设计的自定义标签。要将标签应用于故事,请将字符串数组分配给 tags
属性。标签可以在项目、组件(元数据)或故事级别应用。
例如,要将 autodocs
标签应用于项目中的所有故事,可以使用 .storybook/preview.js|ts
在组件故事文件中,您可以像这样应用标签
要从故事中移除标签,请在标签前添加 !
。例如
可以在项目中的所有故事(在 .storybook/preview.js|ts
中)、组件的所有故事(在 CSF 文件元数据中)或单个故事(如上所述)中移除标签。
自定义标签在 Storybook 的侧边栏层级结构之上提供了一个灵活的分类层。在上面的示例中,我们创建了一个 experimental
标签,表示故事尚未稳定。
您可以为任何目的创建自定义标签。示例用途可能包括
- 状态,例如
experimental
、new
、stable
或 deprecated
- 用户角色,例如
admin
、user
或 developer
- 组件/代码所有权
自定义标签很有用,因为它们会显示为 Storybook 侧边栏中的过滤器。在过滤器中选择一个标签将导致侧边栏只显示具有该标签的故事。选择多个标签将显示包含任何这些标签的故事。
按标签过滤是专注于故事子集的强大方式,尤其是在大型 Storybook 项目中。您还可以按标签缩小故事范围,然后在该子集内进行搜索。
有时为文档目的提供示例故事可能会有所帮助,但您希望使侧边栏导航更专注于对开发有用的故事。通过启用 autodocs
标签并删除 dev
标签,故事将成为仅文档:仅在 文档页面 中出现,而不是出现在 Storybook 的侧边栏中。
对于具有许多变体的组件(例如按钮),将所有变体一起放在网格中可以是可视化它的有用方法。但是您可能希望单独测试这些变体。您可以使用以下标签实现此目的