- components
- ›
- pagination
- ›
- react
Pagination
Navigate between multiple pages of content.
ID | Name | Country | |
---|---|---|---|
1 | Kenny Kulas | Astrid_Morar74@yahoo.com | Malta |
2 | Kellie Ondricka | Cyrus52@hotmail.com | Guinea-Bissau |
3 | Felipe Schmidt | Syble86@hotmail.com | Palestine |
4 | Paula Zemlak | Casimir_Torphy@gmail.com | Mauritania |
5 | Miss Heidi Pouros | Carol_Hettinger77@gmail.com | Grenada |
6 | Timothy Farrell | Murl.Yost@hotmail.com | Jordan |
7 | Luke Doyle Sr. | Coleman63@yahoo.com | Bulgaria |
8 | Mr. Sergio Collins | Alessandro51@gmail.com | Russian Federation |
9 | Allen Paucek | Wendell.Farrell60@yahoo.com | Falkland Islands (Malvinas) |
10 | Erin Dicki II | Otis5@gmail.com | Ecuador |
Page Size
ID | Name | Country | |
---|---|---|---|
1 | Wendy Hessel | Albin.Gottlieb@yahoo.com | Niger |
2 | Camille Kuvalis Sr. | Faustino_Hermiston86@yahoo.com | Grenada |
3 | Jon Sporer | Julian.Bode@hotmail.com | United States of America |
4 | Angelina Crona | Raphael_Collier@gmail.com | Bosnia and Herzegovina |
5 | Neal Lindgren | Moses_Hudson56@yahoo.com | Latvia |
6 | Michele Nader | Easton34@gmail.com | Brazil |
7 | Carla McDermott DDS | Justice35@hotmail.com | Yemen |
8 | Brenda Becker | Jailyn_Murphy32@yahoo.com | China |
9 | Jenna Cruickshank | Angie.Ondricka@yahoo.com | Hungary |
10 | Jan Funk | Elbert_Streich@yahoo.com | Thailand |
Direction
ID | Name | Country | |
---|---|---|---|
1 | Veronica Brakus | Aryanna.Bechtelar@hotmail.com | Iceland |
2 | Mr. Dominic Runolfsdottir | Lucio52@hotmail.com | Iceland |
3 | Franklin Trantow | Emmanuelle_OKeefe@hotmail.com | Vietnam |
4 | Molly Lubowitz | Benedict_Pouros45@yahoo.com | Svalbard & Jan Mayen Islands |
5 | Kristi Mayert | Morgan_Crona@yahoo.com | Sweden |
6 | Dr. Drew Conn | Florida32@yahoo.com | Chad |
7 | Philip Powlowski MD | Michale_Sawayn70@hotmail.com | Virgin Islands, British |
8 | Larry Beatty | Vergie88@hotmail.com | Kyrgyz Republic |
9 | Lillian Deckow | Elna_Hartmann@hotmail.com | Croatia |
10 | Debbie Raynor | Marianna.Jast@gmail.com | Mali |
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 |