SuperAPI AI 工具集

storybook

设计与创作

查看项目

更新于 10-16 00:29

技能介绍

用途:Storybook 是构建、记录和测试 UI 组件的隔离工作台,适合开发组件库、编写设计系统文档,并在不依赖完整应用的情况下调试组件状态。

主要能力:以 stories 描述组件的各种状态;通过 argTypes 与 Controls 交互式调整 props;支持 autodocs 自动生成文档,也可用 MDX 手写文档;内置 addon-essentials(Controls、Actions、Docs、Viewport、Backgrounds、Toolbars、Measure、Outline);可加装 a11y 无障碍检查、interactions 交互测试、test-runner 与 Chromatic 视觉测试;支持 play 函数做交互断言、loaders 加载异步数据、decorators 包裹上下文。

使用方式:在已有项目执行 npx storybook@latest init 安装,npm run storybook 启动。配置位于 .storybook/main.ts(stories、addons、framework、docs、staticDirs、typescript)与 .storybook/preview.ts(parameters、decorators、globalTypes)。组件目录通常放置 Button.tsx、Button.stories.tsx 等文件。构建静态站点用 npm run build-storybook,输出到 storybook-static/。测试可执行 npx test-storybook,或配合 Vitest 的 composeStories 复用 stories。

适用场景:组件库与设计系统开发、UI 状态与边界情况展示、交互与无障碍验证、视觉回归测试、组件文档发布。

限制:资料未提供具体收费、价格、平台支持范围与效果数据;部分能力依赖额外安装的 addon 或第三方服务(如 Chromatic 需 project-token)。