Docs API
Storybook Docs

API 参考

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

¥An overview of all available API references for Storybook.

配置

¥Configuration

名称描述
main.js|ts

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

preview.js|jsx|ts|tsx

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

manager.js|ts

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

CLI

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

故事

¥Stories

名称描述
CSF

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

ArgTypes

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

参数

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

文档

¥Docs

名称描述
文档块

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