| ID | Name | Country | |
|---|---|---|---|
| 1 | Allen Schultz | Kacey2@yahoo.com | Poland |
| 2 | Ms. Stacy Hane | Ashleigh_Schmeler73@gmail.com | Sudan |
| 3 | Mr. Adam Kreiger | Allen_Bernier42@hotmail.com | Democratic Republic of the Congo |
| 4 | Owen Gutmann IV | Malachi41@yahoo.com | Papua New Guinea |
| 5 | Catherine Connelly | Madie20@yahoo.com | Burkina Faso |
| ID | Name | Country | |
|---|---|---|---|
| 1 | Leona Howe | Mabelle.Weimann55@hotmail.com | Bhutan |
| 2 | Evelyn Lang | Aaliyah.Fahey95@yahoo.com | Christmas Island |
| 3 | Carole Boyle V | Austin_Haag48@gmail.com | Holy See (Vatican City State) |
| 4 | Velma Abbott | Adeline82@hotmail.com | Australia |
| 5 | Johnny Kihn DVM | Emanuel.Koss92@yahoo.com | Central African Republic |
Page Size
| ID | Name | Country | |
|---|---|---|---|
| 1 | Thelma Mills | Adrien.Gleichner@gmail.com | South Sudan |
| 2 | Jermaine Buckridge | Shana7@gmail.com | Senegal |
| 3 | Emilio Jenkins | Jamison70@hotmail.com | Argentina |
| 4 | Marvin Bashirian | Evelyn10@hotmail.com | North Macedonia |
| 5 | Evelyn Price | Orrin.Mayert@hotmail.com | Montserrat |
Direction
| ID | Name | Country | |
|---|---|---|---|
| 1 | Courtney Tillman | Laurine_Kihn@gmail.com | Antarctica |
| 2 | Kristin Mohr | Annabell_Hettinger60@gmail.com | Kuwait |
| 3 | Jeremiah Greenfelder | Creola87@hotmail.com | Luxembourg |
| 4 | Orville Schmidt-Bashirian | Domenick17@hotmail.com | Somalia |
| 5 | Joel Koch | Ayden.Wolf@hotmail.com | Northern Mariana Islands |
Total Count
For server-side pagination, your data source may be truncated. Make sure to specify the total records using count.
const res = { "results": [...], "pagination": { "page": 1, "limit": 10, "count": 500, } }
<Pagination page={res.pagination.page} count={res.pagination.count} pageSize={res.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 |