| ID | Name | Country | |
|---|---|---|---|
| 1 | Hugh Lockman | Maryam_Schimmel21@hotmail.com | Colombia |
| 2 | Allen Lubowitz | Benny_Hintz35@hotmail.com | Zambia |
| 3 | Nadine Mueller | Wilhelmine_Hirthe@hotmail.com | Madagascar |
| 4 | Jill Sauer-Corwin DVM | Gina.Kertzmann@gmail.com | Brazil |
| 5 | Ms. Suzanne Koch | Abelardo.Parisian@gmail.com | Sudan |
Page Size
| ID | Name | Country | |
|---|---|---|---|
| 1 | Mr. Gustavo Bernier | Lizeth55@hotmail.com | French Polynesia |
| 2 | Clark Reilly | Donnell29@gmail.com | Colombia |
| 3 | Brian Daniel | Ubaldo_Dooley@gmail.com | Guatemala |
| 4 | Alma Heller | Lucio.Jones@yahoo.com | Iran |
| 5 | Ella Christiansen-Simonis | Vern.Purdy@gmail.com | Australia |
Direction
| ID | Name | Country | |
|---|---|---|---|
| 1 | Mario Watsica | Durward_Brekke@yahoo.com | Gambia |
| 2 | Philip Labadie | Nicklaus_Schmitt17@gmail.com | South Africa |
| 3 | Juan Waelchi DVM | Willard61@yahoo.com | Dominican Republic |
| 4 | Dr. Scott Schmitt III | Frida80@hotmail.com | Ecuador |
| 5 | Beth Ondricka DVM | Sonia.Ebert@yahoo.com | Cuba |
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 | - | Snippet<[HTMLAttributes<"div">]> | undefinedRender the element yourself |
RootProvider
| Property | Default | Type |
|---|---|---|
value | - | () => PaginationApi<PropTypes> |
element | - | Snippet<[HTMLAttributes<"div">]> | undefinedRender the element yourself |
RootContext
| Property | Default | Type |
|---|---|---|
children | - | Snippet<[() => PaginationApi<PropTypes>]> |
PrevTrigger
| Property | Default | Type |
|---|---|---|
element | - | Snippet<[HTMLAttributes<"button">]> | undefinedRender the element yourself |
Item
| Property | Default | Type |
|---|---|---|
type | - | "page" |
value | - | number |
element | - | Snippet<[HTMLAttributes<"a">]> | undefinedRender the element yourself |
Ellipsis
| Property | Default | Type |
|---|---|---|
index | - | number |
element | - | Snippet<[HTMLAttributes<"span">]> | undefinedRender the element yourself |
NextTrigger
| Property | Default | Type |
|---|---|---|
element | - | Snippet<[HTMLAttributes<"button">]> | undefinedRender the element yourself |