- components
- ›
- pagination
- ›
- react
Pagination
Navigate between multiple pages of content.
ID | Name | Country | |
---|---|---|---|
1 | Latoya Bartell | Ewald35@gmail.com | Iceland |
2 | Dr. Jonathon Simonis-Crooks | Wade_Kertzmann@yahoo.com | New Zealand |
3 | Mrs. Lillie Aufderhar | Hollie_Legros@yahoo.com | Tunisia |
4 | Jim Strosin | Erick.Rau32@yahoo.com | Hong Kong |
5 | Jonathon Gleason | Lonnie.Pagac@hotmail.com | Albania |
6 | Miss Grace Little | Dimitri56@hotmail.com | Namibia |
7 | Kirk Russel | Lamont.Walter@yahoo.com | Croatia |
8 | Warren Braun | Delpha34@yahoo.com | Gibraltar |
9 | Monique Harris | Addison_Hintz11@yahoo.com | Azerbaijan |
10 | Brenda Beatty | Linnea.Rodriguez4@hotmail.com | Jersey |
Page Size
ID | Name | Country | |
---|---|---|---|
1 | Ella Donnelly | Nestor_Hills@gmail.com | Mongolia |
2 | Sheryl Schultz | Ethel27@yahoo.com | Cuba |
3 | Janie Fay | Adelle90@yahoo.com | Puerto Rico |
4 | Duane Hansen | Ardella.Dooley@gmail.com | Cook Islands |
5 | Kristine Jones | Brooke.Kovacek75@gmail.com | Tokelau |
6 | Freddie Rolfson | Kaelyn_Johnston@hotmail.com | Holy See (Vatican City State) |
7 | Freda Murazik | Pablo_Hegmann@hotmail.com | Sweden |
8 | Terry Friesen | Rudy76@hotmail.com | Zimbabwe |
9 | Dave Bosco | Mollie.OKon32@gmail.com | Marshall Islands |
10 | Verna Ryan | Sydnie_Crona@yahoo.com | Jamaica |
Direction
ID | Name | Country | |
---|---|---|---|
1 | Rudy Fritsch-Fahey | Jada85@yahoo.com | Chad |
2 | Russell Bogisich | Arlene_Boyle80@hotmail.com | United Kingdom |
3 | Lela Haag Jr. | Sebastian_Spencer28@yahoo.com | Ethiopia |
4 | Leslie Hyatt | Rusty42@gmail.com | Lithuania |
5 | Mr. Lorenzo Dooley | Vicenta_Effertz89@yahoo.com | Italy |
6 | Delia Lowe | Burley.Prosacco85@yahoo.com | Cook Islands |
7 | Genevieve Pacocha | Ellie.Wolf@gmail.com | El Salvador |
8 | Malcolm Bruen | Hettie.Buckridge@gmail.com | Heard Island and McDonald Islands |
9 | Rogelio Hills | Nathaniel_Hand@yahoo.com | Turks and Caicos Islands |
10 | Doris Fritsch | Erik_Marvin@yahoo.com | Romania |
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 |