2017-05-18 04:28:45 +00:00
< style >
.demo-pagination .source.first {
padding: 0;
}
.demo-pagination .first .block {
padding: 30px 0;
text-align: center;
border-right: solid 1px #EFF2F6 ;
2017-09-29 07:37:50 +00:00
display: inline-block;
2017-05-18 04:28:45 +00:00
width: 50%;
box-sizing: border-box;
& :last-child {
border-right: none;
}
}
.demo-pagination .first .demonstration {
display: block;
color: #8492a6 ;
font-size: 14px;
margin-bottom: 20px;
}
.demo-pagination .source.last {
padding: 0;
}
.demo-pagination .last .block {
padding: 30px 24px;
border-bottom: solid 1px #EFF2F6 ;
& :last-child {
border-bottom: none;
}
}
.demo-pagination .last .demonstration {
font-size: 14px;
color: #8492a6 ;
line-height: 44px;
}
.demo-pagination .last .demonstration + .el-pagination {
float: right;
width: 70%;
margin: 5px 20px 0 0;
}
< / style >
2016-12-26 03:41:15 +00:00
## Pagination
2016-11-10 13:46:55 +00:00
If you have too much data to display in one page, use pagination.
### Basic usage
:::demo Set `layout` with different pagination elements you wish to display separated with a comma. Pagination elements are: `prev` (a button navigating to the previous page), `next` (a button navigating to the next page), `pager` (page list), `jumper` (a jump-to input), `total` (total item count), `size` (a select to determine page size) and `->` (every element after this symbol will be pulled to the right).
```html
< div class = "block" >
< span class = "demonstration" > When you have few pages< / span >
< el-pagination
layout="prev, pager, next"
:total="50">
< / el-pagination >
< / div >
< div class = "block" >
< span class = "demonstration" > When you have more than 7 pages< / span >
2017-04-10 01:13:13 +00:00
< el-pagination
layout="prev, pager, next"
:total="1000">
< / el-pagination >
2016-11-10 13:46:55 +00:00
< / div >
```
:::
2017-11-28 10:33:15 +00:00
### Buttons with background color
:::demo Set the `background` attribute and the buttons will have a background color.
```html
< el-pagination
background
layout="prev, pager, next"
:total="1000">
< / el-pagination >
```
:::
2016-11-10 13:46:55 +00:00
### Small Pagination
Use small pagination in the case of limited space.
:::demo Just set the `small` attribute to `true` and the Pagination becomes smaller.
```html
< el-pagination
small
layout="prev, pager, next"
:total="50">
< / el-pagination >
```
:::
### More elements
Add more modules based on your scenario.
:::demo This example is a complete use case. It uses `size-change` and `current-change` event to handle page size changes and current page changes. `page-sizes` accepts an array of integers, each of which represents a different page size in the `sizes` select options, e.g. `[100, 200, 300, 400]` indicates that the select will have four options: 100, 200, 300 or 400 items per page.
```html
< template >
< div class = "block" >
< span class = "demonstration" > Total item count< / span >
< el-pagination
@size -change="handleSizeChange"
@current -change="handleCurrentChange"
2017-04-29 08:30:08 +00:00
:current-page.sync="currentPage1"
2016-11-10 13:46:55 +00:00
:page-size="100"
layout="total, prev, pager, next"
:total="1000">
< / el-pagination >
< / div >
< div class = "block" >
< span class = "demonstration" > Change page size< / span >
< el-pagination
@size -change="handleSizeChange"
@current -change="handleCurrentChange"
2017-04-29 08:30:08 +00:00
:current-page.sync="currentPage2"
2016-11-10 13:46:55 +00:00
:page-sizes="[100, 200, 300, 400]"
:page-size="100"
layout="sizes, prev, pager, next"
:total="1000">
< / el-pagination >
< / div >
< div class = "block" >
< span class = "demonstration" > Jump to< / span >
< el-pagination
@size -change="handleSizeChange"
@current -change="handleCurrentChange"
2017-04-29 08:30:08 +00:00
:current-page.sync="currentPage3"
2016-11-10 13:46:55 +00:00
:page-size="100"
layout="prev, pager, next, jumper"
:total="1000">
< / el-pagination >
< / div >
< div class = "block" >
< span class = "demonstration" > All combined< / span >
< el-pagination
@size -change="handleSizeChange"
@current -change="handleCurrentChange"
2017-04-29 08:30:08 +00:00
:current-page.sync="currentPage4"
2016-11-10 13:46:55 +00:00
:page-sizes="[100, 200, 300, 400]"
:page-size="100"
layout="total, sizes, prev, pager, next, jumper"
:total="400">
< / el-pagination >
< / div >
< / template >
< script >
export default {
methods: {
handleSizeChange(val) {
console.log(`${val} items per page`);
},
handleCurrentChange(val) {
console.log(`current page: ${val}`);
}
2016-11-24 08:03:00 +00:00
},
data() {
return {
2016-11-28 03:15:07 +00:00
currentPage1: 5,
currentPage2: 5,
currentPage3: 5,
2016-11-28 09:54:15 +00:00
currentPage4: 4
2016-11-24 08:03:00 +00:00
};
2016-11-10 13:46:55 +00:00
}
}
< / script >
```
:::
< script >
2016-12-26 03:41:15 +00:00
import { addClass } from 'element-ui/src/utils/dom';
2016-11-10 13:46:55 +00:00
export default {
2016-11-24 08:03:00 +00:00
data() {
return {
2016-11-28 03:15:07 +00:00
currentPage1: 5,
currentPage2: 5,
currentPage3: 5,
2016-11-28 09:54:15 +00:00
currentPage4: 4
2016-11-24 08:03:00 +00:00
};
},
2016-11-10 13:46:55 +00:00
methods: {
handleSizeChange(val) {
console.log(`${val} items per page`);
},
handleCurrentChange(val) {
console.log(`current page: ${val}`);
}
},
mounted() {
this.$nextTick(() => {
let demos = document.querySelectorAll('.source');
let firstDemo = demos[0];
let lastDemo = demos[demos.length - 1];
2016-11-28 09:54:15 +00:00
addClass(firstDemo, 'first');
addClass(lastDemo, 'last');
2016-11-10 13:46:55 +00:00
});
}
}
< / script >
### Attributes
| Attribute | Description | Type | Accepted Values | Default |
|--------------------|----------------------------------------------------------|-------------------|-------------|--------|
| small | whether to use small pagination | boolean | — | false |
2017-11-28 10:33:15 +00:00
| background | whether the buttons have a background color | Boolean | — | false |
2016-11-10 13:46:55 +00:00
| page-size | item count of each page | number | — | 10 |
| total | total item count | number | — | — |
| page-count | total page count. Set either `total` or `page-count` and pages will be displayed; if you need `page-sizes` , `total` is required | number | — | — |
2017-04-29 08:30:08 +00:00
| current-page | current page number, supports the .sync modifier | number | — | 1 |
2016-12-20 03:20:57 +00:00
| layout | layout of Pagination, elements separated with a comma | string | `sizes` , `prev` , `pager` , `next` , `jumper` , `->` , `total` , `slot` | 'prev, pager, next, jumper, ->, total' |
2016-11-10 13:46:55 +00:00
| page-sizes | options of item count per page | number[] | — | [10, 20, 30, 40, 50, 100] |
2017-08-06 07:52:11 +00:00
| popper-class | custom class name for the page size Select's dropdown | string | — | — |
2017-09-22 06:33:03 +00:00
| prev-text | text for the prev button | string | — | — |
| next-text | text for the next button | string | — | — |
2016-11-10 13:46:55 +00:00
### Events
| Event Name | Description | Parameters |
|---------|--------|---------|
| size-change | triggers when `page-size` changes | the new `page-size` |
| current-change | triggers when `current-page` changes | the new `current-page` |
2016-12-20 03:20:57 +00:00
### Slot
| Name | Description |
| --- | --- |
| — | custom content. To use this, you need to declare `slot` in `layout` |