文档API
Storybook 文档

API 参考

Storybook 所有可用 API 参考的概述。

配置

名称描述
main.js|ts

Storybook 的主要配置文件,用于指定 Storybook 项目的行为,包括 stories 的位置、你使用的插件、功能标志和其他项目特定的设置。

preview.js|jsx|ts|tsx

此配置文件控制 stories 的渲染方式。你也可以使用它来运行应用于所有 stories 的代码。

manager.js|ts

此配置文件控制 Storybook UI(管理器)的行为。

CLI

Storybook 是一个 CLI 工具。你可以在开发模式下启动 Storybook,或者构建 Storybook 的静态版本。

Stories

名称描述
CSF

组件 Story 格式 (CSF) 是用于编写 stories 的 API。它是一个基于 ES6 模块的开放标准,可移植到 Storybook 之外。

ArgTypes

ArgTypes 指定 args 的行为。通过指定 arg 的类型,你可以约束它可以接受的值,并提供有关未显式设置的 args 的信息。

参数

参数是用于在 Storybook 中配置你的 stories 插件的静态元数据。它们在 story、meta(组件)、项目(全局)级别指定。

文档

名称描述
文档块

Storybook 提供了几个文档块,以帮助记录你的组件和项目的其他方面。