分页

当数据量过多时,使用分页分解数据。

基础用法

页码按钮的数量

带背景色的按钮

小型分页

在空间有限的情况下使用小型分页。

当只有一页时隐藏分页

当只有一页时,通过设置 hide-on-single-page 属性来隐藏分页。

更多功能元素

根据场景添加更多模块。

API

属性

名称描述类型默认值
size 2.7.6分页尺寸枚举'default'
background是否为按钮添加背景色booleanfalse
page-size / v-model:page-size每页显示条目个数number
default-page-size默认的初始每页显示条目个数,不设置默认为 10number
total总条目数number
page-count总页数,totalpage-count 设置任意一个就可以达到显示页码的功能;如果要支持 page-sizes 的更改,则需要提供 totalnumber
pager-count页码按钮的数量,当总页数超过该值时会折叠number7
current-page / v-model:current-page当前页数number
default-current-page默认的初始当前页数,不设置默认为 1number
layout分页组件布局,子组件用逗号分隔stringprev, pager, next, jumper, ->, total
page-sizes每页显示个数选择器的选项设置object[10, 20, 30, 40, 50, 100]
append-size-to 2.8.4尺寸下拉框被附加到的元素string
popper-class每页显示个数选择器下拉框的自定义类名string''
popper-style 2.11.5每页显示个数选择器下拉框的自定义样式string / object
prev-text替代图标显示的上一页文字string''
prev-icon上一页的图标,优先级低于 prev-textstring / ComponentArrowLeft
next-text替代图标显示的下一页文字string''
next-icon下一页的图标,优先级低于 next-textstring / ComponentArrowRight
disabled是否禁用分页booleanfalse
teleported 2.3.13是否将分页选择器下拉框插入到 body 元素中booleantrue
hide-on-single-page只有一页时是否隐藏booleanfalse
small 已废弃是否使用小型分页booleanfalse

警告

我们检测到了一些已废弃的用法,如果你的分页组件未出现或未按预期工作,请检查以下规则

  • 您必须定义 totalpage-count 中的一个,否则我们无法确定总页数。当两者都定义时,page-count 优先。
  • 如果定义了 current-page,您必须监听 current-page 的变化,同时定义 @update:current-page,否则分页将无法工作。
  • 如果在显示页面大小选择器(`layout` 中包含 `sizes`)的同时定义了 page-size,您也必须监听 page-size 的变化,通过定义 @update:page-size,否则页面大小的更改将无法工作。

事件

名称描述类型
size-changepage-size 改变时触发Function
current-changecurrent-page 改变时触发Function
change 2.4.4current-pagepage-size 改变时触发Function
prev-click当用户点击上一页按钮改变当前页时触发Function
next-click当用户点击下一页按钮改变当前页时触发Function

警告

不推荐使用以上事件(但为了兼容性原因仍然支持),更好的选择是使用 v-model 进行双向数据绑定。

插槽

名称描述
default自定义内容。要使用此功能,您需要在 layout 中声明 slot

来源

组件样式文档

贡献者