接入数据
到目前为止,我们创建了独立的无状态组件——这非常适合 Storybook,但在应用中为其提供数据之前,这些组件最终没有太大帮助。
本教程不侧重于构建应用的具体细节,因此我们不会在此深入探讨。但我们将花点时间看看使用容器组件接入数据的常见模式。
容器组件
我们目前编写的 TaskList
组件是“展示型”的,因为它不与其自身实现之外的任何事物进行交互。要将数据导入其中,我们需要一个“容器”。
本示例使用 Pinia(Vue 的默认数据管理库)为我们的应用构建一个简单的数据模型。然而,此处使用的模式同样适用于其他数据管理库,如 Apollo 和 MobX。
使用以下命令将所需的依赖添加到项目中:
yarn add pinia
首先,我们将在 src
目录下创建一个简单的 Pinia store,该 store 响应改变任务状态的 actions。文件名为 store.js
(有意保持简单)。
/* A simple Pinia store/actions implementation.
* A true app would be more complex and separated into different files.
*/
import { defineStore } from 'pinia';
/*
* The initial state of our store when the app loads.
* Usually, you would fetch this from a server. Let's not worry about that now
*/
const defaultTasks = [
{ id: '1', title: 'Something', state: 'TASK_INBOX' },
{ id: '2', title: 'Something more', state: 'TASK_INBOX' },
{ id: '3', title: 'Something else', state: 'TASK_INBOX' },
{ id: '4', title: 'Something again', state: 'TASK_INBOX' },
];
/*
* The store is created here.
* You can read more about Pinia defineStore in the docs:
* https://pinia.vuejs.ac.cn/core-concepts/
*/
export const useTaskStore = defineStore({
id: 'taskbox',
state: () => ({
tasks: defaultTasks,
status: 'idle',
error: null,
}),
actions: {
archiveTask(id) {
const task = this.tasks.find((task) => task.id === id);
if (task) {
task.state = 'TASK_ARCHIVED';
}
},
pinTask(id) {
const task = this.tasks.find((task) => task.id === id);
if (task) {
task.state = 'TASK_PINNED';
}
},
},
getters: {
getFilteredTasks: (state) => {
const filteredTasks = state.tasks.filter(
(t) => t.state === 'TASK_INBOX' || t.state === 'TASK_PINNED'
);
return filteredTasks;
},
},
});
然后我们将更新 TaskList
以从 store 读取数据。首先,我们将现有的展示型版本移动到 src/components/PureTaskList.vue
文件(将组件重命名为 PureTaskList
),并用一个容器包裹它。
在 src/components/PureTaskList.vue
中
<template>
<div class="list-items">
<template v-if="loading">
<div v-for="n in 6" :key="n" class="loading-item">
<span class="glow-checkbox" />
<span class="glow-text">
<span>Loading</span> <span>cool</span> <span>state</span>
</span>
</div>
</template>
<div v-else-if="isEmpty" class="list-items">
<div class="wrapper-message">
<span class="icon-check" />
<p class="title-message">You have no tasks</p>
<p class="subtitle-message">Sit back and relax</p>
</div>
</div>
<template v-else>
<Task
v-for="task in tasksInOrder"
:key="task.id"
:task="task"
@archive-task="onArchiveTask"
@pin-task="onPinTask"
/>
</template>
</div>
</template>
<script>
import Task from './Task.vue';
import { reactive, computed } from 'vue';
export default {
name: 'PureTaskList',
components: { Task },
props: {
tasks: { type: Array, required: true, default: () => [] },
loading: { type: Boolean, default: false },
},
emits: ['archive-task', 'pin-task'],
setup(props, { emit }) {
props = reactive(props);
return {
isEmpty: computed(() => props.tasks.length === 0),
tasksInOrder: computed(() => {
return [
...props.tasks.filter((t) => t.state === 'TASK_PINNED'),
...props.tasks.filter((t) => t.state !== 'TASK_PINNED'),
];
}),
/**
* Event handler for archiving tasks
*/
onArchiveTask(taskId) {
emit('archive-task', taskId);
},
/**
* Event handler for pinning tasks
*/
onPinTask(taskId) {
emit('pin-task', taskId);
},
};
},
};
</script>
在 src/components/TaskList.vue
中
<template>
<PureTaskList :tasks="tasks" @archive-task="archiveTask" @pin-task="pinTask" />
</template>
<script>
import PureTaskList from './PureTaskList.vue';
import { computed } from 'vue';
import { useTaskStore } from '../store';
export default {
components: { PureTaskList },
name: 'TaskList',
setup() {
//👇 Creates a store instance
const store = useTaskStore();
//👇 Retrieves the tasks from the store's state auxiliary getter function
const tasks = computed(() => store.getFilteredTasks);
//👇 Dispatches the actions back to the store
const archiveTask = (task) => store.archiveTask(task);
const pinTask = (task) => store.pinTask(task);
return {
tasks,
archiveTask,
pinTask,
};
},
};
</script>
保留 TaskList
的展示型版本是分开的原因是它更容易测试和隔离。由于它不依赖于 store 的存在,从测试的角度来看处理起来要容易得多。让我们将 src/components/TaskList.stories.js
重命名为 src/components/PureTaskList.stories.js
,并确保我们的 stories 使用展示型版本。
+ import PureTaskList from './PureTaskList.vue';
import * as TaskStories from './Task.stories';
export default {
+ component: PureTaskList,
+ title: 'PureTaskList',
tags: ['autodocs'],
decorators: [() => ({ template: '<div style="margin: 3em;"><story/></div>' })],
args: {
...TaskStories.ActionsData,
}
};
export const Default = {
args: {
// Shaping the stories through args composition.
// The data was inherited from the Default story in Task.stories.js.
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 = {
args: {
// Shaping the stories through args composition.
// Inherited data coming from the Default story.
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,
},
};
现在我们已经有一些从 Pinia store 获取的实际数据填充了我们的组件,我们可以将其接入到 src/App.vue
并在那里渲染组件。别担心,我们会在下一章处理好它。