- components
- ›
- pagination
- ›
- react
Pagination
Navigate between multiple pages of content.
ID | Name | Country | |
---|---|---|---|
1 | Louise Hauck | Lucienne29@hotmail.com | Comoros |
2 | Thelma Gulgowski | Leola.Smith69@yahoo.com | Costa Rica |
3 | Mr. Steve Maggio | Marge_Johnson21@hotmail.com | Angola |
4 | Frankie Conroy | Ruben.Marquardt@gmail.com | Hong Kong |
5 | Sophie Abshire | Lelah32@yahoo.com | Bonaire, Sint Eustatius and Saba |
6 | Stanley Bayer | Randi67@hotmail.com | Colombia |
7 | Johnny Prohaska | Walker.Corkery@gmail.com | Eritrea |
8 | Sheryl Trantow | Osbaldo94@yahoo.com | Belgium |
9 | Guy Dare DVM | Deion21@gmail.com | Trinidad and Tobago |
10 | Angel Keeling | Tate_Rice@hotmail.com | Dominican Republic |
Page Size
ID | Name | Country | |
---|---|---|---|
1 | Deborah Miller | Leopoldo.Purdy@hotmail.com | Tuvalu |
2 | Fredrick Ratke | Wilbert_Bauch91@yahoo.com | Nicaragua |
3 | Johnathan Sporer | Junius_Satterfield9@hotmail.com | Turkmenistan |
4 | Zachary Konopelski | Will88@yahoo.com | Tanzania |
5 | Joann Bins | Eryn72@yahoo.com | Guinea |
6 | Shaun Bailey | Ibrahim.Osinski95@gmail.com | Guyana |
7 | Regina Maggio-Sanford | Mariano.Monahan54@hotmail.com | Kenya |
8 | Kevin Gutkowski | Garth30@yahoo.com | Montserrat |
9 | Olga Baumbach | Lester_Hauck@yahoo.com | Djibouti |
10 | Evelyn Trantow | Dallas22@gmail.com | Philippines |
Direction
ID | Name | Country | |
---|---|---|---|
1 | Clay Paucek | Garrett_Armstrong@gmail.com | Morocco |
2 | Mr. Bernard Waelchi | Miles11@gmail.com | Romania |
3 | Bradley Lakin | Jamie.Littel80@gmail.com | Cambodia |
4 | Amy Beahan | Shawn70@gmail.com | Netherlands |
5 | Angela Quitzon | Leone_Murray@yahoo.com | Reunion |
6 | Sandy Hansen V | Jimmie.Goldner@yahoo.com | Myanmar |
7 | Mae Mueller V | Dawn.Luettgen@gmail.com | Mexico |
8 | Tina Huels | Era71@yahoo.com | Tuvalu |
9 | Mrs. Essie Upton | Maynard_Mayer13@yahoo.com | Georgia |
10 | Wayne Bahringer | Christine_Bashirian@yahoo.com | South Georgia and the South Sandwich 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
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 |