- components
- ›
- pagination
- ›
- react
Pagination
Navigate between multiple pages of content.
ID | Name | Country | |
---|---|---|---|
1 | Lynne Rutherford | Felton.Cronin@gmail.com | Cocos (Keeling) Islands |
2 | Emily Prohaska | Camron9@hotmail.com | Svalbard & Jan Mayen Islands |
3 | Carroll Kassulke | Wayne.Russel@gmail.com | Montenegro |
4 | Vanessa Greenholt | Vidal_Prohaska@yahoo.com | Holy See (Vatican City State) |
5 | Edith Toy | Max_Greenfelder7@yahoo.com | Brazil |
6 | Beatrice Erdman V | Kailee.Dicki64@hotmail.com | Somalia |
7 | Sabrina Barton | Rocky25@gmail.com | Singapore |
8 | Tim Lemke | Frederik22@yahoo.com | Timor-Leste |
9 | Terry Kemmer | Deon_Kohler5@yahoo.com | Philippines |
10 | Angel Marvin | Matilde25@hotmail.com | Greenland |
Page Size
ID | Name | Country | |
---|---|---|---|
1 | Florence Harber-Greenholt | Stacy79@hotmail.com | Panama |
2 | Dr. Ted Larkin | Isac.Wiegand15@hotmail.com | Armenia |
3 | Sandy Lind | Garrison.Price@yahoo.com | Albania |
4 | Felix Stamm | August.Beer44@gmail.com | Tanzania |
5 | Hugh Heller | Hazel.Stark@hotmail.com | Turks and Caicos Islands |
6 | Manuel Jenkins | Alexie58@hotmail.com | Kenya |
7 | Deanna Gusikowski | Chyna.Trantow@yahoo.com | Mozambique |
8 | Miss Regina Fritsch-Cole DVM | Gerardo_Rogahn65@yahoo.com | Djibouti |
9 | Virgil Balistreri | Jarvis.Rutherford@yahoo.com | Qatar |
10 | Stephen Tillman | Corine.Leffler@yahoo.com | Saint Barthelemy |
Direction
ID | Name | Country | |
---|---|---|---|
1 | Geraldine Pollich | Zola_Jerde90@hotmail.com | Cambodia |
2 | Ms. Sherry Jenkins-Gerlach | Rubye.Mayert@gmail.com | Virgin Islands, British |
3 | Mr. Bert Graham | Bernadine.Zboncak@yahoo.com | Nauru |
4 | Celia Connelly | Arnoldo.Nikolaus@gmail.com | Namibia |
5 | Jerome Yost | Jacinto.Collier31@hotmail.com | Togo |
6 | Sheryl Johns II | Dexter.Block8@hotmail.com | Cook Islands |
7 | Dr. Andy Okuneva | Esta_Legros-Cronin@gmail.com | El Salvador |
8 | Lorenzo Steuber | Lucius99@yahoo.com | Senegal |
9 | Wendell Stiedemann | Chris_Hilpert@gmail.com | United States Minor Outlying Islands |
10 | Dr. Isaac Kilback | Rodolfo.McCullough@yahoo.com | Northern Mariana Islands |
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 |