- components
- ›
- pagination
- ›
- react
Pagination
Navigate between multiple pages of content.
ID | Name | Country | |
---|---|---|---|
1 | Enrique Pollich-Fadel | Wiley.Dibbert@hotmail.com | Mali |
2 | Sergio Blanda | Ahmed_Douglas@hotmail.com | Palau |
3 | Glenda Lakin | Eulah.Cummerata@hotmail.com | Lithuania |
4 | Dorothy Gottlieb | Emmanuel36@gmail.com | Russian Federation |
5 | Loretta Reichert I | Adonis.Hirthe61@gmail.com | Christmas Island |
6 | Vera Koelpin | Kaylin.Boyle@gmail.com | Malaysia |
7 | Melanie Brekke | Samara.Robel86@yahoo.com | Malawi |
8 | Ryan Kuhic | Jacinto.Koss37@hotmail.com | United States of America |
9 | Stacy Wolf | Kody.Hane23@gmail.com | French Guiana |
10 | Luther Beatty | Willy25@gmail.com | Norfolk Island |
Page Size
ID | Name | Country | |
---|---|---|---|
1 | Miss Edith Gleason | Jakayla26@gmail.com | Kuwait |
2 | Mrs. Amy Wilderman | Raheem12@yahoo.com | Guernsey |
3 | Myrtle Kuhlman | Elouise82@yahoo.com | Andorra |
4 | Miss Darla Crooks | Victoria5@yahoo.com | Curacao |
5 | Timmy Kemmer V | Evie31@gmail.com | Bouvet Island |
6 | Billy Kihn | Ruby.Franecki@yahoo.com | Tajikistan |
7 | Vincent Waelchi | Jody22@gmail.com | Vietnam |
8 | Brittany Anderson | Roxanne45@gmail.com | Gabon |
9 | Darrell Watsica PhD | Claudie71@yahoo.com | American Samoa |
10 | Clifford Gusikowski Sr. | Timmy.Lynch54@gmail.com | Cambodia |
Direction
ID | Name | Country | |
---|---|---|---|
1 | Vernon Rau III | Betsy_Dach70@gmail.com | India |
2 | Eddie Spinka | Art_Ondricka95@hotmail.com | Sao Tome and Principe |
3 | Dr. Miriam Dibbert | Name_Kreiger9@gmail.com | Dominica |
4 | Dr. Kurt Nader | Danial.Weber71@yahoo.com | Libyan Arab Jamahiriya |
5 | Ms. Patsy Upton-Kuvalis | Vada86@gmail.com | Liechtenstein |
6 | Jacquelyn Crooks | Vallie.Cole81@hotmail.com | Bermuda |
7 | Viola Collier | Aleen18@hotmail.com | Liberia |
8 | Neil Will | Vernon94@hotmail.com | Democratic Republic of the Congo |
9 | Ms. Hazel Lueilwitz-Schowalter Jr. | Bianka_Schmidt1@hotmail.com | United Arab Emirates |
10 | Evan Smith | Crystal_Beahan24@hotmail.com | Mongolia |
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
Ellipsis
btn preset-tonal pointer-events-none
Property | Default | Type |
---|---|---|
index | - | number |
element | - | ((attributes: HTMLAttributes<"span">) => 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 |
NextTrigger
btn preset-tonal
Property | Default | Type |
---|---|---|
element | - | ((attributes: HTMLAttributes<"button">) => Element) | undefinedRender the element yourself |
PrevTrigger
btn preset-tonal
Property | Default | Type |
---|---|---|
element | - | ((attributes: HTMLAttributes<"button">) => Element) | undefinedRender the element yourself |
RootProvider
Property | Default | Type |
---|---|---|
value | - | PaginationApi<PropTypes> |
element | - | ((attributes: HTMLAttributes<"nav">) => Element) | undefinedRender the element yourself |
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 |
RootContext
Property | Default | Type |
---|---|---|
children | - | (pagination: PaginationApi<PropTypes>) => ReactNode |