该技能用于为 Canvas 组件创建 Storybook 故事文件,适用于以下场景:创建需要故事的新组件、添加或修改组件故事等。
核心要求
每个组件都必须拥有独立的 story 文件。src/components/ 中的每个组件都需要在 src/stories/ 中有一个对应的 story 文件。该 story 文件必须满足:
- 命名为 <component-name>.stories.jsx(kebab-case,使用连字符)
- 从 @/components/<component-name> 导入组件
- 展示组件的 props 与变体
示例结构
src/components/my-card/ ├── index.jsx └── component.yml
src/stories/my-card.stories.jsx # my-card 组件必需的 story 文件
命名映射
组件与 story 的命名使用以下规范映射:
- component.yml machineName:my-card
- 组件文件夹:src/components/my-card/
- 组件导入:@/components/my-card
- Story 文件:src/stories/my-card.stories.jsx
Story 文件要求
- 使用 Storybook CSF3 格式(基于对象的故事)。
- 为带预定义选项(如枚举)的 props 添加 argTypes。
- 创建多个 story 导出,以展示不同变体。
- 当组件需要特定背景(例如浅色组件需要深色背景)时,使用 decorators。
验证方式
创建组件后,验证 story 文件是否存在:
列出所有 story 文件
ls src/stories/*.stories.jsx
验证某个组件是否有对应 story
ls src/stories/<component-name>.stories.jsx
限制与补充说明
资料未提供该技能的安装方式、收费模式、支持平台或具体运行环境要求,这些信息暂未提供。