- components
- ›
- pagination
- ›
- react
Pagination
Navigate between multiple pages of content.
ID | Name | Country | |
---|---|---|---|
1 | Joel Kuhn | Chris88@yahoo.com | Macao |
2 | Christian Funk | Syble_Turner93@hotmail.com | Aland Islands |
3 | Jan Kiehn | Ernie73@gmail.com | Aruba |
4 | Kristina Rutherford PhD | Ariane.Ortiz40@yahoo.com | Brazil |
5 | Lydia Ondricka-Russel | Frederic.Sporer-Spinka7@hotmail.com | Singapore |
6 | Tamara Carter | Monique_Schiller24@hotmail.com | Belarus |
7 | Dr. Allen Kohler | Sierra_Tromp65@yahoo.com | Singapore |
8 | Janice Sanford | Tiana.Schuppe41@gmail.com | Tunisia |
9 | Casey Kihn | Deion.Hessel29@yahoo.com | Saudi Arabia |
10 | Judith Rutherford | Rebeca62@yahoo.com | Saint Lucia |
Page Size
ID | Name | Country | |
---|---|---|---|
1 | Angie Breitenberg | Natasha_Erdman75@hotmail.com | Malta |
2 | Juanita Kuhlman | Francisco_Satterfield82@gmail.com | Belarus |
3 | Dr. Jan Goldner I | Bernard72@gmail.com | Liberia |
4 | Jonathon Mosciski-Shanahan MD | Vena.Kertzmann91@hotmail.com | Holy See (Vatican City State) |
5 | Juan Hand | Cordelia_Ratke45@yahoo.com | Uruguay |
6 | Marjorie Stark | Lilyan58@hotmail.com | Brunei Darussalam |
7 | Eugene Howe | Maximillia60@hotmail.com | Tonga |
8 | Becky Rohan | Brenna_Champlin@yahoo.com | Solomon Islands |
9 | Dr. Felipe Rice | Hal.Hegmann@hotmail.com | Niger |
10 | Dave Hammes | Laila99@gmail.com | Taiwan |
Direction
ID | Name | Country | |
---|---|---|---|
1 | Louis Cormier | Leanne.Koepp@hotmail.com | Australia |
2 | Sophie Stehr | Otho19@yahoo.com | French Polynesia |
3 | Floyd Wyman | Gordon.Stamm10@gmail.com | Aruba |
4 | Sara Schumm | Dulce_Roob79@gmail.com | Kazakhstan |
5 | Angelina Toy | Olaf.Quigley42@gmail.com | Bosnia and Herzegovina |
6 | Elbert O'Keefe DDS | Geo_Kris@gmail.com | Nicaragua |
7 | Winifred Veum PhD | Wendell_Purdy@gmail.com | Mauritius |
8 | Randal Harber | Dewitt40@gmail.com | Luxembourg |
9 | Mrs. Carol Hoppe-Prosacco | Mozell40@gmail.com | Kiribati |
10 | Alton Mertz | Frederik_Olson@gmail.com | Nauru |
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 |