2020-07-06 16:53:02 +08:00

68 lines
1.4 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
/>
```
## 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 | - |