ant-design/components/pagination/index.en-US.md

43 lines
2.2 KiB
Markdown
Raw Normal View History

2016-07-29 10:15:31 +08:00
---
category: Components
type: Navigation
title: Pagination
2017-02-18 18:12:38 +08:00
cols: 1
cover: https://gw.alipayobjects.com/zos/alicdn/1vqv2bj68/Pagination.svg
2016-07-29 10:15:31 +08:00
---
A long list can be divided into several pages using `Pagination`, and only one page will be loaded at a time.
2016-07-29 10:15:31 +08:00
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 navigating through pages.
2016-07-29 10:15:31 +08:00
## API
2019-12-26 14:37:39 +08:00
```jsx
<Pagination onChange={onChange} total={50} />
2016-07-29 10:15:31 +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 | |
2019-11-22 10:33:34 +08:00
| 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`] | |
| responsive | If `size` is not specified, `Pagination` would resize according to the width of the window | boolean | - | |
2019-11-22 10:33:34 +08:00
| showLessItems | Show less page items | boolean | false | |
| showQuickJumper | Determine whether you can jump to pages directly | boolean \| { goButton: ReactNode } | false | |
2020-07-10 15:18:40 +08:00
| 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` | `default` | |
| total | Total number of data items | number | 0 | |
| onChange | Called when the page number or `pageSize` is changed, and it takes the resulting page number and pageSize as its arguments | function(page, pageSize) | - | |
| onShowSizeChange | Called when `pageSize` is changed | function(current, size) | - | |