Pagination 分页

介绍

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

引入

通过以下方式来全局注册组件,更多注册方式请参考组件注册

  1. import { createApp } from 'vue';
  2. import { Pagination } from 'vant';
  3. const app = createApp();
  4. app.use(Pagination);

代码演示

基础用法

通过 v-model 来绑定当前页码。

  1. <van-pagination v-model="currentPage" :total-items="24" :items-per-page="5" />
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const currentPage = ref(1);
  5. return { currentPage };
  6. },
  7. };

简单模式

 将 mode 设置为 simple 来切换到简单模式,此时分页器不会展示具体的页码按钮。

  1. <van-pagination v-model="currentPage" :page-count="12" mode="simple" />

显示省略号

设置 force-ellipses 后会展示省略号按钮,点击后可以快速跳转。

  1. <van-pagination
  2. v-model="currentPage"
  3. :total-items="125"
  4. :show-page-size="3"
  5. force-ellipses
  6. />

自定义按钮

通过 prev-textnext-text 等插槽来自定义分页按钮的内容。

  1. <van-pagination v-model="currentPage" :total-items="50" :show-page-size="5">
  2. <template #prev-text>
  3. <van-icon name="arrow-left" />
  4. </template>
  5. <template #next-text>
  6. <van-icon name="arrow" />
  7. </template>
  8. <template #page="{ text }">{{ text }}</template>
  9. </van-pagination>

API

Props

参数说明类型默认值
v-model当前页码number-
mode显示模式,可选值为 simplestringmulti
prev-text上一页按钮文字string上一页
next-text下一页按钮文字string下一页
page-count总页数number | string根据页数计算
total-items总记录数number | string0
items-per-page每页记录数number | string10
show-page-size显示的页码个数number | string5
force-ellipses是否显示省略号booleanfalse

Events

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

Slots

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

类型定义

组件导出以下类型定义:

  1. import type { PaginationMode } from 'vant';

主题定制

样式变量

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

名称默认值描述
—van-pagination-height40px-
—van-pagination-font-sizevar(—van-font-size-md)-
—van-pagination-item-width36px-
—van-pagination-item-default-colorvar(—van-primary-color)-
—van-pagination-item-disabled-colorvar(—van-gray-7)-
—van-pagination-item-disabled-background-colorvar(—van-background-color)-
—van-pagination-background-colorvar(—van-white)-
—van-pagination-desc-colorvar(—van-gray-7)-
—van-pagination-disabled-opacityvar(—van-disabled-opacity)-

Pagination 分页 - 图1