- components
- ›
- pagination
- ›
- react
Pagination
Navigate between multiple pages of content.
| ID | Name | Country | |
|---|---|---|---|
| 1 | Ted Marvin | Summer.Mayert-Kautzer19@yahoo.com | Northern Mariana Islands |
| 2 | Antonia Pacocha | Adolf.Pacocha@hotmail.com | Haiti |
| 3 | Miranda Bernier | Nicolas_Murphy79@hotmail.com | Mauritania |
| 4 | David Hand III | Vicente15@gmail.com | Zimbabwe |
| 5 | Violet Pouros | Clemmie_Effertz-Mayer54@yahoo.com | Ecuador |
Page Size
| ID | Name | Country | |
|---|---|---|---|
| 1 | Darren Bednar | Kristopher.Brakus@gmail.com | Estonia |
| 2 | Marcia Hauck | Daphnee.Kiehn8@yahoo.com | Cape Verde |
| 3 | Ira Huel | Sven79@yahoo.com | British Indian Ocean Territory (Chagos Archipelago) |
| 4 | Elena Huels | Elna.Stoltenberg96@gmail.com | Lesotho |
| 5 | Janet Rempel | Kari76@hotmail.com | Morocco |
Direction
| ID | Name | Country | |
|---|---|---|---|
| 1 | Juanita Mayer | Amya.McLaughlin1@gmail.com | Djibouti |
| 2 | Ollie Leffler | Quinn.Parisian14@hotmail.com | Greece |
| 3 | Jeffrey Krajcik | Jovany_Roberts@gmail.com | Wallis and Futuna |
| 4 | Misty Schneider | Emilio21@gmail.com | San Marino |
| 5 | Desiree Nienow | Khalid40@yahoo.com | Kuwait |
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 | 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 |