- components
- ›
- pagination
- ›
- react
Pagination
Navigate between multiple pages of content.
ID | Name | Country | |
---|---|---|---|
1 | Cary Hayes MD | Wellington_Stiedemann@hotmail.com | Namibia |
2 | Kara Kuvalis | Lauren.Daniel-Schuppe@yahoo.com | Wallis and Futuna |
3 | Dixie Schinner | Zakary_Russel@yahoo.com | Bahamas |
4 | Justin Crooks | Freida_Carroll@gmail.com | Turks and Caicos Islands |
5 | Marion Windler | Keyshawn.Jast@hotmail.com | Mali |
6 | Dianna Hudson | Reggie_Deckow@yahoo.com | Papua New Guinea |
7 | Allen Weissnat MD | Judah.Schuster7@yahoo.com | Malaysia |
8 | Omar Kreiger | Jay7@hotmail.com | Senegal |
9 | Dr. Bernard Marks | Emmy.Wunsch51@gmail.com | Sao Tome and Principe |
10 | Laurie Weimann | Molly.Rutherford29@yahoo.com | Hong Kong |
Page Size
ID | Name | Country | |
---|---|---|---|
1 | Dave Grimes | Etha_Moen@yahoo.com | French Southern Territories |
2 | Mrs. Bethany Murazik | Anya_Kirlin72@hotmail.com | Philippines |
3 | Sabrina Grady | Adelle26@gmail.com | Afghanistan |
4 | Irvin Koch | Brett34@hotmail.com | Montserrat |
5 | Jerald Dickinson | Carol_Kirlin78@yahoo.com | Bouvet Island |
6 | Dr. Rosie Langworth | Sven.Fay29@yahoo.com | Haiti |
7 | Alberto Pacocha | Larue.Schinner83@hotmail.com | Nepal |
8 | Cassandra Moen | Dallas_Schneider@hotmail.com | Saint Pierre and Miquelon |
9 | Shaun Herzog | Buddy_Kling@gmail.com | South Georgia and the South Sandwich Islands |
10 | Colin Willms | Daija_Kiehn@hotmail.com | New Zealand |
Direction
ID | Name | Country | |
---|---|---|---|
1 | Neil Muller | Berry_Beatty@yahoo.com | Gibraltar |
2 | Devin Will II | Nelson32@yahoo.com | Andorra |
3 | Lois VonRueden | Shea_Corwin@hotmail.com | Cape Verde |
4 | Ms. Marlene Hagenes | Alvis.Dietrich26@yahoo.com | Uzbekistan |
5 | Dr. Wm Ullrich | Letitia_Feeney@hotmail.com | Mozambique |
6 | Mabel Kautzer DDS | Tatum.Mitchell25@gmail.com | Christmas Island |
7 | Cornelius Kling | Camron63@yahoo.com | Burundi |
8 | Fred Lemke | Vernie.Hermann48@gmail.com | Indonesia |
9 | Shane Stanton | Adolph_Effertz4@gmail.com | South Sudan |
10 | Glenda Tromp | Robyn_Russel36@hotmail.com | Congo |
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 |