返回到Storybook 简介
章节
  • 开始
  • 简单组件
  • 复合组件
  • 数据
  • 屏幕
  • 部署
  • 可视化测试
  • 插件
  • 结论
  • 贡献

插件

了解如何集成和使用流行的 Controls 插件

Storybook 拥有强大的插件生态系统,您可以使用这些插件来增强团队中每个人的开发者体验。在此处查看所有插件

如果您一直在关注本教程,那么您已经遇到了多个插件,并在测试章节中设置了一个插件。

插件适用于各种可能的用例,要写完所有插件需要很长时间。让我们集成最流行的插件之一:Controls 插件。

什么是 Controls?

Controls 允许设计师和开发人员通过摆弄组件的参数来轻松探索组件行为。无需代码。Controls 在您的故事旁边创建一个插件面板,因此您可以实时编辑其参数。

Storybook 的全新安装包开箱即用地包含 Controls 插件。无需额外配置。

插件解锁新的 Storybook 工作流程

Storybook 是一个出色的组件驱动开发环境。Controls 插件将 Storybook 演变为交互式文档工具。

使用 Controls 查找边缘情况

使用 Controls,QA 工程师、UI 工程师或任何其他利益相关者都可以将组件推向极限!考虑以下示例,如果我们添加一个超大字符串,我们的 Task 会发生什么?

Oh no! The far right content is cut-off!

这不对!文本似乎溢出了 Task 组件的边界。

Controls 使我们能够快速验证组件的不同输入(在本例中为长字符串),并减少了发现 UI 问题所需的工作。

现在,让我们通过向 Task.vue 添加样式来解决溢出问题

复制
src/components/Task.vue
<template>
  <div :class="classes">
    <label
      :for="'checked' + task.id"
      :aria-label="'archiveTask-' + task.id"
      class="checkbox"
    >
      <input
        type="checkbox"
        :checked="isChecked"
        disabled
        :name="'checked' + task.id"
        :id="'archiveTask-' + task.id"
      />
      <span class="checkbox-custom" @click="archiveTask" />
    </label>
    <label :for="'title-' + task.id" :aria-label="task.title" class="title">
      <input
        type="text"
        readonly
        :value="task.title"
        :id="'title-' + task.id"
        name="title"
        placeholder="Input title"
+       style="text-overflow: ellipsis;" />
      />
    </label>
    <button
      v-if="!isChecked"
      class="pin-button"
      @click="pinTask"
      :id="'pinTask-' + task.id"
      :aria-label="'pinTask-' + task.id"
    >
      <span class="icon-star" />
    </button>
  </div>
</template>

That's better.

问题解决了!现在,当文本到达 Task 区域的边界时,会使用漂亮的省略号进行截断。

添加新故事以避免回归

将来,我们可以通过 Controls 手动重现此问题来重现此问题。但编写一个展示此边缘情况的故事更容易。这扩大了我们的回归测试覆盖范围,并为团队的其他成员清楚地概述了组件的限制。

Task.stories.js 中为长文本用例添加一个新故事

复制
src/components/Task.stories.js
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 = {
  args: {
    task: {
      ...Default.args.task,
      title: longTitleString,
    },
  },
};

现在我们可以轻松地重现和处理这个边缘情况。

如果我们正在进行可视化测试,我们也会被告知截断解决方案是否中断。如果没有测试覆盖率,极端边缘情况很容易被遗忘!

💡 Controls 是让非开发人员体验您的组件和故事的好方法。它可以做的事情远不止我们在这里看到的;我们建议阅读官方文档以了解更多信息。但是,您可以通过插件以更多方式自定义 Storybook 以适应您的工作流程。在创建插件指南中,我们将教您如何通过创建一个插件来增强您的开发工作流程。

合并更改

别忘了使用 git 合并您的更改!

使您的代码与本章保持同步。在 GitHub 上查看 13da85f。
这个免费指南对您有帮助吗?发推文表示赞赏并帮助其他开发人员找到它。
下一章
结论
汇集您所有的知识并学习更多 Storybook 技巧
✍️ 在 GitHub 上编辑 - 欢迎提交 PR!
加入社区
6,721位开发者和持续增长中
为什么为什么 Storybook组件驱动的 UI
开源软件
Storybook - Storybook 中文

由以下机构维护
Chromatic - Storybook 中文
特别感谢 Netlify CircleCI