| ID | Name | Country | |
|---|---|---|---|
| 1 | Tyler Reynolds | Shaylee95@yahoo.com | Slovenia |
| 2 | Erik Runolfsson | Fritz.Corkery@hotmail.com | Madagascar |
| 3 | Ronald Sawayn | Abner88@gmail.com | Saint Barthelemy |
| 4 | Diana Bailey | Aniyah.Reichel76@hotmail.com | New Caledonia |
| 5 | Morris Ondricka | Makenzie93@yahoo.com | Liechtenstein |
Page Size
| ID | Name | Country | |
|---|---|---|---|
| 1 | Emilio Kunze | Merlin99@hotmail.com | Comoros |
| 2 | Faith Hoppe | Darrion_Jacobs-Rosenbaum@hotmail.com | Bermuda |
| 3 | Kelly Barton II | Jasen86@hotmail.com | Tanzania |
| 4 | Judy Predovic | Marisol22@hotmail.com | Seychelles |
| 5 | Tasha Krajcik | Leonora.Kutch5@hotmail.com | Papua New Guinea |
Direction
| ID | Name | Country | |
|---|---|---|---|
| 1 | Rochelle O'Conner | Pedro_Wilderman29@gmail.com | Democratic Republic of the Congo |
| 2 | Patrick Mayer | Esmeralda_Connelly@gmail.com | Latvia |
| 3 | Dana King | Demetrius_Kutch75@hotmail.com | Central African Republic |
| 4 | Dr. Pat Predovic | Wyatt.Halvorson91@yahoo.com | Austria |
| 5 | Russell Erdman | Harvey_Ryan81@yahoo.com | Martinique |
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
inline-flex gap-2 p-2 rounded-container preset-outlined-surface-200-800 w-fit| Prop | 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 | undefined Specifies the localized strings that identifies the accessibility elements and their states |
count | — | number | undefined Total number of data items |
pageSize | — | number | undefined The controlled number of data items per page |
defaultPageSize | 10 | number | undefined The 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 | undefined Number of pages to show beside active page |
page | — | number | undefined The controlled active page |
defaultPage | 1 | number | undefined The initial active page when rendered. Use when you don't need to control the active page of the pagination. |
onPageChange | — | ((details: PageChangeDetails) => void) | undefined Called when the page number is changed |
onPageSizeChange | — | ((details: PageSizeChangeDetails) => void) | undefined Called when the page size is changed |
type | "button" | "button" | "link" | undefined The type of the trigger element |
getPageUrl | — | ((details: PageUrlDetails) => string) | undefined Function to generate href attributes for pagination links. Only used when `type` is set to "link". |
dir | "ltr" | "ltr" | "rtl" | undefined The document's text/writing direction. |
getRootNode | — | (() => ShadowRoot | Node | Document) | undefined A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron. |
element | — | ((attributes: HTMLAttributes<"nav">) => Element) | undefined Render the element yourself |
Provider
| Prop | Default | Type |
|---|---|---|
value | — | PaginationApi<PropTypes> |
element | — | ((attributes: HTMLAttributes<"nav">) => Element) | undefined Render the element yourself |
Context
| Prop | Default | Type |
|---|---|---|
children | — | (pagination: PaginationApi<PropTypes>) => ReactNode |
FirstTrigger
btn btn-sm preset-tonal| Prop | Default | Type |
|---|---|---|
element | — | ((attributes: HTMLAttributes<"button">) => Element) | undefined Render the element yourself |
PrevTrigger
btn btn-sm preset-tonal| Prop | Default | Type |
|---|---|---|
element | — | ((attributes: HTMLAttributes<"button">) => Element) | undefined Render the element yourself |
Item
btn btn-sm preset-tonal cursor-pointer select-none data-selected:preset-filled| Prop | Default | Type |
|---|---|---|
type | — | "page" |
value | — | number |
element | — | ((attributes: HTMLAttributes<"a">) => Element) | undefined Render the element yourself |
Ellipsis
btn btn-sm preset-tonal pointer-events-none| Prop | Default | Type |
|---|---|---|
index | — | number |
element | — | ((attributes: HTMLAttributes<"span">) => Element) | undefined Render the element yourself |
NextTrigger
btn btn-sm preset-tonal| Prop | Default | Type |
|---|---|---|
element | — | ((attributes: HTMLAttributes<"button">) => Element) | undefined Render the element yourself |
LastTrigger
btn btn-sm preset-tonal| Prop | Default | Type |
|---|---|---|
element | — | ((attributes: HTMLAttributes<"button">) => Element) | undefined Render the element yourself |
Root
inline-flex gap-2 p-2 rounded-container preset-outlined-surface-200-800 w-fit| Prop | 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 | undefined Specifies the localized strings that identifies the accessibility elements and their states |
count | — | number | undefined Total number of data items |
pageSize | — | number | undefined The controlled number of data items per page |
defaultPageSize | 10 | number | undefined The 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 | undefined Number of pages to show beside active page |
page | — | number | undefined The controlled active page |
defaultPage | 1 | number | undefined The initial active page when rendered. Use when you don't need to control the active page of the pagination. |
onPageChange | — | ((details: PageChangeDetails) => void) | undefined Called when the page number is changed |
onPageSizeChange | — | ((details: PageSizeChangeDetails) => void) | undefined Called when the page size is changed |
type | "button" | "button" | "link" | undefined The type of the trigger element |
getPageUrl | — | ((details: PageUrlDetails) => string) | undefined Function to generate href attributes for pagination links. Only used when `type` is set to "link". |
dir | "ltr" | "ltr" | "rtl" | undefined The document's text/writing direction. |
getRootNode | — | (() => ShadowRoot | Node | Document) | undefined A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron. |
element | — | Snippet<[HTMLAttributes<"div">]> | undefined Render the element yourself |
Provider
| Prop | Default | Type |
|---|---|---|
value | — | () => PaginationApi<PropTypes> |
element | — | Snippet<[HTMLAttributes<"div">]> | undefined Render the element yourself |
Context
| Prop | Default | Type |
|---|---|---|
children | — | Snippet<[() => PaginationApi<PropTypes>]> |
FirstTrigger
btn btn-sm preset-tonal| Prop | Default | Type |
|---|---|---|
element | — | Snippet<[HTMLAttributes<"button">]> | undefined Render the element yourself |
PrevTrigger
btn btn-sm preset-tonal| Prop | Default | Type |
|---|---|---|
element | — | Snippet<[HTMLAttributes<"button">]> | undefined Render the element yourself |
Item
btn btn-sm preset-tonal cursor-pointer select-none data-selected:preset-filled| Prop | Default | Type |
|---|---|---|
type | — | "page" |
value | — | number |
element | — | Snippet<[HTMLAttributes<"a">]> | undefined Render the element yourself |
Ellipsis
btn btn-sm preset-tonal pointer-events-none| Prop | Default | Type |
|---|---|---|
index | — | number |
element | — | Snippet<[HTMLAttributes<"span">]> | undefined Render the element yourself |
NextTrigger
btn btn-sm preset-tonal| Prop | Default | Type |
|---|---|---|
element | — | Snippet<[HTMLAttributes<"button">]> | undefined Render the element yourself |
LastTrigger
btn btn-sm preset-tonal| Prop | Default | Type |
|---|---|---|
element | — | Snippet<[HTMLAttributes<"button">]> | undefined Render the element yourself |