usePageTable 分页查询
封装分页列表的查询、重置与加载状态。只接收最近一次请求的结果,避免快速切换条件时旧响应覆盖新数据。
基础用法
vue
<template>
<el-form :model="params" inline>
<el-form-item label="关键词">
<el-input v-model="params.keywords" @keyup.enter="handleQuery" />
</el-form-item>
<el-button type="primary" @click="handleQuery">搜索</el-button>
<el-button @click="handleResetQuery">重置</el-button>
</el-form>
<el-table v-loading="loading" :data="list">
<el-table-column prop="name" label="姓名" />
</el-table>
<pagination
v-model:page="params.pageNum"
v-model:limit="params.pageSize"
:total="total"
@pagination="fetchData"
/>
</template>
<script setup lang="ts">
import { usePageTable } from "@/composables";
import UserAPI from "@/api/system/user";
import type { UserItem, UserQuery } from "@/api/system/user";
const { loading, list, total, params, fetchData, handleQuery, handleResetQuery } = usePageTable<
UserItem,
UserQuery
>({
initialParams: { pageNum: 1, pageSize: 10 },
request: UserAPI.getPage,
});
fetchData();
</script>选项
| 名称 | 类型 | 说明 |
|---|---|---|
initialParams | Q | 查询初值,深复制后作为重置基准 |
request | (params: Q) => Promise<PageResult<T>> | 分页请求,接收参数快照 |
onBeforeReset | () => void | 重置参数前调用,用于同步清空搜索表单 |
Q 需继承 PageQuery(含 pageNum、pageSize),默认为 PageQuery。
返回值
| 名称 | 类型 | 说明 |
|---|---|---|
loading | Ref<boolean> | 加载状态 |
list | Ref<T[]> | 当前页数据 |
total | Ref<number> | 总条数 |
params | Q | 响应式查询参数 |
fetchData | () => Promise<void> | 按当前条件查询 |
handleQuery | () => Promise<void> | 回到第一页并查询 |
handleResetQuery | () => Promise<void> | 恢复初值并查询第一页 |
resetParams | () => void | 仅恢复参数,不发请求 |
内置行为
- 竞态隔离:递增请求序号,只有最近一次请求能更新
list、total和loading。 - 参数快照:每次请求深复制当前
params,等待期间修改表单不影响本次查询。 - 重置基准:
initialParams深复制保存,重置时删除运行中新增的字段并恢复初值。
重置搜索表单
搜索控件由页面持有,重置时通过 onBeforeReset 同步清空:
typescript
const queryFormRef = ref<FormInstance>();
usePageTable<UserItem, UserQuery>({
initialParams: { pageNum: 1, pageSize: 10 },
request: UserAPI.getPage,
onBeforeReset: () => queryFormRef.value?.resetFields(),
});