Pagination

A long list can be divided into several pages using Pagination, and only one page will be loaded at a time.

Pagination

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.


Basic

Basic pagination

More

More pages

Changer

Change pageSize.

Jumper

Jump to a page directly.

Simple mode

Simple mode
  • /5

Controlled

Controlled page number

Total number

You can show the total number of data by setting showTotal.
  • Total 85 items
  • 1
  • 2
  • 3
  • 4
  • 5
  • 20 / page

  • 1-20 of 85 items
  • 1
  • 2
  • 3
  • 4
  • 5
  • 20 / page

Prev and next

Use text link for prev and next button.

API

PropertyDescriptionTypeDefault
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