返回Storybook 入门
章节
  • 开始
  • 简单组件
  • 复合组件
  • 数据
  • 结论
  • 贡献

组合复合组件

从更简单的组件组合出复合组件
此社区翻译尚未更新至最新版 Storybook。请通过将英文指南中的更改应用于此翻译来帮助我们更新它。 欢迎提交拉取请求.

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

任务列表

Taskbox 通过将置顶任务放在默认任务上方来强调它们。这产生了你需要为其创建故事的 TaskList 的两种变体:默认项和默认加置顶项。

default and pinned tasks

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

empty and loading tasks

开始设置

复合组件与它包含的基本组件并没有太大不同。创建一个 TaskList 组件和一个配套的故事文件:components/TaskList.jsxcomponents/TaskList.stories.jsx

TaskList 的一个初步实现开始。你需要导入之前创建的 Task 组件,并将其属性和动作作为输入传递。

复制
components/TaskList.jsx
import { Task } from './Task';
import { FlatList, StyleSheet, Text, View } from 'react-native';
import { styles } from './styles';

export const TaskList = ({ loading, tasks, onPinTask, onArchiveTask }) => {
  const events = {
    onPinTask,
    onArchiveTask,
  };

  if (loading) {
    return (
      <View style={styles.listItems}>
        <Text>loading</Text>
      </View>
    );
  }

  if (tasks.length === 0) {
    return (
      <View style={styles.listItems}>
        <Text>empty</Text>
      </View>
    );
  }

  return (
    <View style={styles.listItems}>
      <FlatList
        data={tasks}
        keyExtractor={(task) => task.id}
        renderItem={({ item }) => (
          <Task key={item.id} task={item} {...events} />
        )}
      />
    </View>
  );
};

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

复制
components/TaskList.stories.jsx
import { TaskList } from './TaskList';
import { Default as TaskStory } from './Task.stories';
import { View } from 'react-native';

export default {
  component: TaskList,
  title: 'TaskList',
  decorators: [
    (Story) => (
      <View style={{ padding: 42, flex: 1 }}>
        <Story />
      </View>
    ),
  ],
  argTypes: {
    onPinTask: { action: 'onPinTask' },
    onArchiveTask: { action: 'onArchiveTask' },
  },
};

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

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

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

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

装饰器(Decorators) 是一种为故事提供任意包装器的方法。在这里,我们使用装饰器来为列表添加填充,以便于视觉验证。它们也可以用于将故事包装在“提供者”(即设置 React 上下文的库组件)中。

TaskStory.args.task 提供了我们在 Task.stories.js 文件中创建并导出的 Task 的形状。类似地,我们为 onPinTaskonArchiveTask 添加的 argTypes 告诉 Storybook 提供 TaskList 组件所需的 actions(模拟回调)。

如果你没有立即看到新故事,请尝试重新加载应用。如果仍然无效,你可以重新运行 yarn storybook-generate 命令来重新生成 storybook.requires 文件。

现在检查 Storybook 中的新 TaskList 故事。

a gif showing the task list component in storybook

构建状态

我们的组件仍然很粗糙,但现在我们对要实现的故事有了一个大致了解。你可能会觉得 listitems 包装器过于简单。你说得对——在大多数情况下,我们不会仅仅为了添加一个包装器而创建一个新组件。但 TaskList 组件的真正复杂性体现在 withPinnedTasksloadingempty 这几个边缘情况中。

对于加载情况,我们将创建一个新组件来显示加载动画。

创建一个名为 LoadingRow.jsx 的新文件,内容如下

复制
components/LoadingRow.jsx
import { useState, useEffect } from 'react';
import { Animated, Text, View, Easing, StyleSheet } from 'react-native';
import { styles } from './styles';

const GlowView = ({ style, children }) => {
  const [glowAnim] = useState(new Animated.Value(0.3));

  useEffect(() => {
    Animated.loop(
      Animated.sequence([
        Animated.timing(glowAnim, {
          toValue: 1,
          duration: 1500,
          easing: Easing.ease,
          useNativeDriver: true,
        }),
        Animated.timing(glowAnim, {
          toValue: 0.3,
          duration: 1500,
          easing: Easing.ease,
          useNativeDriver: true,
        }),
      ])
    ).start();
  }, []);

  return (
    <Animated.View
      style={{
        ...style,
        opacity: glowAnim,
      }}
    >
      {children}
    </Animated.View>
  );
};

export const LoadingRow = () => (
  <View style={styles.container}>
    <GlowView>
      <View style={styles.loadingItem}>
        <View style={styles.glowCheckbox} />
        <Text style={styles.glowText}>Loading</Text>
        <Text style={styles.glowText}>cool</Text>
        <Text style={styles.glowText}>state</Text>
      </View>
    </GlowView>
  </View>
);

并将 TaskList.jsx 更新为如下内容

复制
components/TaskList.jsx
import { Task } from './Task';
import { FlatList, StyleSheet, Text, View } from 'react-native';
import { LoadingRow } from './LoadingRow';
import { MaterialIcons } from '@expo/vector-icons';
import { styles } from './styles';

export const TaskList = ({ loading, tasks, onPinTask, onArchiveTask }) => {
  const events = {
    onPinTask,
    onArchiveTask,
  };

  if (loading) {
    return (
      <View style={[styles.listItems, { justifyContent: "center" }]}>
        <LoadingRow />
        <LoadingRow />
        <LoadingRow />
        <LoadingRow />
        <LoadingRow />
        <LoadingRow />
      </View>
    );
  }

  if (tasks.length === 0) {
    return (
      <View style={styles.listItems}>
        <View style={styles.wrapperMessage}>
          <MaterialIcons name="check" size={64} color={"#2cc5d2"} />
          <Text style={styles.titleMessage}>You have no tasks</Text>
          <Text style={styles.subtitleMessage}>Sit back and relax</Text>
        </View>
      </View>
    );
  }

  const tasksInOrder = [
    ...tasks.filter((t) => t.state === 'TASK_PINNED'),
    ...tasks.filter((t) => t.state !== 'TASK_PINNED'),
  ];
  return (
    <View style={styles.listItems}>
      <FlatList
        data={tasksInOrder}
        keyExtractor={(task) => task.id}
        renderItem={({ item }) => (
          <Task key={item.id} task={item} {...events} />
        )}
      />
    </View>
  );
};

这些更改会产生以下 UI

TaskList with loading state

成功!我们完成了设定的目标。如果我们检查更新后的 UI,可以快速看到我们的置顶任务现在被放在列表顶部,符合预期的设计。在接下来的章节中,我们将扩展所学知识,并通过将这些原则应用于更复杂的 UI 来继续增加应用的复杂性。

💡 别忘了用 git 提交你的更改!
这本免费指南对你有帮助吗?
下一章
数据
学习如何将数据连接到你的 UI 组件
✍️ 在 GitHub 上编辑 – 欢迎 PR!
加入社区
6,975及以上开发者
原因Why Storybook组件驱动 UI
开源软件
Storybook - Storybook 中文

特别鸣谢 Netlify CircleCI