插件
Storybook 拥有强大的插件生态系统,你可以使用它们来增强团队中每个人的开发者体验。在此处查看所有插件。
如果你一直在学习本教程,你已经遇到过多个插件,并在测试章节中设置了一个。
插件适用于各种可能的用例,要写完所有插件需要很长时间。让我们集成最流行的插件之一:Controls。
什么是 Controls?
Controls 允许设计师和开发者通过摆弄组件的参数来轻松探索组件行为。无需代码。Controls 在你的 stories 旁边创建一个插件面板,以便你可以实时编辑它们的参数。
全新安装的 Storybook 默认包含 Controls 插件。无需额外配置。
插件解锁新的 Storybook 工作流程
Storybook 是一个出色的组件驱动开发环境。Controls 插件将 Storybook 演变为一个交互式文档工具。
使用 Controls 查找极端情况
通过 Controls,QA 工程师、UI 工程师或任何其他利益干系人都可以将组件推向极限!考虑到以下示例,如果我们为 Task
添加一个超长字符串会发生什么?
这不对!看起来文本溢出了 Task 组件的边界。
Controls 使我们能够快速验证组件的不同输入(在本例中是一个长字符串),并减少了发现 UI 问题所需的工作。
现在让我们通过向 task.component
添加样式来解决溢出问题
@Component({
selector: 'app-task',
standalone: false,
template: `
<div class="list-item {{ task?.state }}">
<label
[attr.aria-label]="'archiveTask-' + task?.id"
for="checked-{{ task?.id }}"
class="checkbox"
>
<input
type="checkbox"
disabled="true"
[defaultChecked]="task?.state === 'TASK_ARCHIVED'"
name="checked-{{ task?.id }}"
id="checked-{{ task?.id }}"
/>
<span class="checkbox-custom" (click)="onArchive(task?.id)"></span>
</label>
<label
[attr.aria-label]="task?.title + ''"
for="title-{{ task?.id }}"
class="title"
>
<input
type="text"
[value]="task?.title"
readonly="true"
id="title-{{ task?.id }}"
name="title-{{ task?.id }}"
placeholder="Input title"
+ style="text-overflow: ellipsis;"
/>
</label>
<button
*ngIf="task?.state !== 'TASK_ARCHIVED'"
class="pin-button"
[attr.aria-label]="'pinTask-' + task?.id"
(click)="onPin(task?.id)"
>
<span class="icon-star"></span>
</button>
</div>
`,
})
问题已解决!现在,当文本到达 Task 区域的边界时,会使用漂亮的省略号进行截断。
添加新的 story 以避免回归
在未来,我们可以通过 Controls 手动输入相同的字符串来重现此问题。但编写一个 story 来展示这个极端情况更容易。这扩大了我们的回归测试覆盖范围,并为团队的其他成员清晰地概述了组件的限制。
在 `task.stories.ts` 中为长文本情况添加一个新的 story
const longTitleString = `This task's name is absurdly large. In fact, I think if I keep going I might end up with content overflow. What will happen? The star that represents a pinned task could have text overlapping. The text could cut-off abruptly when it reaches the star. I hope not!`;
export const LongTitle: Story = {
args: {
task: {
...Default.args?.task,
title: longTitleString,
},
},
};
现在我们可以轻松地重现和处理这个极端情况。
如果我们正在进行可视化测试,如果截断解决方案出现问题,我们也会得到通知。如果没有测试覆盖,极端情况很容易被遗忘!
💡 Controls 是让非开发人员使用你的组件和 stories 的绝佳方式。它比我们在这里看到的要强大得多;我们建议阅读官方文档以了解更多信息。但是,你可以通过插件以更多方式自定义 Storybook 以适应你的工作流程。在创建插件指南中,我们将教你如何创建一个插件来增强你的开发工作流程。
合并更改
不要忘记使用 git 合并你的更改!