docs: Document callback parameters for Pagination

This commit is contained in:
Wei Zhu 2016-12-15 16:07:04 +08:00
parent 1f9e61ee69
commit c547569d05
2 changed files with 4 additions and 4 deletions

View File

@ -24,10 +24,10 @@ defaultCurrent | default current page number | Number | 1
total | total number of data | Number | 0 total | total number of data | Number | 0
defaultPageSize | default number of data per page | Number | 10 defaultPageSize | default number of data per page | Number | 10
pageSize | number of data per page | Number | - pageSize | number of data per page | Number | -
onChange | a callback function, can be executed when the page number is changing, and it takes the resulting page number as an argument | Function | noop onChange | a callback function, can be executed when the page number is changing, and it takes the resulting page number as an argument | Function(page) | noop
showSizeChanger | determine whether `pageSize` can be changed | Boolean | false showSizeChanger | determine whether `pageSize` can be changed | Boolean | false
pageSizeOptions | specify the sizeChanger selections | Array | ['10', '20', '30', '40'] pageSizeOptions | specify the sizeChanger selections | Array | ['10', '20', '30', '40']
onShowSizeChange | a callback function, can be executed when `pageSize` is changing | Function | noop onShowSizeChange | a callback function, can be executed when `pageSize` is changing | Function(current, size) | noop
showQuickJumper | determine whether you can jump to a page directly | Boolean | false showQuickJumper | determine whether you can jump to a page directly | Boolean | false
size | specify the size of `Pagination`, can be set to `small` | String | "" size | specify the size of `Pagination`, can be set to `small` | String | ""
simple | whether to use simple mode | Object | - simple | whether to use simple mode | Object | -

View File

@ -25,10 +25,10 @@ title: Pagination
| total | 数据总数 | Number | 0 | | total | 数据总数 | Number | 0 |
| defaultPageSize | 默认的每页条数 | Number | 10 | | defaultPageSize | 默认的每页条数 | Number | 10 |
| pageSize | 每页条数 | Number | - | | pageSize | 每页条数 | Number | - |
| onChange | 页码改变的回调,参数是改变后的页码 | Function | noop | | onChange | 页码改变的回调,参数是改变后的页码 | Function(page) | noop |
| showSizeChanger | 是否可以改变 pageSize | Boolean | false | | showSizeChanger | 是否可以改变 pageSize | Boolean | false |
| pageSizeOptions | 指定每页可以显示多少条 | Array<String> | ['10', '20', '30', '40'] | | pageSizeOptions | 指定每页可以显示多少条 | Array<String> | ['10', '20', '30', '40'] |
| onShowSizeChange | pageSize 变化的回调 | Function | noop | | onShowSizeChange | pageSize 变化的回调 | Function(current, size) | noop |
| showQuickJumper | 是否可以快速跳转至某页 | Boolean | false | | showQuickJumper | 是否可以快速跳转至某页 | Boolean | false |
| size | 当为「small」时是小尺寸分页 | String | "" | | size | 当为「small」时是小尺寸分页 | String | "" |
| simple | 当添加该属性时,显示为简单分页 | Object | - | | simple | 当添加该属性时,显示为简单分页 | Object | - |