Skip to content

Pagination 分页

数据量过多时,采用分页的形式将数据分隔,每次只加载一个页面。

基础用法

简单模式

显示省略号

自定义按钮

API

Props

参数说明类型默认值
v-model当前页码number-
mode显示模式,可选值为 simplestringmulti
prev-text上一页按钮文字string上一页
prev-icon上一页的图标, 比 prev-text 优先级更高string | Component-
next-text下一页按钮文字string下一页
next-icon下一页的图标, 比 next-text 优先级更高string | Component-
page-count总页数number | string根据页数计算
total-items总记录数number | string0
items-per-page/ v-model:items-per-page每页记录数number | string10
placement下拉框出现的位置stringbottom
show-page-size显示的页码个数number | string5
force-ellipses是否显示省略号booleanfalse
show-prev-button是否展示上一页按钮booleantrue
show-next-button是否展示下一页按钮booleantrue
page-sizes每页显示个数选择器的选项设置array[10, 20, 30, 40, 50, 100]
popperClass每页显示个数选择器的下拉框类名string-
layout组件布局,子组件名用逗号分隔stringprev, pager, next

Events

事件名说明回调参数
change页码改变时触发-
size-changeitems-per-page 改变时触发-

Slots

名称描述参数
pagemulti自定义页码{ number: number, text: string, active: boolean }
pageDescsimple下自定义页码-
prev-text自定义上一页按钮文字-
next-text自定义下一页按钮文字-

类型定义

组件导出以下类型定义:

ts
import type { PaginationMode, PaginationProps } from 'ryxon'

主题定制

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件

名称默认值描述
--r-pagination-height40px-
--r-pagination-font-sizevar(--r-font-size-md)-
--r-pagination-item-width36px-
--r-pagination-item-default-colorvar(--r-primary-color)-
--r-pagination-item-disabled-colorvar(--r-gray-7)-
--r-pagination-item-disabled-backgroundvar(--r-background)-
--r-pagination-backgroundvar(--r-background-2)-
--r-pagination-desc-colorvar(--r-gray-7)-
--r-pagination-disabled-opacityvar(--r-disabled-opacity)-
--r-pagination-button-colorvar(--r-text-color-primary)-
--r-pagination-hover-colorvar(--r-primary-color)-

Released under the MIT License.