- components
- ›
- pagination
- ›
- react
Pagination
Navigate between multiple pages of content.
| ID | Name | Country | |
|---|---|---|---|
| 1 | Mario Zemlak | Kim_Ratke11@yahoo.com | Belize |
| 2 | Rosa Grant | Dina_Williamson58@yahoo.com | Bonaire, Sint Eustatius and Saba |
| 3 | Leonard Osinski | Bernie.Bogisich79@yahoo.com | Dominican Republic |
| 4 | Theodore Hickle | Emery.Bashirian77@hotmail.com | Saudi Arabia |
| 5 | Dr. Travis Veum Sr. | Rocky.Kozey3@yahoo.com | Aland Islands |
Page Size
| ID | Name | Country | |
|---|---|---|---|
| 1 | Stewart McKenzie | Carmelo_Harvey41@gmail.com | Ethiopia |
| 2 | Lonnie Kerluke | Lyla_Leannon@hotmail.com | Zambia |
| 3 | Miss Laverne Rau | Earnest86@hotmail.com | Austria |
| 4 | Isaac Goodwin | Ethan_McGlynn32@yahoo.com | Sierra Leone |
| 5 | Marsha Kreiger | Rahsaan.Lebsack@hotmail.com | Canada |
Direction
| ID | Name | Country | |
|---|---|---|---|
| 1 | Randall Heller | Vanessa_Predovic@yahoo.com | Iraq |
| 2 | Amber Welch | Antonetta_Jerde@gmail.com | Montenegro |
| 3 | Ruth Emmerich | Dexter.Johnson96@gmail.com | Tuvalu |
| 4 | Holly Hammes | Kara_Wilderman18@hotmail.com | Timor-Leste |
| 5 | Lawrence Kuhlman | Emory.Kemmer@yahoo.com | Japan |
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 |