- components
- ›
- pagination
- ›
- react
Pagination
Navigate between multiple pages of content.
ID | Name | Country | |
---|---|---|---|
1 | Clay Monahan | Reba_Shanahan22@hotmail.com | Pitcairn Islands |
2 | Viola Rau | Dedric.Nienow@gmail.com | Luxembourg |
3 | Mrs. Erika Kohler | Keyon_Altenwerth@gmail.com | Czechia |
4 | Wendy Borer | Collin_Kreiger@yahoo.com | French Polynesia |
5 | Miss Laurie Kunze | Lemuel_Cartwright@yahoo.com | Madagascar |
6 | Brenda Bartell-Daniel | Moises_Ratke22@yahoo.com | Bolivia |
7 | John Purdy | Cary.Fahey37@hotmail.com | Venezuela |
8 | Kim Gorczany | Macey_Jast@gmail.com | Myanmar |
9 | Adrienne Daugherty | Jaylan.Hudson@yahoo.com | French Polynesia |
10 | Mrs. Marjorie Kutch | Brandi.Conn@yahoo.com | Yemen |
Page Size
ID | Name | Country | |
---|---|---|---|
1 | May Bednar | Retta89@hotmail.com | Ethiopia |
2 | Dr. Jose Gulgowski DVM | Sydni97@hotmail.com | British Indian Ocean Territory (Chagos Archipelago) |
3 | Doris Lueilwitz | Clare.Crooks73@yahoo.com | Hungary |
4 | Brent Moore | Heloise_Reichel@hotmail.com | Lao People's Democratic Republic |
5 | Paul Anderson | Troy.Rempel@gmail.com | Reunion |
6 | Lola Leannon | Jayne_Bogisich9@hotmail.com | Brunei Darussalam |
7 | Lynn Jerde | Albertha.Kreiger93@gmail.com | Denmark |
8 | Dominic Jacobi | Jensen.Jaskolski@yahoo.com | Zambia |
9 | Eula Borer I | Destiny_Gorczany16@yahoo.com | Cyprus |
10 | Freddie Sporer | Spencer.Lakin@yahoo.com | French Guiana |
Direction
ID | Name | Country | |
---|---|---|---|
1 | Phil Romaguera | Kyle88@yahoo.com | Falkland Islands (Malvinas) |
2 | Marilyn Ebert | Ernest_Koelpin@yahoo.com | British Indian Ocean Territory (Chagos Archipelago) |
3 | Angelica Muller | Brianne44@gmail.com | Eritrea |
4 | Ira Harris | Katlynn_Senger@yahoo.com | Lithuania |
5 | Paulette Kirlin | Alfreda_Feil@yahoo.com | Hungary |
6 | Brian Dicki | Pete.Pacocha@yahoo.com | Switzerland |
7 | Kenneth Lowe | Andrew_Corkery@hotmail.com | Saint Barthelemy |
8 | Abraham Carter | Kendall_Kuhic25@gmail.com | Seychelles |
9 | Cedric Walker | Rollin81@yahoo.com | Hong Kong |
10 | Clay Koelpin | Titus21@hotmail.com | Algeria |
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 |