- components
- ›
- pagination
- ›
- react
Pagination
Navigate between multiple pages of content.
ID | Name | Country | |
---|---|---|---|
1 | Darrin Green DVM | Adolf_Turner@yahoo.com | Chad |
2 | Dave Schamberger | Shaina_Lowe37@yahoo.com | Canada |
3 | Tamara Will | Audra69@yahoo.com | French Guiana |
4 | Miss Willie Kuvalis | Kristofer.Herzog93@yahoo.com | Palestine |
5 | Terrell Medhurst | Libbie_Zemlak@hotmail.com | Cote d'Ivoire |
6 | Janet Wuckert | Corine80@yahoo.com | Syrian Arab Republic |
7 | Mr. Rudy Breitenberg | Jeramie.Metz15@gmail.com | South Sudan |
8 | Sheldon Connelly | Rebeca_Anderson83@hotmail.com | Pitcairn Islands |
9 | Roderick Abshire | Marcelle.Grant64@hotmail.com | Comoros |
10 | Forrest Johns | Jamir_Buckridge@gmail.com | Gibraltar |
Page Size
ID | Name | Country | |
---|---|---|---|
1 | Ms. Bernadette Heller | Trinity.Shields@yahoo.com | Congo |
2 | Alex Bergstrom II | Magali.Lowe@gmail.com | Saudi Arabia |
3 | Edna Orn Sr. | Virgie35@gmail.com | Antigua and Barbuda |
4 | Yolanda Morissette | Lambert32@gmail.com | Slovenia |
5 | Geneva Powlowski-Hilll | Doyle53@yahoo.com | Antarctica |
6 | Lindsay Senger | Aurelia37@yahoo.com | Pakistan |
7 | Lori Moen | Laurel49@yahoo.com | United Kingdom |
8 | Leon Von | Nelda.Swaniawski74@gmail.com | Faroe Islands |
9 | Gloria Hudson | Filiberto1@hotmail.com | Sao Tome and Principe |
10 | Molly Ward | Cora.Greenholt97@gmail.com | Denmark |
Direction
ID | Name | Country | |
---|---|---|---|
1 | Cedric Kling | Marina.Leffler11@hotmail.com | Saint Pierre and Miquelon |
2 | Marcos Medhurst | Edwardo.Kunze@yahoo.com | Mauritania |
3 | Alicia Langosh | Elaina_MacGyver99@gmail.com | Belize |
4 | Lee Haag | Ralph_Lowe@hotmail.com | Brunei Darussalam |
5 | Wendy Schoen | Kathleen_Bailey@hotmail.com | Montserrat |
6 | Louise Franecki | Major_Walter@gmail.com | Myanmar |
7 | Mr. Tyrone O'Keefe | Petra.Spinka20@yahoo.com | Paraguay |
8 | Danny Upton | Vella_Brakus48@gmail.com | Saint Barthelemy |
9 | Steven McCullough | Godfrey.Beatty@hotmail.com | Switzerland |
10 | Robin O'Reilly | Gisselle57@yahoo.com | Niue |
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 |