Pagination

Intro

When the amount of data is too much, use pagination to separate the data, and load only one page at a time.

Install

import { createApp } from 'vue';
import { Pagination } from 'vant';

const app = createApp();
app.use(Pagination);

Usage

Basic Usage

<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 };
  },
};

Simple mode

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

Show ellipses

<van-pagination
  v-model="currentPage"
  :total-items="125"
  :show-page-size="3"
  force-ellipses
/>

Custom Button

<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>

API

Props

Attribute	Description	Type	Default
v-model	Current page number	number	-
mode	Mode, can be set to `simple` `multi`	string	`multi`
prev-text	Previous text	string	`Previous`
next-text	Next text	string	`Next`
total-items	Total items	number \| string	`0`
items-per-page	Item number per page	number \| string	`10`
page-count	The total number of pages, if not set, will be calculated based on `total-items` and `items-per-page`	number \| string	`-`
show-page-size	Count of page size to show	number \| string	`5`
force-ellipses	Whether to show ellipses	boolean	`false`

Events

Event	Description	Arguments
change	Emitted when current page changed	-

Slots

Name	Description	SlotProps
page	Custom pagination item	{ number: number, text: string, active: boolean }
prev-text	Custom prev text	`-`
next-text	Custom next text	`-`

Less Variables

How to use: Custom Theme.

Name	Default Value	Description
@pagination-height	`40px`	-
@pagination-font-size	`@font-size-md`	-
@pagination-item-width	`36px`	-
@pagination-item-default-color	`@blue`	-
@pagination-item-disabled-color	`@gray-7`	-
@pagination-item-disabled-background-color	`@background-color`	-
@pagination-background-color	`@white`	-
@pagination-desc-color	`@gray-7`	-
@pagination-disabled-opacity	`@disabled-opacity`	-