- components
- ›
- pagination
- ›
- react
Pagination
Navigate between multiple pages of content.
ID | Name | Country | |
---|---|---|---|
1 | Jacquelyn Satterfield | Marlene_Hane94@hotmail.com | Kiribati |
2 | Mr. Preston Langosh V | Camila25@gmail.com | Nicaragua |
3 | Charlene Beatty MD | Eunice_Jacobson@yahoo.com | Oman |
4 | Geraldine Watsica | Garret_Pfannerstill@gmail.com | Libyan Arab Jamahiriya |
5 | Elias Kris IV | Jacklyn.Terry71@gmail.com | United States of America |
6 | Nancy Marvin | Favian.Reinger@yahoo.com | French Southern Territories |
7 | Angelica Corkery | Alison38@hotmail.com | Grenada |
8 | Isaac Jast | Makayla.Maggio@yahoo.com | Serbia |
9 | Kurt Bayer | Alexandrea_Johnston@hotmail.com | Andorra |
10 | Joel Stanton | Keegan.Vandervort70@yahoo.com | Burundi |
Page Size
ID | Name | Country | |
---|---|---|---|
1 | Nichole Ondricka | Clyde_Bernhard9@yahoo.com | Serbia |
2 | Michelle Hyatt | Modesta_Kling@gmail.com | Gabon |
3 | Christie Upton DDS | Dameon_Herzog56@gmail.com | Hong Kong |
4 | Robin Green | Reagan.Marvin@gmail.com | Aruba |
5 | Armando Bayer | Everette.Hackett@gmail.com | Iraq |
6 | Angelica Hegmann | Lindsey_Marks21@hotmail.com | Finland |
7 | Dr. Ivan Terry DVM | Mariano65@gmail.com | Burkina Faso |
8 | Cecil Goldner | Kurt.Mitchell@hotmail.com | Congo |
9 | Candace Cremin | Summer_Weber@yahoo.com | Gambia |
10 | Martin Lakin | Alfonzo62@gmail.com | Zimbabwe |
Direction
ID | Name | Country | |
---|---|---|---|
1 | Shelia Okuneva | Aylin.Lemke@hotmail.com | Peru |
2 | Tonya Beer | Deshawn10@gmail.com | Spain |
3 | Wilbur Ruecker | Daren.Hackett@gmail.com | Sint Maarten |
4 | Katie Feeney | Nella.Walker@hotmail.com | Jordan |
5 | Janet Rosenbaum | Neha_Donnelly@gmail.com | Burkina Faso |
6 | Carlton West | Ethelyn.Grady@hotmail.com | Denmark |
7 | Dr. Clayton Ledner MD | Juana98@gmail.com | Comoros |
8 | Willard Swift | Leo23@hotmail.com | Latvia |
9 | Katrina Heidenreich | Jan23@yahoo.com | Lao People's Democratic Republic |
10 | Jacquelyn Champlin | Carter_Crooks@gmail.com | French Southern Territories |
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 |