storybookjs/storybook · 中文介绍

storybookjs/storybook

★ 91,638 · Forks 10,598

一句话理解

Storybook 把界面组件或页面放到独立的预览环境里,让开发、文档和测试围绕同一组可查看的示例展开。

它解决什么问题

检查一个组件时,如果每次都要先进入应用、找到页面,再触发某个状态,复查同一个问题就要重走一遍操作。Storybook 把观察范围缩到选定的组件或页面。第一次试用可以用一个具体标准衡量是否成功:打开一个示例就能看到目标状态,另一位同事打开同一个示例,也知道该观察哪部分布局或交互。

从输入到输出

从输入到输出可以分四步。第一步,按组件采用的前端框架选择对应的接入方式,因为预览环境需要能渲染该框架的组件。第二步,为组件准备一个具体示例,把想看的内容和状态固定下来,打开示例就能回到相同的观察起点。第三步,在独立预览中查看渲染结果。如果预览环境缺少组件实际依赖的样式,看到的布局就可能与应用里的布局不同。第四步,按检查目标选扩展,例如用视口工具改变显示尺寸、用操作日志查看交互,或为组件补充文档。若所选框架缺少相应扩展支持,就要调整检查方式。

用一个小任务理解

理解示例(未实测):假设你在做一张商品卡片,需要检查图片、商品名和价格在不同宽度下如何排列。先用一张固定图片、商品名“帆布旅行包”和价格“129 元”做一个示例,并为这张卡片约定宽屏时图片在左、文字在右,窄屏时图片在上、文字在下。打开示例,把预览宽度设为 900 像素。按这个设想,预期会看到两栏布局,商品名和价格都完整显示。记下此时的宽度和排列,供下一步对照。

改变一个条件会怎样

预测与验证(待检验):沿用商品卡片示例,只把预览宽度从 900 像素调到 360 像素。若卡片的样式在这两个宽度之间切换排版,预期图片和文字会从左右排列变成上下排列。验证时在同一个示例里来回切换这两个宽度,分别记录排列方向,并检查商品名和价格是否被裁切。如果两次排列相同,可以先确认实际预览宽度,再检查卡片样式的生效条件。

适合谁,哪里会失效

根据资料推断:这种工作方式适合维护组件库、开发可复用界面,或需要逐个核对页面状态的前端团队。若问题只在真实页面的外层容器、路由切换或后端响应参与时出现,独立示例能覆盖多少,取决于它重现了哪些条件。要判断用户能否完成整条业务流程,还需在应用环境中走一遍。仓库列出了框架和扩展入口,具体项目能使用哪些功能,要结合对应的支持表确认。

第一次尝试时看什么

根据资料推断:先打开与你项目框架对应的演示,找一个可以观察布局变化的组件。也可以通过仓库提供的 StackBlitz 入口创建示例项目。练习时先选一个依赖少的组件,固定一组内容,按上面的办法记录两个宽度下的表现。准备接入已有项目时,再查官方文档里的框架入门说明和扩展支持表,确认要用的功能有对应指引。

Kai 的头像

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注