element/examples/docs/zh-CN/pagination.md

222 lines
6.2 KiB
Markdown
Raw Normal View History

## Pagination 分页
当数据量过多时,使用分页分解数据。
### 基础用法
2016-07-27 06:15:02 +00:00
:::demo 设置`layout`,表示需要显示的内容,用逗号分隔,布局元素会依次显示。`prev`表示上一页,`next`为上一页,`pager`表示页码列表,除此以外还提供了`jumper`和`total``size`和特殊的布局符号`->``->`后的元素会靠右显示,`jumper`表示跳页元素,`total`表示显示页码总数,`size`用于设置每页显示的页码数量。
2016-07-27 06:15:02 +00:00
```html
<div class="block">
<span class="demonstration">页数较少时的效果</span>
<el-pagination
layout="prev, pager, next"
:total="50">
</el-pagination>
</div>
<div class="block">
2016-09-07 06:18:17 +00:00
<span class="demonstration">大于 7 页时的效果</span>
<el-pagination
layout="prev, pager, next"
:total="1000">
</el-pagination>
</div>
</div>
2016-07-27 06:15:02 +00:00
```
:::
2016-07-27 06:15:02 +00:00
### 小型分页
在空间有限的情况下,可以使用简单的小型分页。
2016-07-27 06:15:02 +00:00
:::demo 只需要一个`small`属性,它接受一个`Boolean`,默认为`false`,设为`true`即可启用。
2016-07-27 06:15:02 +00:00
```html
<el-pagination
small
layout="prev, pager, next"
:total="50">
</el-pagination>
```
:::
2016-07-27 06:15:02 +00:00
### 附加功能
2016-07-27 06:15:02 +00:00
根据场景需要,可以添加其他功能模块。
:::demo 此例是一个完整的用例,使用了`size-change`和`current-change`事件来处理页码大小和当前页变动时候触发的事件。`page-sizes`接受一个整型数组,数组元素为展示的选择每页显示个数的选项,`[100, 200, 300, 400]`表示四个选项,每页显示 100 个200 个300 个或者 400 个。
2016-07-27 06:15:02 +00:00
```html
<template>
<div class="block">
<span class="demonstration">显示总数</span>
<el-pagination
@size-change="handleSizeChange"
@current-change="handleCurrentChange"
2016-11-28 03:15:07 +00:00
:current-page="currentPage1"
:page-size="100"
layout="total, prev, pager, next"
:total="1000">
</el-pagination>
</div>
<div class="block">
<span class="demonstration">调整每页显示条数</span>
<el-pagination
@size-change="handleSizeChange"
@current-change="handleCurrentChange"
2016-11-28 03:15:07 +00:00
:current-page="currentPage2"
: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">直接前往</span>
<el-pagination
@size-change="handleSizeChange"
@current-change="handleCurrentChange"
2016-11-28 03:15:07 +00:00
:current-page="currentPage3"
:page-size="100"
layout="prev, pager, next, jumper"
:total="1000">
</el-pagination>
</div>
<div class="block">
<span class="demonstration">完整功能</span>
<el-pagination
@size-change="handleSizeChange"
@current-change="handleCurrentChange"
2016-11-28 03:15:07 +00:00
:current-page="currentPage4"
: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} 条`);
},
handleCurrentChange(val) {
this.currentPage = val;
console.log(`当前页: ${val}`);
}
},
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
};
}
}
</script>
2016-07-27 06:15:02 +00:00
```
:::
<script>
2016-12-26 03:41:15 +00:00
import { addClass } from 'element-ui/src/utils/dom';
export default {
methods: {
handleSizeChange(val) {
this.currentPage = val;
console.log(`每页 ${val} 条`);
},
handleCurrentChange(val) {
console.log(`当前页: ${val}`);
}
},
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
};
},
mounted() {
this.$nextTick(() => {
let demos = document.querySelectorAll('.source');
let firstDemo = demos[0];
let lastDemo = demos[demos.length - 1];
2016-11-06 07:37:35 +00:00
addClass(firstDemo, 'first');
addClass(lastDemo, 'last');
});
}
}
</script>
2016-09-06 04:47:25 +00:00
<style>
2016-09-07 06:18:17 +00:00
.demo-pagination .source.first {
padding: 0;
}
.demo-pagination .first .block {
padding: 30px 0;
text-align: center;
border-right: solid 1px #EFF2F6;
2016-11-06 07:37:35 +00:00
float: left;
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;
}
2016-09-07 06:18:17 +00:00
.demo-pagination .source.last {
padding: 0;
}
.demo-pagination .last .block {
padding: 30px 24px;
border-bottom: solid 1px #EFF2F6;
&:last-child {
2016-10-21 08:14:14 +00:00
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%;
2016-09-07 06:18:17 +00:00
margin: 5px 20px 0 0;
2016-08-30 11:06:15 +00:00
}
2016-09-06 04:47:25 +00:00
</style>
2016-08-30 11:06:15 +00:00
### Attributes
2016-07-27 06:15:02 +00:00
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|--------------------|----------------------------------------------------------|-------------------|-------------|--------|
| small | 是否使用小型分页样式 | Boolean | — | false |
| page-size | 每页显示条目个数 | Number | — | 10 |
2016-12-29 12:53:33 +00:00
| total | 总条目数 | Number | — | — |
| page-count | 总页数total 和 page-count 设置任意一个就可以达到显示页码的功能;如果要支持 page-sizes 的更改,则需要使用 total 属性 | Number | — | — |
| current-page | 当前页数 | Number | — | 1 |
2016-12-20 03:20:57 +00:00
| layout | 组件布局,子组件名用逗号分隔| String | `sizes`, `prev`, `pager`, `next`, `jumper`, `->`, `total`, `slot` | 'prev, pager, next, jumper, ->, total' |
2016-09-02 05:56:47 +00:00
| page-sizes | 每页显示个数选择器的选项设置 | Number[] | — | [10, 20, 30, 40, 50, 100] |
### Events
| 事件名称 | 说明 | 回调参数 |
|---------|--------|---------|
| size-change | pageSize 改变时会触发 | 每页条数`size` |
| current-change | currentPage 改变时会触发 | 当前页`currentPage` |
2016-12-20 03:20:57 +00:00
### Slot
| name | 说明 |
|------|--------|
| — | 自定义内容,需要在 `layout` 中列出 `slot` |