- components
- ›
- pagination
- ›
- react
Pagination
Navigate between multiple pages of content.
ID | Name | Country | |
---|---|---|---|
1 | Jay Hand | Rodolfo24@gmail.com | Bosnia and Herzegovina |
2 | Anna MacGyver | Eleanora.Wisoky@hotmail.com | Marshall Islands |
3 | Dominic Mertz | Cornelius_Veum15@hotmail.com | Heard Island and McDonald Islands |
4 | Mr. Hugo Wilkinson | Meta58@hotmail.com | Egypt |
5 | Darryl Bins | Mikel77@hotmail.com | Kuwait |
6 | Nicole Jacobson | Donnie86@yahoo.com | French Guiana |
7 | Duane Smith | Ludie.Streich47@gmail.com | Cuba |
8 | Jacquelyn Paucek | Lorenzo.Champlin95@gmail.com | Yemen |
9 | Benny Davis | Leila97@hotmail.com | Benin |
10 | Lance Lesch | Emerald.Dickens@gmail.com | Lebanon |
Page Size
ID | Name | Country | |
---|---|---|---|
1 | Andre Hartmann DVM | Lola_Von@yahoo.com | French Southern Territories |
2 | Chris Stroman | Ayden44@gmail.com | Rwanda |
3 | Bobbie Heaney | Sandra.Purdy@yahoo.com | Tonga |
4 | Billy Ondricka | Domenick_Crist79@gmail.com | Western Sahara |
5 | Katherine Zieme Sr. | Elna.Rice@yahoo.com | Bahamas |
6 | Barbara Ernser | Cornell.Reichel72@yahoo.com | Kazakhstan |
7 | Randal Raynor | Domingo25@hotmail.com | Guyana |
8 | Ellen Daugherty | Pamela.Little52@hotmail.com | Australia |
9 | Miss Samantha Hermann | Norris3@hotmail.com | Spain |
10 | Dianne Metz | Kelley.OConnell99@gmail.com | Sint Maarten |
Direction
ID | Name | Country | |
---|---|---|---|
1 | Louise Harber | Dejah96@hotmail.com | Russian Federation |
2 | Lance Prosacco | Ethyl.Nader44@gmail.com | Dominica |
3 | Charles Fritsch | Jany_Rodriguez@yahoo.com | Western Sahara |
4 | Randall Mayer | Cullen50@gmail.com | Niue |
5 | Nicholas Rice | Kaden_Kuvalis@hotmail.com | Dominica |
6 | Neal Kulas | Marianna_Wehner@yahoo.com | Senegal |
7 | Melba Schaden | Shayne_Schmeler@hotmail.com | Niue |
8 | Lillian Murazik | Arjun_Baumbach@yahoo.com | North Macedonia |
9 | Mrs. Ethel Osinski | Bertha_Bergstrom5@hotmail.com | Moldova |
10 | Dr. Dwayne Hodkiewicz | Leo.Howe@yahoo.com | Tajikistan |
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 |