1. components
  2. pagination
  3. react

Pagination

Navigate between multiple pages of content.

IDNameEmailCountry
1Kenny KulasAstrid_Morar74@yahoo.comMalta
2Kellie OndrickaCyrus52@hotmail.comGuinea-Bissau
3Felipe SchmidtSyble86@hotmail.comPalestine
4Paula ZemlakCasimir_Torphy@gmail.comMauritania
5Miss Heidi PourosCarol_Hettinger77@gmail.comGrenada
6Timothy FarrellMurl.Yost@hotmail.comJordan
7Luke Doyle Sr.Coleman63@yahoo.comBulgaria
8Mr. Sergio CollinsAlessandro51@gmail.comRussian Federation
9Allen PaucekWendell.Farrell60@yahoo.comFalkland Islands (Malvinas)
10Erin Dicki IIOtis5@gmail.comEcuador

Page Size

IDNameEmailCountry
1Wendy HesselAlbin.Gottlieb@yahoo.comNiger
2Camille Kuvalis Sr.Faustino_Hermiston86@yahoo.comGrenada
3Jon SporerJulian.Bode@hotmail.comUnited States of America
4Angelina CronaRaphael_Collier@gmail.comBosnia and Herzegovina
5Neal LindgrenMoses_Hudson56@yahoo.comLatvia
6Michele NaderEaston34@gmail.comBrazil
7Carla McDermott DDSJustice35@hotmail.comYemen
8Brenda BeckerJailyn_Murphy32@yahoo.comChina
9Jenna CruickshankAngie.Ondricka@yahoo.comHungary
10Jan FunkElbert_Streich@yahoo.comThailand

Direction

IDNameEmailCountry
1Veronica BrakusAryanna.Bechtelar@hotmail.comIceland
2Mr. Dominic RunolfsdottirLucio52@hotmail.comIceland
3Franklin TrantowEmmanuelle_OKeefe@hotmail.comVietnam
4Molly LubowitzBenedict_Pouros45@yahoo.comSvalbard & Jan Mayen Islands
5Kristi MayertMorgan_Crona@yahoo.comSweden
6Dr. Drew ConnFlorida32@yahoo.comChad
7Philip Powlowski MDMichale_Sawayn70@hotmail.comVirgin Islands, British
8Larry BeattyVergie88@hotmail.comKyrgyz Republic
9Lillian DeckowElna_Hartmann@hotmail.comCroatia
10Debbie RaynorMarianna.Jast@gmail.comMali

Total Count

For server-side pagination, your data source may be truncated. Make sure to specify the total records using count.

{
"data": [...],
"pagination": {
"page": 1,
"limit": 10,
"count": 500,
}
}
<Pagination
page={response.pagination.page}
count={response.pagination.count}
pageSize={response.pagination.limit}
>
...
</Pagination>

API Reference

Root

Property Default Type
ids -
Partial<{ root: string; ellipsis: (index: number) => string; prevTrigger: string; nextTrigger: string; item: (page: number) => string; }> | undefined
The ids of the elements in the accordion. Useful for composition.
translations -
IntlTranslations | undefined
Specifies the localized strings that identifies the accessibility elements and their states
count -
number | undefined
Total number of data items
pageSize -
number | undefined
The controlled number of data items per page
defaultPageSize 10
number | undefined
The initial number of data items per page when rendered. Use when you don't need to control the page size of the pagination.
siblingCount 1
number | undefined
Number of pages to show beside active page
page -
number | undefined
The controlled active page
defaultPage 1
number | undefined
The initial active page when rendered. Use when you don't need to control the active page of the pagination.
onPageChange -
((details: PageChangeDetails) => void) | undefined
Called when the page number is changed
onPageSizeChange -
((details: PageSizeChangeDetails) => void) | undefined
Called when the page size is changed
type "button"
"button" | "link" | undefined
The type of the trigger element
getPageUrl -
((details: PageUrlDetails) => string) | undefined
Function to generate href attributes for pagination links. Only used when `type` is set to "link".
dir "ltr"
"ltr" | "rtl" | undefined
The document's text/writing direction.
getRootNode -
(() => ShadowRoot | Node | Document) | undefined
A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.
element -
((attributes: HTMLAttributes<"nav">) => Element) | undefined
Render the element yourself

RootProvider

Property Default Type
value -
PaginationApi<PropTypes>
element -
((attributes: HTMLAttributes<"nav">) => Element) | undefined
Render the element yourself

RootContext

Property Default Type
children -
(pagination: PaginationApi<PropTypes>) => ReactNode

PrevTrigger

Property Default Type
element -
((attributes: HTMLAttributes<"button">) => Element) | undefined
Render the element yourself

Item

Property Default Type
type -
"page"
value -
number
element -
((attributes: HTMLAttributes<"a">) => Element) | undefined
Render the element yourself

Ellipsis

Property Default Type
index -
number
element -
((attributes: HTMLAttributes<"span">) => Element) | undefined
Render the element yourself

NextTrigger

Property Default Type
element -
((attributes: HTMLAttributes<"button">) => Element) | undefined
Render the element yourself