Pagination 分页

当单页数据过多时,使用分页拆分展示。

基础用法

通过 layout 逗号分隔需要展示的元素:prev(上一页)、next(下一页)、pager(页码列表)、jumper(跳转输入)、total(总数)、sizes(每页条数选择),以及 ->(其后的元素靠右对齐)。

When you have few pages
  • 1
  • 2
  • 3
  • 4
  • 5
When you have more than 7 pages
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 100

页码按钮数量

超过 7 页时会折叠多余页码,可用 pager-count 配置。

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 50

带背景色

设置 background 为按钮添加背景色。

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 100

小型分页

空间有限时使用小型分页。

通过 size 使用 small

  • 1
  • 2
  • 3
  • 4
  • 5
  • 1
  • 2
  • 3
  • 4
  • 5

仅一页时隐藏

仅一页时可通过 hide-on-single-page 隐藏分页。


  • 1

更多功能组合

按场景组合模块。

本例监听 size-changecurrent-change 处理每页条数与当前页变化。page-sizes 为整数数组,如 [100, 200, 300, 400] 表示每页条数下拉的四个选项。

background:
disabled:

Total item count
Total 1000
  • 1
  • 3
  • 4
  • 5
  • 6
  • 7
  • 10
Change page size
  • 1
  • 3
  • 4
  • 5
  • 6
  • 7
  • 10
Jump to
  • 1
  • 3
  • 4
  • 5
  • 6
  • 7
  • 10
Go to
All combined
Total 400
  • 1
  • 2
  • 3
  • 4
Go to

分页 API

分页 属性

名称说明类型默认值
size尺寸enum'default'
background是否为按钮添加背景色booleanfalse
page-size / v-model:page-size每页条数number
default-page-size每页条数初始值;不设则与 10 相同number
total总条目数number
page-count总页数。需设置 totalpage-count 之一;若使用 page-sizes,必须提供 totalnumber
pager-count页码按钮最大数量,超过则折叠number7
current-page / v-model:current-page当前页number
default-current-page当前页初始值;不设则与 1 相同number
layout布局,逗号分隔组件名stringprev, pager, next, jumper, ->, total
page-sizes每页条数可选列表array[10, 20, 30, 40, 50, 100]
append-size-to每页条数下拉挂载元素string
popper-class每页条数选择器下拉的自定义类名string''
popper-style每页条数选择器下拉的自定义样式string / object
prev-text上一页按钮文字string''
prev-icon上一页图标,优先级低于 prev-textstring / ComponentArrowLeft
next-text下一页按钮文字string''
next-icon下一页图标,优先级低于 next-textstring / ComponentArrowRight
disabled是否禁用booleanfalse
teleported每页条数下拉是否传送到 bodybooleantrue
hide-on-single-page仅一页时是否隐藏booleanfalse

WARNING

若分页未显示或行为异常,请检查:

  • 必须设置 totalpage-count 之一;同时设置时以 page-count 为准。
  • 若使用 current-page,需同时监听 @update:current-page(或 v-model:current-page),否则当前页不会更新。
  • 若使用 page-sizelayoutsizes,需监听 @update:page-size(或 v-model:page-size),否则每页条数切换无效。

分页 事件

名称说明类型
size-changepage-size 变化时Function
current-changecurrent-page 变化时Function
changecurrent-pagepage-size 变化时Function
prev-click点击上一页且当前页变化时Function
next-click点击下一页且当前页变化时Function

WARNING

上述事件仍支持但不推荐,优先使用 v-model 双向绑定。

分页 插槽

名称说明
default自定义内容;需在 layout 中声明 slot