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

组装复合组件

将更简单的组件组装成复合组件

上一章我们构建了第一个组件;本章将扩展我们所学的知识来创建 TaskList,一个任务列表。让我们将组件组合在一起,看看引入更多复杂性时会发生什么。

任务列表

Taskbox 通过将固定任务置于默认任务之上来强调它们。它会产生两种 TaskList 变体,你需要为它们创建故事:默认和固定项。

default and pinned tasks

由于 Task 数据可以异步发送,因此在没有连接的情况下,我们需要一个加载状态来渲染。此外,当没有任务时,我们需要一个空状态。

empty and loading tasks

开始设置

复合组件与它包含的基本组件没有太大区别。创建一个 TaskList 组件和一个配套的故事文件:src/components/TaskList.tsxsrc/components/TaskList.stories.tsx

TaskList 的粗略实现开始。你需要导入前面创建的 Task 组件,并将属性和操作作为输入传递。

复制
src/components/TaskList.tsx
import type { TaskData } from '../types';

import Task from './Task';

type TaskListProps = {
  /** Checks if it's in loading state */
  loading?: boolean;
  /** The list of tasks */
  tasks: TaskData[];
  /** Event to change the task to pinned */
  onPinTask: (id: string) => void;
  /** Event to change the task to archived */
  onArchiveTask: (id: string) => void;
};

export default function TaskList({
  loading = false,
  tasks,
  onPinTask,
  onArchiveTask,
}: TaskListProps) {
  const events = {
    onPinTask,
    onArchiveTask,
  };

  if (loading) {
    return <div className="list-items">loading</div>;
  }

  if (tasks.length === 0) {
    return <div className="list-items">empty</div>;
  }

  return (
    <div className="list-items">
      {tasks.map((task) => (
        <Task key={task.id} task={task} {...events} />
      ))}
    </div>
  );
}

接下来,在故事文件中创建 Tasklist 的测试状态。

复制
src/components/TaskList.stories.tsx
import type { Meta, StoryObj } from '@storybook/react';

import TaskList from './TaskList';

import * as TaskStories from './Task.stories';

const meta = {
  component: TaskList,
  title: 'TaskList',
  decorators: [(story) => <div style={{ margin: '3rem' }}>{story()}</div>],
  tags: ["autodocs"],
  args: {
    ...TaskStories.ActionsData,
  },
} satisfies Meta<typeof TaskList>;

export default meta;
type Story = StoryObj<typeof meta>;

export const Default: Story = {
  args: {
    // Shaping the stories through args composition.
    // The data was inherited from the Default story in Task.stories.tsx.
    tasks: [
      { ...TaskStories.Default.args.task, id: '1', title: 'Task 1' },
      { ...TaskStories.Default.args.task, id: '2', title: 'Task 2' },
      { ...TaskStories.Default.args.task, id: '3', title: 'Task 3' },
      { ...TaskStories.Default.args.task, id: '4', title: 'Task 4' },
      { ...TaskStories.Default.args.task, id: '5', title: 'Task 5' },
      { ...TaskStories.Default.args.task, id: '6', title: 'Task 6' },
    ],
  },
};

export const WithPinnedTasks: Story = {
  args: {
    tasks: [
      ...Default.args.tasks.slice(0, 5),
      { id: '6', title: 'Task 6 (pinned)', state: 'TASK_PINNED' },
    ],
  },
};

export const Loading: Story = {
  args: {
    tasks: [],
    loading: true,
  },
};

export const Empty: Story = {
  args: {
    // Shaping the stories through args composition.
    // Inherited data coming from the Loading story.
    ...Loading.args,
    loading: false,
  },
};

💡装饰器(Decorators)是一种为故事提供任意包装器的方式。在这种情况下,我们在默认导出上使用了一个装饰器键,以便在渲染的组件周围添加一些 margin。它们也可以用于将故事包装在“提供者”中——例如,设置 React 上下文的库组件。

通过导入 TaskStories,我们能够轻松地组合故事中的参数(args 的简称)。这样,两个组件所需的数据和操作(模拟回调)都得以保留。

现在检查 Storybook,查看新的 TaskList 故事。

构建状态

我们的组件还很粗糙,但现在我们对要实现的故事有了一个概念。你可能认为 .list-items 包装器过于简单了。你是对的——在大多数情况下,我们不会仅仅为了添加一个包装器就创建一个新组件。但 TaskList 组件的真正复杂性体现在边缘情况 withPinnedTasksloadingempty 中。

复制
src/components/TaskList.tsx
import type { TaskData } from '../types';

import Task from './Task';

type TaskListProps = {
  /** Checks if it's in loading state */
  loading?: boolean;
  /** The list of tasks */
  tasks: TaskData[];
  /** Event to change the task to pinned */
  onPinTask: (id: string) => void;
  /** Event to change the task to archived */
  onArchiveTask: (id: string) => void;
};

export default function TaskList({
  loading = false,
  tasks,
  onPinTask,
  onArchiveTask,
}: TaskListProps) {
  const events = {
    onPinTask,
    onArchiveTask,
  };
  const LoadingRow = (
    <div className="loading-item">
      <span className="glow-checkbox" />
      <span className="glow-text">
        <span>Loading</span> <span>cool</span> <span>state</span>
      </span>
    </div>
  );
  if (loading) {
    return (
      <div className="list-items" data-testid="loading" key={"loading"}>
        {LoadingRow}
        {LoadingRow}
        {LoadingRow}
        {LoadingRow}
        {LoadingRow}
        {LoadingRow}
      </div>
    );
  }
  if (tasks.length === 0) {
    return (
      <div className="list-items" key={"empty"} data-testid="empty">
        <div className="wrapper-message">
          <span className="icon-check" />
          <p className="title-message">You have no tasks</p>
          <p className="subtitle-message">Sit back and relax</p>
        </div>
      </div>
    );
  }

  const tasksInOrder = [
    ...tasks.filter((t) => t.state === "TASK_PINNED"),
    ...tasks.filter((t) => t.state !== "TASK_PINNED"),
  ];
  return (
    <div className="list-items">
      {tasksInOrder.map((task) => (
        <Task key={task.id} task={task} {...events} />
      ))}
    </div>
  );
}

添加的标记产生了以下 UI

注意列表中固定项目的位置。我们希望固定项目渲染在列表的顶部,以便让用户优先看到它。

💡 别忘了使用 git 提交你的更改!
使你的代码与本章同步。在 GitHub 上查看 cfa25b6。
这本免费指南对你有帮助吗?发推文点赞并帮助其他开发者找到它。
下一章
数据
学习如何将数据接入你的 UI 组件
✍️ 在 GitHub 上编辑 – 欢迎 PR!
加入社区
6,975开发者(还在不断增加)
为何使用为何使用 Storybook组件驱动的 UI
开源软件
Storybook - Storybook 中文

特别感谢 Netlify CircleCI