| ID | Name | Country | |
|---|---|---|---|
| 1 | Tami Crooks | Adrien11@yahoo.com | Aruba |
| 2 | Mathew Johnson | Priscilla.Lang@yahoo.com | Pitcairn Islands |
| 3 | Mr. Marshall Jakubowski | Estrella_Dicki@gmail.com | Timor-Leste |
| 4 | Merle Goldner | Alice95@gmail.com | Guernsey |
| 5 | Raquel Greenholt | Julien.Rodriguez20@hotmail.com | Zimbabwe |
Page Size
| ID | Name | Country | |
|---|---|---|---|
| 1 | Kristi Barton | Emmanuel86@gmail.com | Spain |
| 2 | Myra Ebert | Selena48@gmail.com | Grenada |
| 3 | Ivan Nikolaus | Cathy.Hoeger@yahoo.com | Georgia |
| 4 | Essie Ward | Erling.Ritchie52@yahoo.com | Grenada |
| 5 | Amy Becker | Price_Cremin44@yahoo.com | Timor-Leste |
Direction
| ID | Name | Country | |
|---|---|---|---|
| 1 | Jeremiah Watsica | Jody89@yahoo.com | Morocco |
| 2 | Angela Grimes | Zelda.Hilll@hotmail.com | Finland |
| 3 | Pamela Stamm | Gregoria.Keebler@hotmail.com | Uganda |
| 4 | Christie Harber Jr. | Alford63@yahoo.com | San Marino |
| 5 | Elaine Bergstrom | Scotty0@hotmail.com | Uzbekistan |
Total Count
For server-side pagination, your data source may be truncated. Make sure to specify the total records using count.
const res = { "results": [...], "pagination": { "page": 1, "limit": 10, "count": 500, } }
<Pagination page={res.pagination.page} count={res.pagination.count} pageSize={res.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; }> | undefined The 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 | - | Snippet<[HTMLAttributes<"div">]> | undefinedRender the element yourself |
RootProvider
| Property | Default | Type |
|---|---|---|
value | - | () => PaginationApi<PropTypes> |
element | - | Snippet<[HTMLAttributes<"div">]> | undefinedRender the element yourself |
RootContext
| Property | Default | Type |
|---|---|---|
children | - | Snippet<[() => PaginationApi<PropTypes>]> |
PrevTrigger
| Property | Default | Type |
|---|---|---|
element | - | Snippet<[HTMLAttributes<"button">]> | undefinedRender the element yourself |
Item
| Property | Default | Type |
|---|---|---|
type | - | "page" |
value | - | number |
element | - | Snippet<[HTMLAttributes<"a">]> | undefinedRender the element yourself |
Ellipsis
| Property | Default | Type |
|---|---|---|
index | - | number |
element | - | Snippet<[HTMLAttributes<"span">]> | undefinedRender the element yourself |
NextTrigger
| Property | Default | Type |
|---|---|---|
element | - | Snippet<[HTMLAttributes<"button">]> | undefinedRender the element yourself |