mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-06-02 11:49:16 +08:00
106114333b
* feat(Pagination): pagination item custom render * fix(Pagination): fix test result * fix(Pagination): expose page object directly
90 lines
2.0 KiB
Markdown
90 lines
2.0 KiB
Markdown
# Pagination
|
|
|
|
### Install
|
|
|
|
```js
|
|
import Vue from 'vue';
|
|
import { Pagination } from 'vant';
|
|
|
|
Vue.use(Pagination);
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Basic Usage
|
|
|
|
```html
|
|
<van-pagination v-model="currentPage" :total-items="24" :items-per-page="5" />
|
|
```
|
|
|
|
```js
|
|
export default {
|
|
data() {
|
|
return {
|
|
currentPage: 1,
|
|
};
|
|
},
|
|
};
|
|
```
|
|
|
|
### Simple mode
|
|
|
|
```html
|
|
<van-pagination v-model="currentPage" :page-count="12" mode="simple" />
|
|
```
|
|
|
|
### Show ellipses
|
|
|
|
```html
|
|
<van-pagination
|
|
v-model="currentPage"
|
|
:total-items="125"
|
|
:show-page-size="3"
|
|
force-ellipses
|
|
/>
|
|
```
|
|
|
|
### Custom Render
|
|
|
|
```html
|
|
<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 | Triggered on page change | - |
|
|
|
|
### Slots
|
|
|
|
| Name | Description | Default |
|
|
| --- | --- | --- |
|
|
| prev-text | custom prev slot | `-` |
|
|
| next-text | custom next slot | `-` |
|
|
| page | pagination item slot | `{ number: number, text: string, active: boolean }` |
|