- components
- ›
- pagination
- ›
- react
Pagination
Navigate between multiple pages of content.
ID | Name | Country | |
---|---|---|---|
1 | Charlene Hackett | Irwin.Hills42@gmail.com | Hungary |
2 | Cary Skiles | Jackie53@gmail.com | Cyprus |
3 | Carroll Paucek | Waldo12@yahoo.com | Svalbard & Jan Mayen Islands |
4 | Dr. Ricky Kub | Newton_Gutmann@yahoo.com | Seychelles |
5 | Arturo Stehr | Mia.Runte-Yost@hotmail.com | Western Sahara |
6 | Marianne Runolfsson | Brody_Pouros@gmail.com | Belgium |
7 | Katrina Schumm | Everett10@hotmail.com | Guadeloupe |
8 | Christine Heaney | Juwan.Lubowitz49@gmail.com | Tonga |
9 | Irene Hyatt | Kayley.Swaniawski67@gmail.com | Sao Tome and Principe |
10 | Bob Watsica | Evie84@yahoo.com | Somalia |
Page Size
ID | Name | Country | |
---|---|---|---|
1 | Erick Bahringer | Audrey.Hegmann62@yahoo.com | Saint Kitts and Nevis |
2 | Belinda Quigley | Garrick10@yahoo.com | Bahamas |
3 | Mr. Carlton Simonis | Hosea_Willms@yahoo.com | Macao |
4 | Jared VonRueden I | Margret86@yahoo.com | Thailand |
5 | Christian Nicolas | Brooke_Langosh-Wiegand96@yahoo.com | Bulgaria |
6 | Everett Emard | Ramiro67@hotmail.com | Burkina Faso |
7 | Barbara Runolfsdottir Sr. | Callie.Weber@hotmail.com | Tonga |
8 | Christy O'Conner | Emery_Dach@hotmail.com | Mali |
9 | Pablo Mueller | Faustino_Raynor@gmail.com | Albania |
10 | Pedro Beahan | Dedrick60@hotmail.com | Tunisia |
Direction
ID | Name | Country | |
---|---|---|---|
1 | Phyllis Bergstrom | Arlie.Osinski90@hotmail.com | Kuwait |
2 | Sonia Wolff | Cleo61@hotmail.com | Iraq |
3 | Renee Borer III | Laila_Welch@gmail.com | Suriname |
4 | Alfred Harvey | Veronica_Batz36@hotmail.com | Tuvalu |
5 | Jake Wilderman | Allan.Labadie@hotmail.com | Greenland |
6 | Henrietta Farrell | Vella40@gmail.com | Australia |
7 | Miss Leslie Bradtke | Karianne.Rosenbaum@hotmail.com | Uzbekistan |
8 | Lana Jaskolski | Gus16@yahoo.com | Spain |
9 | Miss Loretta Volkman | Osborne_Hettinger@hotmail.com | Taiwan |
10 | Blake D'Amore | William.Zieme43@hotmail.com | Chad |
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
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
Property | Default | Type |
---|---|---|
element | - | ((attributes: HTMLAttributes<"button">) => Element) | undefinedRender the element yourself |
Item
Property | Default | Type |
---|---|---|
type | - | "page" |
value | - | number |
element | - | ((attributes: HTMLAttributes<"a">) => Element) | undefinedRender the element yourself |
Ellipsis
Property | Default | Type |
---|---|---|
index | - | number |
element | - | ((attributes: HTMLAttributes<"span">) => Element) | undefinedRender the element yourself |
NextTrigger
Property | Default | Type |
---|---|---|
element | - | ((attributes: HTMLAttributes<"button">) => Element) | undefinedRender the element yourself |