- components
- ›
- pagination
- ›
- react
Pagination
Navigate between multiple pages of content.
| ID | Name | Country | |
|---|---|---|---|
| 1 | Luke Bahringer | Albertha.McKenzie@hotmail.com | Russian Federation |
| 2 | Loretta Carroll | Jamey.Schmeler43@yahoo.com | Portugal |
| 3 | Dr. Elsie Hoeger | Lazaro90@gmail.com | Philippines |
| 4 | Ana Aufderhar | Gregory.Boyer32@yahoo.com | Ecuador |
| 5 | Lora Nienow Jr. | Brayan88@yahoo.com | Puerto Rico |
Page Size
| ID | Name | Country | |
|---|---|---|---|
| 1 | Garry Hegmann | Darion.Strosin98@hotmail.com | Timor-Leste |
| 2 | Merle Nikolaus | Ibrahim_Daugherty@yahoo.com | Bermuda |
| 3 | Dexter Towne | Susie97@hotmail.com | Bouvet Island |
| 4 | Lorraine Zemlak | Sean_Gislason91@gmail.com | Palau |
| 5 | Angie Tremblay | Murphy.Bernhard97@yahoo.com | Ethiopia |
Direction
| ID | Name | Country | |
|---|---|---|---|
| 1 | Felix Ebert | Cruz67@hotmail.com | Yemen |
| 2 | Terrance Kuphal | Kane1@yahoo.com | Curacao |
| 3 | Loretta Bartoletti | Alize.Fisher60@gmail.com | Israel |
| 4 | Mr. Wilbur Douglas | Major.Trantow55@gmail.com | New Caledonia |
| 5 | Kurt Watsica MD | Jakob.Gutkowski@yahoo.com | Heard Island and McDonald Islands |
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 |