分页扩展 API

分页扩展。

const { ...ReturnValues } = usePagination<R, P, FR>(Service, Options);

用法参考: 分页扩展

注意

以下API,是 公共API超集。如果没有特别说明的,则和 公共API 保持一致。

Return Values

current

  • 类型: Ref<number>

  • 默认值: 1

    当前页数。我们在内部监听了该值,当你直接修改 current 的时,会自动触发 changeCurrent 方法。因此你可以配合 v-model 使用。

pageSize

  • 类型: Ref<number>

  • 默认值: 10

    每页获取的条数。我们在内部监听了该值,当你直接修改 pageSize 的时,会自动触发 changePageSize 方法。因此你可以配合 v-model 使用。

total

  • 类型: Ref<number>

  • 默认值: 0

    数据总数。

totalPage

  • 类型: Ref<number>

  • 默认值: 0

    总页数,必须提供正确的 totalpageSize,否则可能得到不正确的值。

changeCurrent

  • 类型: (current: number) => void

    修改当前页数

changePageSize

  • 类型: (pageSize: number) => void

    修改每页获取的条数

changePagination New in 1.2.0

  • 类型: (current: number, pageSize: number) => void

    同时修改页数和条数

reload

  • 类型: () => void

    清空所有请求状态,以及请求结果(包括data),并使用 defaultParams 重新触发 run()

queries 不支持

分页模式下,不支持 并发请求

Options

pagination

  • 类型:

    {
      currentKey?: string;
      pageSizeKey?: string;
      totalKey?: string;
      totalPageKey?: string;
    }
    
  • 详情:

提示

totalKeytotalPageKey 均使用 lodash.get 来实现的,因此支持传入对象属性的路径来获取值,详情可以参考 lodash文档在新窗口打开

pagination 字段说明默认值
currentKey你可以通过该值指定接口 当前页数 参数的属性值'current'
pageSizeKey你可以通过该值指定接口 每页获取条数 参数的属性值'pageSize'
totalKey指定 datatotal 属性的路径'total'
totalPageKey指定 datatotalPage 属性的路径'totalPage'

queryKey 不支持

分页模式下,不支持 并发请求

上次更新: 6/29/2022, 7:38:54 AM
贡献者: John