- components
- ›
- pagination
- ›
- react
Pagination
Navigate between multiple pages of content.
ID | Name | Country | |
---|---|---|---|
1 | Lewis Von | Giovani95@gmail.com | Montenegro |
2 | Lillie Hammes | Adrianna_Price60@gmail.com | Cayman Islands |
3 | Beth Gibson | Norris.Walker11@gmail.com | Svalbard & Jan Mayen Islands |
4 | Dominick Quigley | Willis75@hotmail.com | Saint Pierre and Miquelon |
5 | Kevin Macejkovic | Lemuel.Quitzon@hotmail.com | Argentina |
6 | Victor Pagac | Wallace_Dickinson52@hotmail.com | Tanzania |
7 | Carl Greenholt III | Thomas.Hammes28@hotmail.com | Romania |
8 | Wayne Cremin-McGlynn V | Annabel50@yahoo.com | Malawi |
9 | Gerardo Ebert | Fay28@hotmail.com | El Salvador |
10 | Mack Beer | Josefina.Schmeler37@yahoo.com | Palau |
Page Size
ID | Name | Country | |
---|---|---|---|
1 | Whitney Kozey | Lilian38@hotmail.com | Iceland |
2 | Henry Schamberger | Ron11@gmail.com | Finland |
3 | Herbert Aufderhar | Sean_Turcotte-Schultz@yahoo.com | Gibraltar |
4 | Nathan Pfeffer | Larue.Mosciski@hotmail.com | Virgin Islands, British |
5 | Jackie Stokes | Quinton43@hotmail.com | Iraq |
6 | Grant Gerlach | Horacio94@hotmail.com | Chad |
7 | Jamie O'Keefe MD | Christ_Blanda@hotmail.com | Rwanda |
8 | Mrs. Kim Streich | Alysha_Bechtelar@hotmail.com | Zambia |
9 | Ralph Langworth | Hershel.Gorczany@hotmail.com | Gabon |
10 | Mack VonRueden | Myra_Wuckert@yahoo.com | Central African Republic |
Direction
ID | Name | Country | |
---|---|---|---|
1 | Susan Kuhic IV | Marcelino_Parker76@gmail.com | Palau |
2 | Pauline Turcotte | Jed53@yahoo.com | Romania |
3 | Yvonne Willms | Liam83@hotmail.com | Chad |
4 | Anita Weimann | Jacques78@gmail.com | Panama |
5 | Grady Kiehn | Ova.Oberbrunner77@yahoo.com | Kazakhstan |
6 | Julia Hoppe | Kari_Hodkiewicz@yahoo.com | Comoros |
7 | Gene Wilkinson | Otilia34@hotmail.com | Qatar |
8 | Stacy Zulauf | Danielle.Jast@yahoo.com | Kyrgyz Republic |
9 | Gregg Dach | Wiley.King-McGlynn52@yahoo.com | Somalia |
10 | Domingo Ortiz | Pablo.Rutherford28@hotmail.com | Singapore |
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 |