组件故事格式 (CSF)

CSF 3CSF 工厂 (实验性)

观看视频教程

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

如果您有使用旧的 storiesOf() 语法编写的故事，它已在 Storybook 8.0 中移除，并且不再维护。我们建议将您的故事迁移到 CSF。请参阅迁移指南以获取更多信息。

在 CSF 中，故事和组件元数据被定义为 ES 模块。每个组件故事文件都包含一个必需的默认导出和一个或多个命名导出。

默认导出

默认导出定义了关于您的组件的元数据，包括 component 本身，其 title（它将显示在导航 UI 故事层级结构中的位置），装饰器和参数。

component 字段是必需的，供插件用于自动生成属性表和显示其他组件元数据。title 字段是可选的，并且应该是唯一的（即，不要在文件中重复使用）。

MyComponent.stories.ts|tsx

// Replace your-framework with the name of your framework
import type { Meta } from '@storybook/your-framework';
 
import { MyComponent } from './MyComponent';
 
const meta: Meta<typeof MyComponent> = {
  /* 👇 The title prop is optional.
   * See https://storybook.org.cn/docs/configure/#configure-story-loading
   * to learn how to generate automatic titles
   */
  title: 'Path/To/MyComponent',
  component: MyComponent,
  decorators: [/* ... */],
  parameters: {/* ... */},
};
 
export default meta;

有关更多示例，请参阅编写故事。

命名故事导出

使用 CSF，文件中的每个命名导出默认表示一个故事对象。

MyComponent.stories.ts|tsx

import type { Meta, StoryObj } from '@storybook/react';
 
import { MyComponent } from './MyComponent';
 
const meta: Meta<typeof MyComponent> = {
  component: MyComponent,
};
 
export default meta;
type Story = StoryObj<typeof MyComponent>;
 
export const Basic: Story = {};
 
export const WithProp: Story = {
  render: () => <MyComponent prop="value" />,
};

导出的标识符将使用 Lodash 的 startCase 函数转换为 “首字母大写” 形式。例如

标识符	转换
name	Name
someName	Some Name
someNAME	Some NAME
some_custom_NAME	Some Custom NAME
someName1234	Some Name 1 2 3 4

我们建议所有导出名称都以大写字母开头。

故事对象可以使用一些不同的字段进行注释，以定义故事级别的装饰器和参数，并定义故事的 name。

Storybook 的 name 配置元素在特定情况下很有用。常见的用例是包含特殊字符或 Javascript 保留字的名称。如果未指定，Storybook 默认使用命名导出。

MyComponent.stories.ts|tsx

// Replace your-framework with the name of your framework
import type { Meta, StoryObj } from '@storybook/your-framework';
 
import { MyComponent } from './MyComponent';
 
const meta: Meta<typeof MyComponent> = {
  component: MyComponent,
};
 
export default meta;
type Story = StoryObj<typeof MyComponent>;
 
export const Simple: Story = {
  name: 'So simple!',
  // ...
};

Args 故事输入

从 SB 6.0 开始，故事接受名为 Args 的命名输入。Args 是由 Storybook 及其插件提供（并可能更新）的动态数据。

考虑 Storybook 的“Button” 示例，这是一个文本按钮，可以记录其点击事件

Button.stories.ts|tsx

import type { Meta, StoryObj } from '@storybook/react';
 
import { action } from '@storybook/addon-actions';
 
import { Button } from './Button';
 
const meta: Meta<typeof Button> = {
  component: Button,
};
 
export default meta;
type Story = StoryObj<typeof Button>;
 
export const Basic: Story = {
  render: () => <Button label="Hello" onClick={action('clicked')} />,
};

现在考虑相同的示例，用 args 重写

Button.stories.ts|tsx

import type { Meta, StoryObj } from '@storybook/react';
 
import { action } from '@storybook/addon-actions';
 
import { Button } from './Button';
 
const meta: Meta<typeof Button> = {
  component: Button,
};
 
export default meta;
type Story = StoryObj<typeof Button>;
 
export const Text = {
  args: {
    label: 'Hello',
    onClick: action('clicked'),
  },
  render: ({ label, onClick }) => <Button label={label} onClick={onClick} />,
};

甚至更简单

Button.stories.ts|tsx

import type { Meta, StoryObj } from '@storybook/react';
 
import { Button } from './Button';
 
const meta: Meta<typeof Button> = {
  component: Button,
};
 
export default meta;
type Story = StoryObj<typeof Button>;
 
export const Text: Story = {
  args: {},
};

这些版本不仅比非 args 版本更简短且更易于编写，而且也更具可移植性，因为代码不专门依赖 actions 插件。

有关设置文档和操作的更多信息，请参阅它们各自的文档。

Play 函数

Storybook 的 play 函数是在故事在 UI 中渲染时执行的小代码片段。它们是方便的辅助方法，可帮助您测试以前不可能或需要用户干预的用例。

