配置 Storybook

Storybook 的配置通过一个名为 .storybook 的文件夹进行，该文件夹包含各种配置文件。

请注意，您可以通过为 storybook dev 和 storybook build CLI 命令设置 -c 标志来更改 Storybook 使用的文件夹。

配置您的 Storybook 项目

Storybook 的主要配置（即 main.js|ts 文件）定义了 Storybook 项目的行为，包括 stories 的位置、您使用的插件、功能标志以及其他项目特定设置。此文件应位于项目根目录下的 .storybook 文件夹中。您可以使用 JavaScript 或 TypeScript 编写此文件。下面列出了可用的选项及其使用示例。

.storybook/main.ts

// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.
import type { StorybookConfig } from '@storybook/your-framework';
 
const config: StorybookConfig = {
  // Required
  framework: '@storybook/your-framework',
  stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],
  // Optional
  addons: ['@storybook/addon-docs'],
  docs: {
    autodocs: 'tag',
  },
  staticDirs: ['../public'],
};
 
export default config;

此配置文件是一个预设，因此具有强大的接口，可以进一步自定义。阅读我们关于编写预设的文档以了解更多信息。

配置元素	描述
`stories`	表示 story 文件位置的 glob 模式数组，相对于 `main.js`
`staticDirs`	设置 Storybook 加载的静态文件目录列表 `staticDirs: ['../public']`
`addons`	设置 Storybook 加载的插件列表 `addons: ['@storybook/addon-docs']`
`typescript`	配置 Storybook 如何处理TypeScript 文件 `typescript: { check: false, checkOptions: {} }`
`framework`	根据一组框架特定设置配置 Storybook `framework: { name: '@storybook/svelte-vite', options:{} }`
`core`	配置 Storybook 的内部功能 `core: { disableTelemetry: true, }`
`docs`	配置 Storybook 的自动生成文档 `docs: { autodocs: 'tag' }`
`features`	启用 Storybook 的附加功能请参阅下表获取可用功能的列表
`refs`	配置Storybook composition `refs: { example: { title: 'ExampleStorybook', url:'https://your-url.com' } }`
`logLevel`	配置 Storybook 在浏览器终端中的日志级别。对于调试很有用 `logLevel: 'debug'`
`webpackFinal`	自定义 Storybook 的Webpack 配置 `webpackFinal: async (config:any) => { return config; }`
`viteFinal`	使用vite builder时自定义 Storybook 的 Vite 配置 `viteFinal: async (config: Vite.InlineConfig, options: Options) => { return config; }`
`env`	定义自定义 Storybook 环境变量。 `env: (config) => ({...config, EXAMPLE_VAR: 'Example var' }),`
`build`	通过将特定功能从 bundle 中排除，优化 Storybook 生产构建的性能。当缩短构建时间是优先事项时很有用。 `build: { test: {} }`

配置 Story 加载

默认情况下，Storybook 会根据 .storybook/main.js|ts 中的 glob（模式匹配字符串）加载项目中的 stories，该 glob 匹配项目中所有扩展名为 .stories.* 的文件。目的是让 story 文件与其所文档化的组件位于同一位置。

•
└── components
    ├── Button.js
    └── Button.stories.js

如果您想使用不同的命名约定，可以使用 picomatch 支持的语法修改 glob。

例如，如果您想从 my-project/src/components 目录中提取 .md 和 .js 文件，您可以这样写：

.storybook/main.ts

// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.
import type { StorybookConfig } from '@storybook/your-framework';
 
const config: StorybookConfig = {
  framework: '@storybook/your-framework',
  stories: ['../my-project/src/components/*.@(js|md)'],
};
 
export default config;

使用配置对象

此外，您还可以自定义 Storybook 配置以根据配置对象加载您的 stories。例如，如果您想从 packages/components 目录加载 stories，可以将 stories 配置字段调整如下：

.storybook/main.ts

// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.
import type { StorybookConfig } from '@storybook/your-framework';
 
const config: StorybookConfig = {
  framework: '@storybook/your-framework',
  stories: [
    {
      // 👇 Sets the directory containing your stories
      directory: '../packages/components',
      // 👇 Storybook will load all files that match this glob
      files: '*.stories.*',
      // 👇 Used when generating automatic titles for your stories
      titlePrefix: 'MyComponents',
    },
  ],
};
 
export default config;

当 Storybook 启动时，它将在 packages/components 目录中查找任何包含 stories 扩展名的文件，并为您的 stories 生成标题。

使用目录

您还可以简化 Storybook 配置并使用目录加载 stories。例如，如果您想加载 packages/MyStories 中的所有 stories，您可以如下调整配置：

.storybook/main.ts

// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.
import type { StorybookConfig } from '@storybook/your-framework';
 
const config: StorybookConfig = {
  framework: '@storybook/your-framework',
  // 👇 Storybook will load all existing stories within the MyStories folder
  stories: ['../packages/MyStories'],
};
 
export default config;

使用自定义实现

您还可以调整 Storybook 配置并实现自定义逻辑来加载您的 stories。例如，假设您正在处理一个包含特定模式的项目，而常规加载 stories 的方式无法解决该问题。在这种情况下，您可以如下调整配置：

.storybook/main.ts

// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.
import type { StorybookConfig } from '@storybook/your-framework';
import type { StoriesEntry } from 'storybook/internal/types';
 
async function findStories(): Promise<StoriesEntry[]> {
  // your custom logic returns a list of files
}
 
const config: StorybookConfig = {
  framework: '@storybook/your-framework',
  stories: async (list: StoriesEntry[]) => [
    ...list,
    // 👇 Add your found stories to the existing list of story files
    ...(await findStories()),
  ],
};
 
export default config;

已知限制

由于 Storybook 当前索引 stories 的方式，按需加载 stories 目前存在一些小的限制：

CSF 格式从版本 1 到版本 3 都支持。
允许基于受限 API 的自定义 storySort 函数。

配置 Story 渲染

要控制 stories 的渲染方式并添加全局装饰器和参数，请创建 .storybook/preview.js 文件。此文件加载到 Canvas UI 中，即渲染您的组件的“预览”iframe 中。使用 preview.js 来放置适用于所有 stories 的全局代码（例如CSS 导入或 JavaScript mocks）。

此 preview.js 文件可以是 ES 模块，并导出以下键：

decorators - 全局装饰器数组
parameters - 全局参数对象
globalTypes - globalTypes 的定义

如果您想改变 stories 的排序方式，请阅读关于排序 stories 的内容。

配置 Storybook 的用户界面

要控制 Storybook UI（“manager” 部分）的行为，您可以创建一个 .storybook/manager.js 文件。

此文件没有特定的 API，但用于设置UI 选项和配置 Storybook 的主题。