文档API
Storybook 文档

API 参考

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

配置

名称描述
main.js|ts

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

preview.js|jsx|ts|tsx

此配置文件控制故事的渲染方式。您还可以使用它来运行应用于所有故事的代码。

manager.js|ts

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

CLI

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

故事

名称描述
CSF

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

ArgTypes

ArgTypes 指定参数的行为。通过指定参数的类型,您可以约束它可以接受的值,并提供有关未明确设置的参数的信息。

参数

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

文档

名称描述
文档块

Storybook 提供了一些文档块来帮助您记录组件和项目的其他方面。