mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-29 05:29:37 +08:00
37 lines
1.6 KiB
Markdown
37 lines
1.6 KiB
Markdown
---
|
|
category: Components
|
|
type: Navigation
|
|
title: Pagination
|
|
cols: 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
|
|
|
|
```html
|
|
<Pagination onChange={onChange} total={50} />
|
|
```
|
|
|
|
Property | Description | Type | Default
|
|
-----|-----|-----|------
|
|
current | current page number | number | -
|
|
defaultCurrent | default initial page number | number | 1
|
|
total | total number of data items | number | 0
|
|
defaultPageSize | default number of data items per page | number | 10
|
|
pageSize | number of data items per page | number | -
|
|
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
|
|
showSizeChanger | determine whether `pageSize` can be changed | boolean | false
|
|
pageSizeOptions | specify the sizeChanger options | string[] | ['10', '20', '30', '40']
|
|
onShowSizeChange | a callback function, executed when `pageSize` is changed | Function(current, size) | noop
|
|
showQuickJumper | determine whether you can jump to pages directly | boolean | false
|
|
size | specify the size of `Pagination`, can be set to `small` | string | ""
|
|
simple | whether to use simple mode | boolean | -
|
|
showTotal | to display the total number and range | Function(total, range) | -
|
|
itemRender | to customize item innerHTML | (page, type: 'page' \| 'prev' \| 'next', originalElement) => React.ReactNode | - |
|