mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-12 15:19:58 +08:00
fb0b4f0fc9
* docs: add api first appearance * docs: fix auto-complete doc * docs: replace Version Added with Version * docs: date picker common method * docs: date picker common method * docs: tree * docs: remove meaningless 3.0.0
2.0 KiB
2.0 KiB
| category | type | title | cols |
|---|---|---|---|
| Components | Navigation | Pagination | 1 |
A long list can be divided into several pages by Pagination, and only one page will be loaded at a time.
When To Use
- When it will take a long time to load/render all items.
- If you want to browse the data by navigating through pages.
API
<Pagination onChange="{onChange}" total="{50}" />
| 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 |
| hideOnSinglePage | Whether to hide pager on single page | boolean | false | 3.1.0 |
| 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'] | |
| showLessItems | show less page items | boolean | false | 3.16.3 |
| showQuickJumper | determine whether you can jump to pages directly | boolean | { goButton: ReactNode } |
false | |
| showSizeChanger | determine whether pageSize can be changed |
boolean | false | |
| showTitle | show page items title | boolean | true | 3.19.3 |
| 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 |