- components
- ›
- pagination
- ›
- react
Pagination
Navigate between multiple pages of content.
ID | Name | Country | |
---|---|---|---|
1 | Jenny Bradtke | Trystan55@yahoo.com | Hong Kong |
2 | Omar Smith Jr. | Amanda82@hotmail.com | Cyprus |
3 | Phil Wiegand | Dimitri20@yahoo.com | Western Sahara |
4 | Clay Bogisich | Stefanie_Tromp82@hotmail.com | Martinique |
5 | Lynette Franecki | Amara.McGlynn47@yahoo.com | Cyprus |
6 | Dixie Herzog-Hirthe | Agustin10@yahoo.com | Trinidad and Tobago |
7 | Fred Franey | Norwood_Pacocha31@hotmail.com | Slovakia |
8 | Oliver Reilly | Tyler_Blanda44@gmail.com | Gambia |
9 | Jerald Murray | Berenice89@hotmail.com | Fiji |
10 | Heather Ferry | Lamont8@gmail.com | Iraq |
Page Size
ID | Name | Country | |
---|---|---|---|
1 | Owen Jones | Mable_Ebert8@gmail.com | Maldives |
2 | Dr. Edmond Hoeger | Romaine.Funk10@yahoo.com | Vietnam |
3 | Hazel Tremblay | Esmeralda77@gmail.com | Isle of Man |
4 | Jennie Greenholt | Jarrett.Lynch91@gmail.com | Nauru |
5 | Clay Koelpin | Vanessa_Runolfsson@gmail.com | Malta |
6 | Olga Langosh | Myrtis.Bernhard21@hotmail.com | Gambia |
7 | Gayle McCullough | Hilbert.Grant@yahoo.com | Ethiopia |
8 | Susan Kunde | Abelardo.Deckow@gmail.com | Maldives |
9 | Mae Ziemann | Tessie.Schoen7@hotmail.com | South Africa |
10 | Gilberto Murray | Gus97@gmail.com | Syrian Arab Republic |
Direction
ID | Name | Country | |
---|---|---|---|
1 | Betsy Block | Marilyne.Auer@yahoo.com | Madagascar |
2 | Kathryn Bogisich | Cory_Runolfsdottir34@yahoo.com | Liberia |
3 | Chris Johns | Neoma.Kovacek8@hotmail.com | Montserrat |
4 | Winifred Schmitt | Tobin80@yahoo.com | Czechia |
5 | Violet Bergstrom Jr. | Amie_Aufderhar@hotmail.com | Myanmar |
6 | Ramiro Huels IV | Elinor.Gibson32@gmail.com | Guernsey |
7 | Sergio Welch | Gregorio58@hotmail.com | Macao |
8 | Kathryn Durgan | Ronny_Wuckert65@hotmail.com | Liechtenstein |
9 | Maxine Goodwin | Icie.Runolfsson@hotmail.com | Macao |
10 | Nellie Wunsch Jr. | Barton.Blick95@yahoo.com | Uganda |
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 |