数据量过多时,采用分页的形式将数据分隔,每次只加载一个页面。
通过以下方式来全局注册组件,更多注册方式请参考组件注册。
import { createApp } from 'vue';
import { Pagination } from 'vant';
const app = createApp();
app.use(Pagination);
通过 v-model 来绑定当前页码。
<van-pagination v-model="currentPage" :total-items="24" :items-per-page="5" />
import { ref } from 'vue';
export default {
setup() {
const currentPage = ref(1);
return { currentPage };
},
};
将 mode 设置为 simple 来切换到简单模式,此时分页器不会展示具体的页码按钮。
<van-pagination v-model="currentPage" :page-count="12" mode="simple" />
设置 force-ellipses 后会展示省略号按钮,点击后可以快速跳转。
<van-pagination
v-model="currentPage"
:total-items="125"
:show-page-size="3"
force-ellipses
/>
通过 prev-text、next-text 等插槽来自定义分页按钮的内容。
<van-pagination v-model="currentPage" :total-items="50" :show-page-size="5">
<template #prev-text>
<van-icon name="arrow-left" />
</template>
<template #next-text>
<van-icon name="arrow" />
</template>
<template #page="{ text }">{{ text }}</template>
</van-pagination>
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
v-model | 当前页码 | number | - |
mode | 显示模式,可选值为 | string |
|
prev-text | 上一页按钮文字 | string |
|
next-text | 下一页按钮文字 | string |
|
page-count | 总页数 | number | string | 根据页数计算 |
total-items | 总记录数 | number | string |
|
items-per-page | 每页记录数 | number | string |
|
show-page-size | 显示的页码个数 | number | string |
|
force-ellipses | 是否显示省略号 | boolean |
|
事件名 | 说明 | 回调参数 |
---|---|---|
change | 页码改变时触发 | - |
名称 | 描述 | 参数 |
---|---|---|
page | 自定义页码 | { number: number, text: string, active: boolean } |
prev-text | 自定义上一页按钮文字 |
|
next-text | 自定义下一页按钮文字 |
|
组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件。
名称 | 默认值 | 描述 |
---|---|---|
--van-pagination-height | 40px | - |
--van-pagination-font-size | var(--van-font-size-md) | - |
--van-pagination-item-width | 36px | - |
--van-pagination-item-default-color | var(--van-primary-color) | - |
--van-pagination-item-disabled-color | var(--van-gray-7) | - |
--van-pagination-item-disabled-background-color | var(--van-background-color) | - |
--van-pagination-background-color | var(--van-white) | - |
--van-pagination-desc-color | var(--van-gray-7) | - |
--van-pagination-disabled-opacity | var(--van-disabled-opacity) | - |