play 函数的一个很好的用例是表单组件。在以前的 Storybook 版本中，您需要编写一组故事，并且必须与组件交互才能验证它。使用 Storybook 的 play 函数，您可以编写以下故事

LoginForm.stories.ts|tsx

import type { Meta, StoryObj } from '@storybook/react';
 
import { userEvent, within, expect } from '@storybook/test';
 
import { LoginForm } from './LoginForm';
 
const meta: Meta<typeof LoginForm> = {
  component: LoginForm,
};
 
export default meta;
type Story = StoryObj<typeof LoginForm>;
 
export const EmptyForm: Story = {};
 
/*
 * See https://storybook.org.cn/docs/writing-stories/play-function#working-with-the-canvas
 * to learn more about using the canvasElement to query the DOM
 */
export const FilledForm: Story = {
  play: async ({ canvasElement }) => {
    const canvas = within(canvasElement);
 
    // 👇 Simulate interactions with the component
    await userEvent.type(canvas.getByTestId('email'), 'email@provider.com');
 
    await userEvent.type(canvas.getByTestId('password'), 'a-random-password');
 
    // See https://storybook.org.cn/docs/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel
    await userEvent.click(canvas.getByRole('button'));
 
    // 👇 Assert DOM structure
    await expect(
      canvas.getByText(
        'Everything is perfect. Your account is ready and we should probably get you started!',
      ),
    ).toBeInTheDocument();
  },
};

当故事在 UI 中渲染时，Storybook 会执行 play 函数中定义的每个步骤，并在无需用户交互的情况下运行断言。

自定义渲染函数

从 Storybook 6.4 开始，您可以将故事编写为 JavaScript 对象，从而减少生成测试组件所需的样板代码，从而提高功能和可用性。Render 函数是帮助您额外控制故事渲染方式的有用方法。例如，如果您要将故事编写为对象，并且想要指定组件的渲染方式，则可以编写以下内容

MyComponent.stories.ts|tsx

import type { Meta, StoryObj } from '@storybook/react';
 
import { Layout } from './Layout';
 
import { MyComponent } from './MyComponent';
 
const meta: Meta<typeof MyComponent> = {
  component: MyComponent,
};
 
export default meta;
type Story = StoryObj<typeof MyComponent>;
 
// This story uses a render function to fully control how the component renders.
export const Example: Story = {
  render: () => (
    <Layout>
      <header>
        <h1>Example</h1>
      </header>
      <article>
        <MyComponent />
      </article>
    </Layout>
  ),
};

当 Storybook 加载此故事时，它将检测到 render 函数的存在，并根据定义调整组件渲染方式。

Storybook 导出 vs. 名称处理

Storybook 处理命名导出和 name 选项的方式略有不同。您应该在何时使用其中一个，而不是另一个？

Storybook 将始终使用命名导出确定故事 ID 和 URL。

如果您指定了 name 选项，它将用作 UI 中的故事显示名称。否则，它将默认为命名导出，通过 Storybook 的 storyNameFromExport 和 lodash.startCase 函数进行处理。

MyComponent-test.js

it('should format CSF exports with sensible defaults', () => {
  const testCases = {
    name: 'Name',
    someName: 'Some Name',
    someNAME: 'Some NAME',
    some_custom_NAME: 'Some Custom NAME',
    someName1234: 'Some Name 1234',
    someName1_2_3_4: 'Some Name 1 2 3 4',
  };
  Object.entries(testCases).forEach(([key, val]) => {
    expect(storyNameFromExport(key)).toBe(val);
  });
});

当您要更改故事的名称时，请重命名 CSF 导出。它将更改故事的名称，并且还会更改故事的 ID 和 URL。

在以下情况下，最好使用 name 配置元素

您希望名称以命名导出不可能的方式显示在 Storybook UI 中，例如，保留关键字（如 “default”）、特殊字符（如表情符号）、间距/大小写不是由 storyNameFromExport 提供的方式。
您希望将故事 ID 与更改其显示方式分开保存。拥有稳定的故事 ID 有助于与第三方工具集成。

非故事导出

在某些情况下，您可能希望导出故事和非故事的混合内容（例如，模拟数据）。

您可以使用默认导出中的可选配置字段 includeStories 和 excludeStories 使之成为可能。您可以将它们定义为字符串数组或正则表达式。

考虑以下故事文件

MyComponent.stories.ts|tsx

import type { Meta, StoryObj } from '@storybook/react';
 
import { MyComponent } from './MyComponent';
 
import someData from './data.json';
 
const meta: Meta<typeof MyComponent> = {
  component: MyComponent,
  includeStories: ['SimpleStory', 'ComplexStory'], // 👈 Storybook loads these stories
  excludeStories: /.*Data$/, // 👈 Storybook ignores anything that contains Data
};
 
export default meta;
type Story = StoryObj<typeof MyComponent>;
 
