mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-24 19:19:57 +08:00
3c7626ede2
* update pagination related doc * Update components/pagination/index.en-US.md Co-Authored-By: 偏右 <afc163@gmail.com> Co-authored-by: 偏右 <afc163@gmail.com>
2.1 KiB
2.1 KiB
category | type | title | cols |
---|---|---|---|
Components | Navigation | Pagination | 1 |
A long list can be divided into several pages using 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 | - | |
hideOnSinglePage | Whether to hide pager on single page | boolean | false | |
itemRender | To customize item's 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', '50', '100'] | |
showLessItems | Show less page items | boolean | false | |
showQuickJumper | Determine whether you can jump to pages directly | boolean | { goButton: ReactNode } |
false | |
showSizeChanger | Determine whether to show pageSize select, it will be true when total>=50 |
boolean | - | |
showTitle | Show page item's title | boolean | true | |
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 . |
'default' | 'small'. | "" | |
responsive | If size is not specified, Pagination would resize according to the width of the window |
boolean | - | |
total | Total number of data items | number | 0 | |
onChange | Called when the page number is changed, and it takes the resulting page number and pageSize as its arguments | Function(page, pageSize) | noop | |
onShowSizeChange | Called when pageSize is changed |
Function(current, size) | noop |