- components
- ›
- pagination
- ›
- react
Pagination
Navigate between multiple pages of content.
ID | Name | Country | |
---|---|---|---|
1 | Jane Muller | Dario40@hotmail.com | Kuwait |
2 | Crystal Ward | Luisa46@hotmail.com | Libyan Arab Jamahiriya |
3 | Amos Gottlieb | Dean44@gmail.com | Philippines |
4 | Janis Koepp-Goldner | Tyra.Heaney@yahoo.com | Benin |
5 | Melvin Kessler | Camilla_Murray45@yahoo.com | Japan |
6 | Brandy Bashirian | Abigail.Kshlerin@yahoo.com | Lesotho |
7 | Ervin Grant | Lawrence.Robel39@hotmail.com | Poland |
8 | Vicky Denesik | Jeff.Harris45@yahoo.com | Greece |
9 | Diana Kemmer | Murphy97@gmail.com | Jordan |
10 | Alberto Johnson | Jermey.Grady@gmail.com | Norfolk Island |
Page Size
ID | Name | Country | |
---|---|---|---|
1 | Rosemarie Bechtelar | Jesus_Fritsch@hotmail.com | Nicaragua |
2 | Faith Leannon | Eudora88@yahoo.com | Venezuela |
3 | Micheal Stoltenberg | Kobe.Cronin@yahoo.com | Mexico |
4 | Larry Gutmann | Richard_Kuhn@yahoo.com | Iran |
5 | Arthur Sanford | Cordie_Leuschke@gmail.com | Romania |
6 | Brittany Toy | Abe.Dickens@hotmail.com | Grenada |
7 | Laura Ratke PhD | Orlo.Schaefer29@gmail.com | Bangladesh |
8 | Hannah Ullrich | Delfina95@gmail.com | Liechtenstein |
9 | Robin Kunde | Haylee61@gmail.com | Paraguay |
10 | Keith Koepp III | Zander.Batz56@gmail.com | Spain |
Direction
ID | Name | Country | |
---|---|---|---|
1 | Dr. Billie Bartoletti | Gerson46@gmail.com | Nicaragua |
2 | Bethany Kerluke | Evan9@hotmail.com | Burkina Faso |
3 | Mr. Norman Hamill | Reid88@hotmail.com | Faroe Islands |
4 | Carole Sporer | Lexus_Schulist@gmail.com | Sudan |
5 | Max Carter | Milan45@hotmail.com | China |
6 | Lindsey Williamson | Murl_Roberts79@hotmail.com | Switzerland |
7 | Jody Luettgen | Camryn_OKon@gmail.com | Estonia |
8 | Juana Sporer | Jaida.Hegmann@hotmail.com | Greece |
9 | Billie Paucek | Charley_Ortiz50@yahoo.com | Lao People's Democratic Republic |
10 | Dr. Sergio Hilll Sr. | Chad_Cronin93@hotmail.com | Dominican Republic |
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
inline-flex gap-2 p-2 rounded-container preset-outlined-surface-200-800 w-fit
Property | Default | Type |
---|---|---|
ids | - | Partial<{ root: string; ellipsis: (index: number) => string; prevTrigger: string; nextTrigger: string; item: (page: number) => string; }> | undefinedThe 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
btn preset-tonal
Property | Default | Type |
---|---|---|
element | - | ((attributes: HTMLAttributes<"button">) => Element) | undefinedRender the element yourself |
Item
btn preset-tonal cursor-pointer select-none data-selected:preset-filled
Property | Default | Type |
---|---|---|
type | - | "page" |
value | - | number |
element | - | ((attributes: HTMLAttributes<"a">) => Element) | undefinedRender the element yourself |
Ellipsis
btn preset-tonal pointer-events-none
Property | Default | Type |
---|---|---|
index | - | number |
element | - | ((attributes: HTMLAttributes<"span">) => Element) | undefinedRender the element yourself |
NextTrigger
btn preset-tonal
Property | Default | Type |
---|---|---|
element | - | ((attributes: HTMLAttributes<"button">) => Element) | undefinedRender the element yourself |