Skip to content

Pagination 分页

当数据量过多时,使用分页分解数据。支持多种布局配置、视觉风格和交互方式。

样式变体

通过 variant 属性控制分页组件的视觉样式,支持三种风格:default(默认带边框)、background(背景色无边框)、borderless(无背景无边框)。

布局配置 (Layout)

通过 layout 属性自定义分页组件的布局,排列顺序即展示顺序

可用的布局部件

部件名说明示例
total总条数显示总条数 120
prev上一页按钮
pager页码列表1 2 3 ... 10
next下一页按钮
sizes页大小选择器10/页 ▼
jumper跳转输入框前往 [__] 页

自定义布局与总数文案

自定义布局顺序,并通过 total-text 自定义总数文案(支持 {total} 占位符)。

尺寸大小

通过 size 属性控制分页组件的尺寸,支持 small(小号)、default(默认)、large(大号)三种尺寸。

跳转功能

layout 中添加 jumper 启用快速跳转到指定页。

Props

属性名说明类型可选值默认值
total数据总条数number
pageCount总页数(与 total 二选一)number
pageSize每页数量(支持 v-model:pageSizenumber
currentPage当前页码(支持 v-model:currentPagenumber
layout布局定义(排列顺序即展示顺序),示例:total, prev, pager, next, jumperstringprev / pager / next / sizes / total / jumperprev, pager, next, sizes, total
pagerCount页码按钮数量(奇数)number7
pageSizes页大小选项列表number[][10, 20, 50, 100]
size尺寸大小stringsmall / default / largedefault
small小号样式(已废弃,请使用 size="small"booleanfalse
variant视觉样式变体stringdefault / background / borderlessdefault
background背景样式(已废弃,请使用 variant="background"booleanfalse
borderless无边框样式(已废弃,请使用 variant="borderless"booleanfalse
disabled禁用态booleanfalse
hideOnSinglePage仅一页时隐藏boolean
show兼容:是否显示分页(优先级高于 total 判断)boolean
showSizeChanger兼容:是否显示页大小切换器(优先于 layoutboolean
showTotal兼容:是否显示总数文案(优先于 layoutboolean
totalText总数文案模板,支持 {total} 占位符string总条数
prevText上一页按钮文案string左箭头
nextText下一页按钮文案string右箭头

Events

事件名说明回调参数
update:currentPage当前页变化(支持 v-model:currentPage)(page: number) => void
update:pageSize页大小变化(支持 v-model:pageSize)(size: number) => void
current-change当前页变化(Element Plus 风格)(page: number) => void
size-change页大小变化(Element Plus 风格)(size: number) => void
change页码或页大小变化(page: number, size: number) => void