如何编写故事

观看视频教程

故事捕获 UI 组件的渲染状态。它是一个带有注释的对象，用于描述组件在给定一组参数下的行为和外观。

Storybook 在讨论 React 的 props、Vue 的 props、Angular 的 @Input 和其他类似概念时，使用通用术语参数（args 简称）。

故事放在哪里

组件的故事在故事文件中定义，该文件与组件文件位于同一位置。故事文件仅用于开发，不会包含在您的生产包中。在您的文件系统中，它看起来像这样

components/
├─ Button/
│  ├─ Button.js | ts | jsx | tsx | vue | svelte
│  ├─ Button.stories.js | ts | jsx | tsx | svelte

组件故事格式

我们根据组件故事格式 (CSF) 定义故事，CSF 是一种基于 ES6 模块的标准，易于编写且可在工具之间移植。

关键要素是描述组件的默认导出，以及描述故事的命名导出。

默认导出

默认导出元数据控制 Storybook 如何列出您的故事，并提供插件使用的信息。例如，以下是故事文件 Button.stories.js|ts 的默认导出

Button.stories.ts|tsx

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

从 Storybook 7.0 版本开始，故事标题在构建过程中会进行静态分析。默认导出必须包含一个可以静态读取的 title 属性，或者一个可以从中计算自动标题的 component 属性。使用 id 属性自定义您的故事 URL 也必须是静态可读的。

定义故事

使用 CSF 文件的命名导出定义组件的故事。我们建议您对故事导出使用 UpperCamelCase。以下是如何在“primary”状态下渲染 Button 并导出一个名为 Primary 的故事。

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,
    label: 'Button',
  },
};

使用 React Hooks

React Hooks 是便捷的辅助方法，可以使用更简化的方法创建组件。如果您需要，可以在创建组件的故事时使用它们，尽管您应该将它们视为高级用例。我们建议在编写自己的故事时尽可能多地使用 args。例如，这是一个使用 React Hooks 更改按钮状态的故事

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>;
 
/*
 *👇 Render functions are a framework specific feature to allow you control on how the component renders.
 * See https://storybook.org.cn/docs/api/csf
 * to learn how to use render functions.
 */
export const Primary: Story = {
  render: () => <Button primary label="Button" />,
};

重命名故事

您可以重命名您需要的任何特定故事。例如，为了给它一个更准确的名称。以下是如何更改 Primary 故事的名称

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 = {
  // 👇 Rename this story
  name: 'I am the primary',
  args: {
    label: 'Button',
    primary: true,
  },
};

您的故事现在将以给定的文本显示在侧边栏中。

如何编写故事

故事是一个描述如何渲染组件的对象。您可以为每个组件编写多个故事，这些故事可以相互构建。例如，我们可以基于上面的 Primary 故事添加 Secondary 和 Tertiary 故事。

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: {
    backgroundColor: '#ff0',
    label: 'Button',
  },
};
 
export const Secondary: Story = {
  args: {
    ...Primary.args,
    label: '😄👍😍💯',
  },
};
 
export const Tertiary: Story = {
  args: {
    ...Primary.args,
    label: '📚📕📈🤓',
  },
};

更重要的是，您可以导入 args 以在为其他组件编写故事时重复使用，这在构建复合组件时很有帮助。例如，如果我们创建一个 ButtonGroup 故事，我们可能会从其子组件 Button 中混合两个故事。

ButtonGroup.stories.ts|tsx

import type { Meta, StoryObj } from '@storybook/react';
 
import { ButtonGroup } from '../ButtonGroup';
 
//👇 Imports the Button stories
import * as ButtonStories from './Button.stories';
 
const meta: Meta<typeof ButtonGroup> = {
  component: ButtonGroup,
};
 
export default meta;
type Story = StoryObj<typeof ButtonGroup>;
 
export const Pair: Story = {
  args: {
    buttons: [{ ...ButtonStories.Primary.args }, { ...ButtonStories.Secondary.args }],
    orientation: 'horizontal',
  },
};

当 Button 的签名更改时，您只需更改 Button 的故事以反映新模式，ButtonGroup 的故事将自动更新。这种模式允许您在组件层次结构中重用数据定义，使您的故事更易于维护。

不仅如此！故事函数中的每个 args 都可以使用 Storybook 的 Controls 面板进行实时编辑。这意味着您的团队可以在 Storybook 中动态更改组件，以进行压力测试并查找极端情况。

您还可以使用 Controls 面板在调整其控件值后编辑或保存新故事。

插件可以增强 args。例如，Actions 会自动检测哪些 args 是回调，并将日志记录功能附加到它们。这样，交互（如单击）将被记录在 actions 面板中。

