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.
2017-09-08 09:45:56 +08:00
- If you want to browse the data by navigating through pages.
2016-07-29 10:15:31 +08:00
## API
```html
2019-05-07 14:57:32 +08:00
< Pagination onChange = "{onChange}" total = "{50}" / >
2016-07-29 10:15:31 +08:00
```
2019-05-10 15:38:35 +08:00
| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
| current | current page number | number | - | |
| defaultCurrent | default initial page number | number | 1 | |
| defaultPageSize | default number of data items per page | number | 10 | |
| disabled | disable pagination | boolean | - | 3.18.0 |
2019-07-11 14:14:33 +08:00
| hideOnSinglePage | Whether to hide pager on single page | boolean | false | 3.1.0 |
2019-05-10 15:38:35 +08:00
| itemRender | to customize item innerHTML | (page, type: 'page' \| 'prev' \| 'next', originalElement) => React.ReactNode | - | |
| pageSize | number of data items per page | number | - | |
| pageSizeOptions | specify the sizeChanger options | string\[] | \['10', '20', '30', '40'] | |
2019-07-11 14:14:33 +08:00
| showLessItems | show less page items | boolean | false | 3.16.3 |
2019-05-10 15:38:35 +08:00
| showQuickJumper | determine whether you can jump to pages directly | boolean \| `{ goButton: ReactNode }` | false | |
| showSizeChanger | determine whether `pageSize` can be changed | boolean | false | |
2019-07-11 14:14:33 +08:00
| showTitle | show page items title | boolean | true | 3.19.3 |
2019-05-10 15:38:35 +08:00
| showTotal | to display the total number and range | Function(total, range) | - | |
| simple | whether to use simple mode | boolean | - | |
| size | specify the size of `Pagination` , can be set to `small` | string | "" | |
| total | total number of data items | number | 0 | |
| onChange | a callback function, executed when the page number is changed, and it takes the resulting page number and pageSize as its arguments | Function(page, pageSize) | noop | |
| onShowSizeChange | a callback function, executed when `pageSize` is changed | Function(current, size) | noop | |
