- components
- ›
- pagination
- ›
- react
Pagination
Navigate between multiple pages of content.
| ID | Name | Country | |
|---|---|---|---|
| 1 | Camille Nicolas-Kuhn | Pearlie_Prohaska61@yahoo.com | Sudan |
| 2 | Beth Cremin | Velda8@yahoo.com | Dominican Republic |
| 3 | Misty Kub | Chaim91@hotmail.com | Sint Maarten |
| 4 | Mrs. Katherine Jenkins | Alphonso82@yahoo.com | Uzbekistan |
| 5 | Derek Kertzmann-Stanton DVM | Leonora.Mraz71@hotmail.com | Honduras |
Page Size
| ID | Name | Country | |
|---|---|---|---|
| 1 | Cornelius Kirlin | Judd_Moen@gmail.com | Guinea-Bissau |
| 2 | June Gutkowski-Thompson | Princess_Hintz-Schinner1@hotmail.com | French Polynesia |
| 3 | Madeline Windler | Edna21@gmail.com | Grenada |
| 4 | Sheila Streich | Brent.Hahn-Marks@gmail.com | Portugal |
| 5 | Gene Cassin III | Lolita.Conroy89@hotmail.com | Czechia |
Direction
| ID | Name | Country | |
|---|---|---|---|
| 1 | Stuart Lowe | Laverne72@gmail.com | Chad |
| 2 | Mrs. Jennifer Wunsch | Cordelia_Waters@hotmail.com | New Caledonia |
| 3 | Brett Dare | Corbin.Howell13@gmail.com | Uruguay |
| 4 | Orville Muller | Doug_Bode@hotmail.com | Virgin Islands, U.S. |
| 5 | Timothy Hickle II | Rose72@yahoo.com | Tajikistan |
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 |
FirstTrigger
| Property | Default | Type |
|---|---|---|
element | - | ((attributes: HTMLAttributes<"button">) => Element) | undefinedRender the element yourself |
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 |
LastTrigger
| Property | Default | Type |
|---|---|---|
element | - | ((attributes: HTMLAttributes<"button">) => Element) | undefinedRender the element yourself |