Skip to main content

Pagination

Move between pages with Previous, Next & page numbers.

View as Markdown

Installation

Component API

PropTypeDefaultDescription
totalnumber-How many pages there are.
How many pages there are.
pagenumber-
defaultPagenumber1The page it starts on when uncontrolled.
The page it starts on when uncontrolled.
onPageChange(page: number) => void-Called with the new page whenever it changes.
Called with the new page whenever it changes.
siblingsnumber1Pages shown on each side of the current one before a gap.
Pages shown on each side of the current one before a gap.
previousLabelstringPreviousWhat the button before the pages says.
What the button before the pages says.
nextLabelstringNextWhat the button after the pages says.
What the button after the pages says.
ariaLabelstringPaginationWhat the landmark is called for screen readers.
What the landmark is called for screen readers.
shapenone | rounded | pillrounded
animatedbooleantrue
classNamestring-
focusboolean | stringtrue