- components
- ›
- pagination
- ›
- react
Pagination
Navigate between multiple pages of content.
ID | Name | Country | |
---|---|---|---|
1 | Maurice Kunde | Kamren18@yahoo.com | Christmas Island |
2 | Brian Rippin | Krystel_Breitenberg27@yahoo.com | French Guiana |
3 | Bobby Schaden | Trevion.Deckow@hotmail.com | Isle of Man |
4 | Frank Lind | Imogene70@gmail.com | Japan |
5 | Marilyn O'Keefe | Brannon56@yahoo.com | Northern Mariana Islands |
6 | Mario Hodkiewicz | Nestor_McGlynn44@hotmail.com | Brunei Darussalam |
7 | Andy Kutch-Ernser | Adonis.Effertz@gmail.com | Cape Verde |
8 | Glenn Schulist | Mason.Stehr@yahoo.com | Thailand |
9 | Brendan Nikolaus | Karlee_Paucek14@gmail.com | Syrian Arab Republic |
10 | Eva Russel | Hallie57@hotmail.com | Curacao |
Page Size
ID | Name | Country | |
---|---|---|---|
1 | Phyllis Emmerich III | Caitlyn.VonRueden18@hotmail.com | Congo |
2 | Jenny Douglas | Darrell.Herzog@gmail.com | Myanmar |
3 | Ana Moen | Leonardo85@yahoo.com | South Africa |
4 | Zachary Kihn | Salma_Cartwright58@yahoo.com | El Salvador |
5 | Josh Barton | Anna.Harris@hotmail.com | Niue |
6 | Terrance Will V | Carmela21@hotmail.com | Vietnam |
7 | Adrienne Dietrich | Tatyana16@gmail.com | Palau |
8 | Brendan Stehr | Buster26@gmail.com | Aruba |
9 | Harry Dooley Sr. | Marianna27@gmail.com | Puerto Rico |
10 | Maureen Hilll | Lilyan_Beahan53@gmail.com | Suriname |
Direction
ID | Name | Country | |
---|---|---|---|
1 | Sergio Quitzon | Trace.Hilpert@yahoo.com | Japan |
2 | Douglas Fay | Bethel.Kulas@gmail.com | Virgin Islands, U.S. |
3 | Candice Jerde | Vito39@hotmail.com | Sweden |
4 | Gene Lakin | Dina84@hotmail.com | Seychelles |
5 | Carroll O'Hara Sr. | Josie.Crooks@gmail.com | New Zealand |
6 | Victor Durgan | Blanche_Mitchell40@yahoo.com | Western Sahara |
7 | Rodolfo Mueller | Maymie.Tillman31@gmail.com | Saint Martin |
8 | Elsa Kohler-Bashirian | Barton.Carter@hotmail.com | Mauritania |
9 | Wayne Heidenreich | Lina.Kuhn@yahoo.com | Saint Barthelemy |
10 | Claudia Renner | Lyric.Harvey27@hotmail.com | Montenegro |
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 |