- components
- ›
- pagination
- ›
- react
Pagination
Navigate between multiple pages of content.
ID | Name | Country | |
---|---|---|---|
1 | Randal Labadie | Humberto.Rippin@gmail.com | Bahamas |
2 | Charlene Bins | Erin.Schmitt45@hotmail.com | Portugal |
3 | Duane Koepp | Roberto.Metz36@gmail.com | Indonesia |
4 | Terry Veum | Garfield69@gmail.com | Kuwait |
5 | Dr. Marion Willms | Ernestina5@yahoo.com | Niger |
6 | Jerome Cronin | Amie.Herzog@hotmail.com | South Africa |
7 | Nicole Lehner-Veum I | Moriah14@yahoo.com | Cambodia |
8 | Ross Senger | Allan_Bartoletti36@yahoo.com | Nauru |
9 | Antonia Bechtelar | Danika28@gmail.com | Tokelau |
10 | Victor Gottlieb | Leonard.Huel-Hilpert26@hotmail.com | French Southern Territories |
Page Size
ID | Name | Country | |
---|---|---|---|
1 | Courtney Baumbach | Breanna.Grady@yahoo.com | South Africa |
2 | Leona Rempel | Corbin84@gmail.com | Ecuador |
3 | Kelly Heidenreich IV | Karlie.Boehm@yahoo.com | Austria |
4 | Latoya McLaughlin | Harmon28@hotmail.com | Zambia |
5 | Angel Kris | Myrl58@gmail.com | Cape Verde |
6 | Lee Stroman DVM | Dock72@hotmail.com | Mali |
7 | Mrs. Nichole Hermiston | Lavada.Upton@yahoo.com | Lebanon |
8 | Preston Jones | Tess_OKon96@yahoo.com | Iceland |
9 | Todd Wolf | Kim67@gmail.com | Bonaire, Sint Eustatius and Saba |
10 | Muriel Satterfield | Rachel_Rogahn@yahoo.com | United States Minor Outlying Islands |
Direction
ID | Name | Country | |
---|---|---|---|
1 | Delia Kuvalis | Lonny.Emmerich@gmail.com | Slovenia |
2 | Jennie Adams | Nakia.Nicolas@hotmail.com | Colombia |
3 | Martin Jaskolski | Philip.Schultz43@gmail.com | Switzerland |
4 | Marion Johns | Lila.Rohan46@yahoo.com | Tonga |
5 | Kelli Lubowitz | Craig0@yahoo.com | Switzerland |
6 | Micheal Towne II | Bernie.Mante94@gmail.com | Guernsey |
7 | Vanessa Ratke | Magali_Welch97@hotmail.com | Jersey |
8 | Daniel McKenzie | Brandyn0@hotmail.com | Liechtenstein |
9 | Gretchen Mohr-Larson DVM | Griffin_Wilderman5@yahoo.com | Marshall Islands |
10 | Bill Walter | Grover22@gmail.com | American Samoa |
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; }> | undefinedThe ids of the elements in the accordion. Useful for composition. |
translations | - | IntlTranslations | undefinedSpecifies the localized strings that identifies the accessibility elements and their states |
count | - | number | undefinedTotal number of data items |
pageSize | - | number | undefinedThe controlled number of data items per page |
defaultPageSize | 10 | number | undefinedThe 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 | undefinedNumber of pages to show beside active page |
page | - | number | undefinedThe controlled active page |
defaultPage | 1 | number | undefinedThe initial active page when rendered. Use when you don't need to control the active page of the pagination. |
onPageChange | - | ((details: PageChangeDetails) => void) | undefinedCalled when the page number is changed |
onPageSizeChange | - | ((details: PageSizeChangeDetails) => void) | undefinedCalled when the page size is changed |
type | "button" | "button" | "link" | undefinedThe type of the trigger element |
getPageUrl | - | ((details: PageUrlDetails) => string) | undefinedFunction to generate href attributes for pagination links. Only used when `type` is set to "link". |
dir | "ltr" | "ltr" | "rtl" | undefinedThe document's text/writing direction. |
getRootNode | - | (() => ShadowRoot | Node | Document) | undefinedA root node to correctly resolve document in custom environments. E.x.: Iframes, Electron. |
element | - | ((attributes: HTMLAttributes<"nav">) => Element) | undefinedRender the element yourself |
RootProvider
Property | Default | Type |
---|---|---|
value | - | PaginationApi<PropTypes> |
element | - | ((attributes: HTMLAttributes<"nav">) => Element) | undefinedRender the element yourself |
RootContext
Property | Default | Type |
---|---|---|
children | - | (pagination: PaginationApi<PropTypes>) => ReactNode |
PrevTrigger
Property | Default | Type |
---|---|---|
element | - | ((attributes: HTMLAttributes<"button">) => Element) | undefinedRender the element yourself |
Item
Property | Default | Type |
---|---|---|
type | - | "page" |
value | - | number |
element | - | ((attributes: HTMLAttributes<"a">) => Element) | undefinedRender the element yourself |
Ellipsis
Property | Default | Type |
---|---|---|
index | - | number |
element | - | ((attributes: HTMLAttributes<"span">) => Element) | undefinedRender the element yourself |
NextTrigger
Property | Default | Type |
---|---|---|
element | - | ((attributes: HTMLAttributes<"button">) => Element) | undefinedRender the element yourself |