1. components
  2. pagination
  3. react

Pagination

Navigate between multiple pages of content.

IDNameEmailCountry
1Louise HauckLucienne29@hotmail.comComoros
2Thelma GulgowskiLeola.Smith69@yahoo.comCosta Rica
3Mr. Steve MaggioMarge_Johnson21@hotmail.comAngola
4Frankie ConroyRuben.Marquardt@gmail.comHong Kong
5Sophie AbshireLelah32@yahoo.comBonaire, Sint Eustatius and Saba
6Stanley BayerRandi67@hotmail.comColombia
7Johnny ProhaskaWalker.Corkery@gmail.comEritrea
8Sheryl TrantowOsbaldo94@yahoo.comBelgium
9Guy Dare DVMDeion21@gmail.comTrinidad and Tobago
10Angel KeelingTate_Rice@hotmail.comDominican Republic

Page Size

IDNameEmailCountry
1Deborah MillerLeopoldo.Purdy@hotmail.comTuvalu
2Fredrick RatkeWilbert_Bauch91@yahoo.comNicaragua
3Johnathan SporerJunius_Satterfield9@hotmail.comTurkmenistan
4Zachary KonopelskiWill88@yahoo.comTanzania
5Joann BinsEryn72@yahoo.comGuinea
6Shaun BaileyIbrahim.Osinski95@gmail.comGuyana
7Regina Maggio-SanfordMariano.Monahan54@hotmail.comKenya
8Kevin GutkowskiGarth30@yahoo.comMontserrat
9Olga BaumbachLester_Hauck@yahoo.comDjibouti
10Evelyn TrantowDallas22@gmail.comPhilippines

Direction

IDNameEmailCountry
1Clay PaucekGarrett_Armstrong@gmail.comMorocco
2Mr. Bernard WaelchiMiles11@gmail.comRomania
3Bradley LakinJamie.Littel80@gmail.comCambodia
4Amy BeahanShawn70@gmail.comNetherlands
5Angela QuitzonLeone_Murray@yahoo.comReunion
6Sandy Hansen VJimmie.Goldner@yahoo.comMyanmar
7Mae Mueller VDawn.Luettgen@gmail.comMexico
8Tina HuelsEra71@yahoo.comTuvalu
9Mrs. Essie UptonMaynard_Mayer13@yahoo.comGeorgia
10Wayne BahringerChristine_Bashirian@yahoo.comSouth Georgia and the South Sandwich Islands

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