Skip to content

usePagination

usePagination 提供了分页相关的状态管理和事件处理,包括页码、每页条数、排序等功能,可以与 Element Plus 的分页组件完美配合使用。

基础用法

API

返回值

名称说明类型
pagination分页配置对象Ref<PaginationState>
getParams获取分页参数方法() => Pagination
handlePagination分页事件处理方法(getData: () => void) => PaginationHandlers

PaginationState 类型

属性说明类型默认值
page当前页码number1
size每页条数number10
total总条数number0
sizes可选的每页条数number[][10, 20, 50, 100]
layout分页组件布局string'total, sizes, prev, pager, next, jumper'
sort排序信息{ prop: string; order: string; column: any } | nullnull
order排序方向string | nullnull

PaginationHandlers 类型

方法名说明参数
onSizeChange每页条数改变时的回调(size: number) => Promise<void>
onCurrentChange当前页改变时的回调(page: number) => Promise<void>
onSortChange排序改变时的回调(prop: SortInfo, order: string) => Promise<void>

Released under the MIT License.