useOf

Storybook 提供的默认块并不适用于所有用例，因此您可能需要编写自己的块。

如果您的自定义文档块需要与 Storybook 的注解（即 stories、meta 或 components）进行交互，您可以使用 useOf hook。传入一个 stories、meta 或 component 的模块导出，它将返回其注解后的形式（应用了参数、args、loaders、decorators、play 函数），您可以将其用于任何您喜欢的用途。事实上，大多数现有的块，如 Description 和 Canvas，在底层都使用了 useOf。

以下是一个示例，说明如何使用 useOf hook 来创建一个显示 story 名称的自定义块。

import { useOf } from '@storybook/addon-docs/blocks';
 
/**
 * A block that displays the story name or title from the of prop
 * - if a story reference is passed, it renders the story name
 * - if a meta reference is passed, it renders the stories' title
 * - if nothing is passed, it defaults to the primary story
 */
export const StoryName = ({ of }) => {
  const resolvedOf = useOf(of || 'story', ['story', 'meta']);
  switch (resolvedOf.type) {
    case 'story': {
      return <h1>{resolvedOf.story.name}</h1>;
    }
    case 'meta': {
      return <h1>{resolvedOf.preparedMeta.title}</h1>;
    }
  }
  return null;
};

import { Meta } from '@storybook/addon-docs/blocks';
import { StoryName } from '../.storybook/blocks/StoryName';
import * as ButtonStories from './Button.stories';
 
<Meta of={ButtonStories} />
 
{/* Renders "Secondary" */}
<StoryName of={ButtonStories.Secondary} />
 
{/* Renders "Primary" */}
<StoryName />
 
{/* Renders "Button" */}
<StoryName of={ButtonStories} />

useOf

Type

(
  moduleExportOrType: ModuleExport | 'story' | 'meta' | 'component',
  validTypes?: Array<'story' | 'meta' | 'component'>
) => EnhancedResolvedModuleExportType

参数

moduleExportOrType

(必需)

类型：ModuleExport | 'story' | 'meta' | 'component'

提供 stories 导出、meta 导出、component 导出或 CSF 文件导出，从中获取注解。

当自定义块位于已附加文档中时，还可以通过传入字符串来获取主（第一个）story、meta 或 component。这对于回退很有用，因此您的块中可以省略 of prop。最常见的模式是将其用作 useOf(props.of || 'story')，如果未定义 of prop，它将回退到主 story。

• useOf('story') 在已附加模式下返回注解后的主 story；在未附加模式下出错
• useOf('meta') 在已附加模式下返回注解后的 meta；在未附加模式下出错
• useOf('component') 在已附加模式下返回 meta 中指定的注解后的 component；在未附加模式下出错

validTypes

类型：Array<'story' | 'meta' | 'component'>

可选地指定一个您接受的类型数组。传入无效类型将导致错误。例如，Canvas 块使用 useOf(of, ['story'])，这确保它只接受对 story 的引用，而不是 meta 或 component。

Return

返回值取决于匹配的类型

EnhancedResolvedModuleExportType['type'] === 'story'

类型：{ type: 'story', story: PreparedStory }

对于 stories，注解后的 stories 将按原样返回。它们已经过准备，意味着它们已与项目和 meta 注解合并。

EnhancedResolvedModuleExportType['type'] === 'meta'

类型：{ type: 'meta', csfFile: CSFFile, preparedMeta: PreparedMeta }

对于 meta，返回已解析的 CSF 文件以及准备好的注解后的 meta。也就是说，项目注解与 meta 注解合并，但不包含 story 注解。

EnhancedResolvedModuleExportType['type'] === 'component'

类型：{ type: 'component', component: Component, projectAnnotations: NormalizedProjectAnnotations }

对于 components，将返回 component 以及项目注解；不包含 meta 或 story 注解。

请注意，hook 经常无法确定传递的是 component 还是任何其他对象，因此它也表现得像一个 unknown 类型。