- components
- ›
- pagination
- ›
- react
Pagination
Navigate between multiple pages of content.
ID | Name | Country | |
---|---|---|---|
1 | Devin Oberbrunner | Jedediah_Mohr46@gmail.com | Botswana |
2 | Christopher Carroll | Shanel38@yahoo.com | Djibouti |
3 | Santiago Padberg | Edgardo94@yahoo.com | Puerto Rico |
4 | Mr. Doug Funk | Marcelo.Erdman@hotmail.com | Bangladesh |
5 | Darin Hintz | Orie_Moen86@hotmail.com | Antarctica |
6 | Lee Strosin | Wanda_Ferry54@gmail.com | Singapore |
7 | Miss Marjorie Stamm | Jesus.Huels99@gmail.com | Togo |
8 | Dave Roberts DVM | Zula53@gmail.com | Chile |
9 | Angela Beatty | Victoria.Pollich36@yahoo.com | South Sudan |
10 | Bobby Keebler | Gloria5@gmail.com | Russian Federation |
Page Size
ID | Name | Country | |
---|---|---|---|
1 | Benny Lueilwitz | Amari36@gmail.com | Guinea |
2 | Lindsay Daniel | Luigi59@gmail.com | Angola |
3 | Cary Wiegand | Kayleigh.Cole35@gmail.com | Mauritania |
4 | Francis Nitzsche III | Dillon_Krajcik92@gmail.com | Lesotho |
5 | Mr. Howard Treutel | Abbigail_Mosciski@yahoo.com | Malaysia |
6 | Mrs. Minnie Ankunding | Kim_Greenholt@gmail.com | Bahrain |
7 | Casey Stroman | Alfonso_Reynolds@yahoo.com | Solomon Islands |
8 | Hector Stracke | Jackeline.Dare@gmail.com | Kazakhstan |
9 | Tanya Bernier | Maxwell50@gmail.com | Nicaragua |
10 | Ebony Graham | Wilfred_Larkin@hotmail.com | Uruguay |
Direction
ID | Name | Country | |
---|---|---|---|
1 | Cory Nicolas | Montana72@yahoo.com | Nepal |
2 | Natasha Kirlin | Jensen_Koss@yahoo.com | Lithuania |
3 | Kathy Welch | Stella61@yahoo.com | Turks and Caicos Islands |
4 | Pete Homenick | Pattie.Fisher96@gmail.com | Mali |
5 | Elvira Carroll | Cleora.Becker89@hotmail.com | British Indian Ocean Territory (Chagos Archipelago) |
6 | Janie Orn | Vaughn30@yahoo.com | Afghanistan |
7 | Cameron Lebsack | Margarita4@yahoo.com | Suriname |
8 | Micheal Douglas | Cheyenne40@gmail.com | Papua New Guinea |
9 | Miss Krystal Torphy | Sonny.Wilderman@gmail.com | Andorra |
10 | Genevieve Schoen-Tromp | Arvel61@gmail.com | Ireland |
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 |