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 指定参数的行为。通过指定参数的类型,您可以限制其可以接受的值,并提供有关未显式设置的参数的信息。 |
| Parameters | 参数是静态元数据,用于在 Storybook 中配置您的故事和插件。它们可以在故事、meta(组件)和项目(全局)级别进行指定。 |
文档
| 名称 | 描述 |
|---|---|
| Doc blocks | Storybook 提供多种文档块,以帮助您记录组件以及您项目的其他方面。 |
