Storybook/react中ComponentStory、ComponentMeta的作用及能否省略?
Storybook 类型相关问题解答
1. ComponentMeta 与 ComponentStory 的实际能力
ComponentMeta<typeof Button>是给默认导出的Storybook配置对象做类型约束的工具泛型:- 自动校验
title/component/argTypes等配置字段的合法性,配置错误会直接触发TS报错 - 自动关联绑定组件的Props类型,后续所有story的参数都会继承这个类型提示,不需要重复声明组件Props
- 自动校验
ComponentStory<typeof Button>是给故事模板做类型标注的工具泛型:- 自动推导绑定组件的入参类型,模板函数的入参不需要手动标注
Props也能拿到正确的类型校验 - 给模板函数扩展
.args/.argTypes/.parameters等Storybook专属属性的类型定义,你不加这个类型的时候TS提示不存在.args属性,就是因为普通JS函数本身没有这些属性的类型声明
- 自动推导绑定组件的入参类型,模板函数的入参不需要手动标注
2. 简化写法与省略可行性
关于typeof Button的作用
TS的类型空间和运行时值空间是完全隔离的,Button是运行时的组件对象,typeof Button是取这个组件对应的TS类型,这样Storybook的泛型工具才能自动从组件类型里提取Props定义,不需要你手动传入Props泛型,并不算冗余。
更简洁的官方推荐写法
Storybook 6.5+ 版本推出了无模板的简化写法,不需要写Template和bind逻辑,模板代码量大幅减少:
import React from 'react'; import type { Meta, StoryObj } from '@storybook/react'; import Button from 'components/Button'; const meta: Meta<typeof Button> = { title: 'UI/Button', component: Button, argTypes: {}, }; export default meta; type Story = StoryObj<typeof Button>; export const Primary: Story = { args: { children: 'Button', }, };
如果你已经导出了Button的Props类型,也可以直接把泛型参数换成Props,效果完全一致:Meta<Props>、StoryObj<Props>。
能否完全省略类型?
如果省略类型标注,你会丢失所有Storybook相关的类型校验:写错配置字段、写错args里的属性TS都不会提示,运行时才会暴露问题,不建议这么做。
内容的提问来源于stack exchange,提问作者Andrii Radkevych
相关产品推荐
相关产品推荐

