外观
usePagedTable
分页表格状态管理 composable,处理查询、分页、排序、选择和请求取消。
Options
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
request | (params: PagedTableRequest<Q>) => Promise<PagedTableResponse<T>> | — | 是 | 分页请求函数 |
initialQuery | Q | {} | 否 | 初始查询条件 |
initialPageSize | number | 10 | 否 | 初始每页条数 |
immediate | boolean | true | 否 | 挂载后是否立即请求 |
cloneQuery | (query: Q) => Q | structuredClone | 否 | 查询对象克隆策略 |
normalizeError | (cause: unknown) => Error | 转为 Error | 否 | 错误规范化 |
Returns
| 名称 | 类型 | 说明 |
|---|---|---|
query | Q | 当前查询条件 |
data | T[] | 当前页数据 |
loading | Readonly<Ref<boolean>> | 加载状态 |
error | Readonly<Ref<Error | null>> | 错误 |
sort | Readonly<Ref<PagedTableSort | undefined>> | 当前排序 |
pagination | Readonly<{ current: number; size: number; total: number }> | 分页状态 |
selectedRows | T[] | 已选行 |
selectedCount | ComputedRef<number> | 已选行数 |
isEmpty | ComputedRef<boolean> | 是否为空 |
load | () => Promise<void> | 加载数据 |
search | (params?: Q) => Promise<void> | 搜索,重置到第一页 |
reset | () => Promise<void> | 重置并加载 |
refresh | () => Promise<void> | 刷新当前页 |
cancel | () => void | 取消当前请求 |
handleSizeChange | (size: number) => Promise<void> | 每页条数变化 |
handleCurrentChange | (current: number) => Promise<void> | 当前页变化 |
handleSortChange | ({ prop, order }) => Promise<void> | 排序变化 |
handleSelectionChange | (rows: T[]) => void | 选择变化 |
Demo
vue
<script setup>
import { ref } from 'vue'
import { KvSearchTable, usePagedTable } from '@kevairy/components'
const searchModel = ref({ keyword: '' })
const searchItems = [{ key: 'keyword', label: '关键词', type: 'input' }]
const columns = ref([
{ prop: 'id', label: 'ID' },
{ prop: 'name', label: '名称' }
])
const columnChecks = ref([
{ prop: 'id', label: 'ID', visible: true },
{ prop: 'name', label: '名称', visible: true }
])
const table = usePagedTable({
request: async ({ query, current, size, sort, signal }) => {
const response = await fetch('/api/list', {
method: 'POST',
body: JSON.stringify({ ...query, current, size, sort }),
signal
}).then((res) => res.json())
return { records: response.list, total: response.total }
},
initialQuery: searchModel.value,
initialPageSize: 10,
immediate: true
})
const handleSearch = (params) => {
table.search(params)
}
</script>
<template>
<KvSearchTable
title="列表"
row-key="id"
:search-items="searchItems"
v-model:search-model="searchModel"
:columns="columns"
:column-checks="columnChecks"
:data="table.data"
:loading="table.loading"
:error="table.error"
:pagination="table.pagination"
@search="handleSearch"
@refresh="table.refresh"
@size-change="table.handleSizeChange"
@current-change="table.handleCurrentChange"
@sort-change="table.handleSortChange"
@selection-change="table.handleSelectionChange"
/>
</template>