使用 play 函数

Storybook 的 play 函数和 @storybook/addon-interactions 是便捷的辅助方法，用于测试组件场景，否则这些场景需要用户干预。它们是小段代码，在您的故事渲染后执行一次。例如，假设您想验证表单组件，您可以编写以下故事，使用 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();
  },
};

如果没有 play 函数和 @storybook/addon-interactions 的帮助，您必须编写自己的故事并手动与组件交互，以测试每种可能的用例场景。

使用参数

参数是 Storybook 定义故事静态元数据的方法。故事的参数可用于在故事或故事组级别为各种插件提供配置。

例如，假设您想针对与应用程序中其他组件不同的一组背景测试 Button 组件。您可以添加组件级别的 backgrounds 参数

Button.stories.ts|tsx

// Replace your-framework with the framework you are using (e.g., react-webpack5, vue3-vite)
import type { Meta } from '@storybook/your-framework';
 
import { Button } from './Button';
 
const meta: Meta<typeof Button> = {
  component: Button,
  //👇 Creates specific parameters at the component level
  parameters: {
    backgrounds: {
      default: 'dark',
    },
  },
};
 
export default meta;

Parameters background color

此参数将指示 backgrounds 插件在选择 Button 故事时重新配置自身。大多数插件通过基于参数的 API 进行配置，并且可以在全局、组件和故事级别受到影响。

使用装饰器

装饰器是一种在渲染故事时将组件包装在任意标记中的机制。组件通常在创建时会假设它们在“哪里”渲染。您的样式可能需要主题或布局包装器，或者您的 UI 可能需要特定的上下文或数据提供程序。

一个简单的示例是向组件的故事添加内边距。使用装饰器来实现此目的，该装饰器将故事包装在一个带有内边距的 div 中，如下所示

Button.stories.ts|tsx

import type { Meta, StoryObj } from '@storybook/react';
 
import { Button } from './Button';
 
const meta: Meta<typeof Button> = {
  component: Button,
  decorators: [
    (Story) => (
      <div style={{ margin: '3em' }}>
        {/* 👇 Decorators in Storybook also accept a function. Replace <Story/> with Story() to enable it  */}
        <Story />
      </div>
    ),
  ],
};
 
export default meta;

装饰器可能更复杂，并且通常由插件提供。您还可以在故事、组件和全局级别配置装饰器。

两个或多个组件的故事

有时您可能有两个或多个组件被创建为协同工作。例如，如果您有一个父 List 组件，它可能需要子 ListItem 组件。

List.stories.ts|tsx

import type { Meta, StoryObj } from '@storybook/react';
 
import { List } from './List';
 
const meta: Meta<typeof List> = {
  component: List,
};
 
export default meta;
type Story = StoryObj<typeof List>;
 
// Always an empty list, not super interesting
export const Empty: Story = {};

在这种情况下，为每个故事渲染不同的函数是有意义的

List.stories.ts|tsx

import type { Meta, StoryObj } from '@storybook/react';
 
import { List } from './List';
import { ListItem } from './ListItem';
 
const meta: Meta<typeof List> = {
  component: List,
};
 
export default meta;
type Story = StoryObj<typeof List>;
 
export const Empty: Story = {};
 
/*
 *👇 Render functions are a framework specific feature to allow you control on how the component renders.
 * See https://storybook.org.cn/docs/api/csf
 * to learn how to use render functions.
 */
export const OneItem: Story = {
  render: (args) => (
    <List {...args}>
      <ListItem />
    </List>
  ),
};
 
export const ManyItems: Story = {
  render: (args) => (
    <List {...args}>
      <ListItem />
      <ListItem />
      <ListItem />
    </List>
  ),
};

您还可以在 List 组件中重用来自子 ListItem 的故事数据。这更容易维护，因为您不必在多个位置更新它。

List.stories.ts|tsx

import type { Meta, StoryObj } from '@storybook/react';
 
import { List } from './List';
import { ListItem } from './ListItem';
 
//👇 We're importing the necessary stories from ListItem
import { Selected, Unselected } from './ListItem.stories';
 
const meta: Meta<typeof List> = {
  component: List,
};
 
export default meta;
type Story = StoryObj<typeof List>;
 
export const ManyItems: Story = {
  render: (args) => (
    <List {...args}>
      <ListItem {...Selected.args} />
      <ListItem {...Unselected.args} />
      <ListItem {...Unselected.args} />
    </List>
  ),
};

请注意，像这样编写故事存在缺点，因为您无法充分利用 args 机制，也无法在构建更复杂的复合组件时组合 args。有关更多讨论，请参阅多组件故事工作流程文档。