2016-07-29 10:15:31 +08:00
---
category: Components
type: Navigation
title: Pagination
2017-02-18 18:12:38 +08:00
cols: 1
2016-07-29 10:15:31 +08:00
---
A long list can be divided into several pages by `Pagination` , and only one page will be loaded at a time.
2016-09-10 13:43:30 +08:00
## When To Use
2016-07-29 10:15:31 +08:00
- When it will take a long time to load/render all items.
- If you want to browse the data by switching in the pages.
## API
```html
< Pagination onChange = {onChange} total = {50} / >
```
Property | Description | Type | Default
-----|-----|-----|------
2017-01-20 20:10:50 +08:00
current | current page number | number | -
defaultCurrent | default current page number | number | 1
total | total number of data | number | 0
defaultPageSize | default number of data per page | number | 10
pageSize | number of data per page | number | -
2017-02-10 22:59:46 +08:00
onChange | a callback function, can be executed when the page number is changing, and it takes the resulting page number and pageSize as its arguments | Function(page, pageSize) | noop
2017-01-20 20:10:50 +08:00
showSizeChanger | determine whether `pageSize` can be changed | boolean | false
pageSizeOptions | specify the sizeChanger selections | string[] | ['10', '20', '30', '40']
2016-12-15 16:07:04 +08:00
onShowSizeChange | a callback function, can be executed when `pageSize` is changing | Function(current, size) | noop
2017-01-20 20:10:50 +08:00
showQuickJumper | determine whether you can jump to a page directly | boolean | false
size | specify the size of `Pagination` , can be set to `small` | string | ""
2017-03-06 15:48:03 +08:00
simple | whether to use simple mode | boolean | -
2016-11-22 10:12:14 +08:00
showTotal | to display the total number and range | Function(total, range) | -
2017-07-25 11:03:11 +08:00
itemRender | to customize item innerHTML | (page, type: 'page' \| 'prev' \| 'next') => React.ReactNode | - |
