mirror of https://github.com/ElemeFE/element
60 lines
1.8 KiB
Markdown
60 lines
1.8 KiB
Markdown
# element-pagination
|
||
> A element-pagination component for Vue.js.
|
||
|
||
## Demo
|
||
http://element-component.github.io/element-pagination
|
||
|
||
## Installation
|
||
```shell
|
||
npm i element-pagination -D
|
||
```
|
||
|
||
## Usage
|
||
```javascript
|
||
import Vue from 'vue'
|
||
import ElPagination from 'element-pagination'
|
||
import 'element-theme-default/dist/pagination.css'
|
||
|
||
Vue.use(ElPagination)
|
||
```
|
||
|
||
or
|
||
|
||
```javascript
|
||
import Vue from 'vue'
|
||
import ElPagination from 'element-pagination'
|
||
|
||
Vue.component('el-pagination', ElPagination)
|
||
```
|
||
|
||
### Attributes
|
||
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|
||
|--------------------|----------------------------------------------------------|-------------------|-------------|--------|
|
||
| small | 是否使用小型分页样式 | Boolean | — | false |
|
||
| page-size | 每页显示条目个数 | Number | — | 10 |
|
||
| total | 总条目数 | Number | — | - |
|
||
| page-count | 总页数，total 和 page-count 设置任意一个就可以达到显示页码的功能；如果要支持 page-sizes 的更改，则需要使用 total 属性 | Number | — | - |
|
||
| current-page | 当前页数 | Number | — | 1 |
|
||
| layout | 组件布局，子组件名用逗号分隔| String | `sizes`, `prev`, `pager`, `next`, `jumper`, `->`, `total` | 'prev, pager, next, jumper, ->, total' |
|
||
| page-sizes | 每页显示个数选择器的选项设置 | Number[] | — | [10, 20, 30, 40, 50, 100] |
|
||
|
||
### Events
|
||
| 事件名称 | 说明 | 回调参数 |
|
||
|---------|--------|---------|
|
||
| size-change | pageSize 改变时会触发 | 每页条数`size` |
|
||
| current-change | currentPage 改变时会触发 | 当前页`currentPage` |
|
||
|
||
## Development
|
||
```shell
|
||
make dev
|
||
|
||
## test
|
||
make test
|
||
|
||
## build
|
||
make build
|
||
```
|
||
|
||
# License
|
||
[MIT](https://opensource.org/licenses/MIT)
|