You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

37 lines
1.5 KiB

---
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.
8 years ago
## When To Use
- When it will take a long time to load/render all items.
- If you want to browse the data by switching in the pages.
## API
```html
<Pagination onChange={onChange} total={50} />
```
Property | Description | Type | Default
-----|-----|-----|------
current | current page number | number | -
defaultCurrent | default current page number | number | 1
total | total number of data | number | 0
defaultPageSize | default number of data per page | number | 10
pageSize | number of data per page | number | -
onChange | a callback function, can be executed when the page number is changing, 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 selections | string[] | ['10', '20', '30', '40']
onShowSizeChange | a callback function, can be executed when `pageSize` is changing | Function(current, size) | noop
showQuickJumper | determine whether you can jump to a page 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') => React.ReactNode | - |