API 参考
Storybook 所有可用 API 参考的概述。
配置
名称 | 描述 |
---|---|
main.js|ts | Storybook 的主要配置文件,用于指定 Storybook 项目的行为,包括故事的位置、使用的插件、功能标志以及其他项目特定设置。 |
preview.js|jsx|ts|tsx | 此配置文件控制故事的渲染方式。您还可以使用它来运行适用于所有故事的代码。 |
manager.js|ts | 此配置文件控制 Storybook 用户界面(管理器)的行为。 |
CLI | Storybook 是一个 CLI 工具。您可以在开发模式下启动 Storybook 或构建 Storybook 的静态版本。 |
故事
名称 | 描述 |
---|---|
CSF | 组件故事格式 (CSF) 是编写故事的 API。它是一个基于 ES6 模块的开放标准,可移植到 Storybook 之外。 |
ArgTypes | ArgTypes 指定 args 的行为。通过指定 arg 的类型,您可以限制它接受的值,并提供关于未显式设置的 args 的信息。 |
参数 | 参数是用于配置 Storybook 中的故事和插件的静态元数据。它们在 story、meta(组件)和 project(全局)级别指定。 |
文档
名称 | 描述 |
---|---|
文档块 | Storybook 提供了多种文档块,可帮助您记录组件和项目的其他方面。 |