参数

观看视频教程

参数是一组关于 story 的静态、命名元数据，通常用于控制 Storybook 功能和插件的行为。

可用参数在参数 API 参考中列出。

例如，让我们通过参数自定义 backgrounds 插件。我们将使用 parameters.backgrounds 来定义当选择 story 时，背景工具栏中出现的背景。

Story 参数

我们可以使用 CSF 导出上的 parameters 键为单个 story 设置参数

Button.stories.ts|tsx

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

组件参数

我们可以使用默认 CSF 导出上的 parameters 键为组件的所有 stories 设置参数

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;

全局参数

我们还可以通过 .storybook/preview.js|ts 文件的 parameters 导出设置所有 stories 的参数（这是您配置所有 stories 的文件）

.storybook/preview.ts

// Replace your-renderer with the renderer you are using (e.g., react, vue3)
import { Preview } from '@storybook/your-renderer';
 
const preview: Preview = {
  parameters: {
    backgrounds: {
      values: [
        { name: 'light', value: '#fff' },
        { name: 'dark', value: '#333' },
      ],
    },
  },
};
 
export default preview;

设置全局参数是配置插件的常用方法。对于 backgrounds，您可以配置每个 story 可以渲染的背景列表。

参数继承规则

全局、组件和 story 参数的组合方式是

更具体的参数优先（因此 story 参数会覆盖组件参数，而组件参数又会覆盖全局参数）。
参数是合并的，因此键仅被覆盖，而永远不会被删除。

参数的合并非常重要。这意味着可以在保留全局定义的大部分参数的同时，在每个 story 的基础上覆盖单个特定的子参数。

如果您正在定义依赖于参数的 API（例如，一个插件），最好将此行为考虑在内。