export const simpleData = { foo: 1, bar: 'baz' };
export const complexData = { foo: 1, foobar: { bar: 'baz', baz: someData } };
 
export const SimpleStory: Story = {
  args: {
    data: simpleData,
  },
};
 
export const ComplexStory: Story = {
  args: {
    data: complexData,
  },
};

当此文件在 Storybook 中渲染时，它将 ComplexStory 和 SimpleStory 视为故事，并忽略 data 命名导出。

对于这个特定示例，您可以根据方便程度，通过不同的方式实现相同的结果

includeStories: /^[A-Z]/
includeStories: /.*Story$/
includeStories: ['SimpleStory', 'ComplexStory']
excludeStories: /^[a-z]/
excludeStories: /.*Data$/
excludeStories: ['simpleData', 'complexData']

如果您遵循以大写字母开始故事导出的最佳实践（即，使用 UpperCamelCase），则第一个选项是推荐的解决方案。

从 CSF 2 升级到 CSF 3

在 CSF 2 中，命名导出始终是实例化组件的函数，并且这些函数可以使用配置选项进行注释。例如

CSF 2 - Button.stories.ts|tsx

import { ComponentStory, ComponentMeta } from '@storybook/react';
 
import { Button } from './Button';
 
export default {
  title: 'Button',
  component: Button,
} as ComponentMeta<typeof Button>;
 
export const Primary: ComponentStory<typeof Button> = (args) => <Button {...args} />;
Primary.args = { primary: true };

这为 Button 声明了一个 Primary 故事，该故事通过将 { primary: true } 展开到组件中来渲染自身。default.title 元数据说明了故事在导航层级结构中的位置。

这是 CSF 3 等效项

CSF 3 - Button.stories.ts|tsx

import type { Meta, StoryObj } from '@storybook/react';
 
import { Button } from './Button';
 
const meta: Meta<typeof Button> = { component: Button };
 
export default meta;
type Story = StoryObj<typeof Button>;
 
export const Primary: Story = { args: { primary: true } };

让我们逐个了解更改，以了解发生了什么。

可展开的故事对象

在 CSF 3 中，命名导出是对象，而不是函数。这使我们能够通过 JS 扩展运算符更有效地重用故事。

考虑向介绍示例添加以下内容，这将创建一个针对深色背景渲染的 PrimaryOnDark 故事

这是 CSF 2 实现

CSF 2 - Button.stories.js|jsx|ts|tsx

export const PrimaryOnDark = Primary.bind({});
PrimaryOnDark.args = Primary.args;
PrimaryOnDark.parameters = { background: { default: 'dark' } };

Primary.bind({}) 复制了故事函数，但它不会复制挂在函数上的注释，因此我们必须添加 PrimaryOnDark.args = Primary.args 以继承 args。

在 CSF 3 中，我们可以展开 Primary 对象以继承其所有注释

CSF 3 - Button.stories.ts|tsx

export const PrimaryOnDark: Story = {
  ...Primary,
  parameters: { background: { default: 'dark' } },
};

了解有关命名故事导出的更多信息。

默认渲染函数

在 CSF 3 中，您可以通过 render 函数指定故事的渲染方式。我们可以通过以下步骤将 CSF 2 示例重写为 CSF 3。

让我们从一个简单的 CSF 2 故事函数开始

CSF 2 - Button.stories.ts|tsx

// Other imports and story implementation
export const Default: ComponentStory<typeof Button> = (args) => <Button {...args} />;

现在，让我们在 CSF 3 中将其重写为故事对象，并使用显式的 render 函数来告知故事如何渲染自身。与 CSF 2 类似，这使我们可以完全控制组件甚至组件集合的渲染方式。

CSF 3 - Button.stories.ts|tsx

// Other imports and story implementation
export const Default: Story = {
  render: (args) => <Button {...args} />,
};

了解有关渲染函数的更多信息。

但是在 CSF 2 中，许多故事函数都是相同的：获取默认导出中指定的组件并将 args 展开到其中。这些故事的有趣之处不是函数，而是传递给函数的 args。

CSF 3 为每个渲染器提供默认渲染函数。如果您所做的只是将 args 展开到组件中（这是最常见的情况），则根本不需要指定任何 render 函数

CSF 3 - Button.stories.js|jsx|ts|tsx

export const Default = {};

有关更多信息，请参阅有关自定义渲染函数的部分。

自动生成标题

最后，CSF 3 可以自动生成标题。

CSF 2 - Button.stories.js|jsx|ts|tsx

export default {
  title: 'components/Button',
  component: Button,
};

CSF 3 - Button.stories.js|jsx|ts|tsx

export default { component: Button };

您仍然可以像在 CSF 2 中一样指定标题，但是如果您不指定标题，则可以从故事在磁盘上的路径推断出来。有关更多信息，请参阅有关配置故事加载的部分。