1. framework components
  2. pagination

Pagination

Client and server-side pagination controls.

IDNameEmailCountry
1Steven SanfordRuss82@yahoo.comHoly See (Vatican City State)
2Dr. Alfonso Prohaska MDMariane4@hotmail.comNiger
3Joshua CummerataBrionna_Wiza62@yahoo.comNamibia
4Ora HaagKelsi.Ortiz@yahoo.comSaint Vincent and the Grenadines
5Chelsea SchowalterKara_Schaefer@hotmail.comSamoa

Page Size

IDNameEmailCountry
1Rex KingJordan_Hilpert66@hotmail.comBermuda
2Evelyn WillmsCristobal_Leuschke@gmail.comAntigua and Barbuda
3Jay BeattyIsidro.Lebsack48@gmail.comSaudi Arabia
4Dr. Carroll McCulloughMonserrat_Bauch@hotmail.comCentral African Republic
5Myrtle SchinnerAmely_Olson@gmail.comAmerican Samoa

Direction

IDNameEmailCountry
1Elsie SchneiderMyrl35@yahoo.comLesotho
2Willard RennerCole83@gmail.comAustralia
3Lindsay MosciskiJoshuah13@gmail.comDenmark
4Gerald RobelArmando8@yahoo.comArgentina
5Alfred HoweBennie.Muller@gmail.comHungary

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 | undefined
Specifies the localized strings that identifies the accessibility elements and their states
count -
number | undefined
Total number of data items
pageSize -
number | undefined
The controlled number of data items per page
defaultPageSize 10
number | undefined
The 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 | undefined
Number of pages to show beside active page
page -
number | undefined
The controlled active page
defaultPage 1
number | undefined
The initial active page when rendered. Use when you don't need to control the active page of the pagination.
onPageChange -
((details: PageChangeDetails) => void) | undefined
Called when the page number is changed
onPageSizeChange -
((details: PageSizeChangeDetails) => void) | undefined
Called when the page size is changed
type "button"
"button" | "link" | undefined
The type of the trigger element
getPageUrl -
((details: PageUrlDetails) => string) | undefined
Function to generate href attributes for pagination links. Only used when `type` is set to "link".
dir "ltr"
"ltr" | "rtl" | undefined
The document's text/writing direction.
getRootNode -
(() => ShadowRoot | Node | Document) | undefined
A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.
element -
Snippet<[HTMLAttributes<"div">]> | undefined
Render the element yourself

RootProvider

Property Default Type
value -
() => PaginationApi<PropTypes>
element -
Snippet<[HTMLAttributes<"div">]> | undefined
Render the element yourself

RootContext

Property Default Type
children -
Snippet<[() => PaginationApi<PropTypes>]>

PrevTrigger

Property Default Type
element -
Snippet<[HTMLAttributes<"button">]> | undefined
Render the element yourself

Item

Property Default Type
type -
"page"
value -
number
element -
Snippet<[HTMLAttributes<"a">]> | undefined
Render the element yourself

Ellipsis

Property Default Type
index -
number
element -
Snippet<[HTMLAttributes<"span">]> | undefined
Render the element yourself

NextTrigger

Property Default Type
element -
Snippet<[HTMLAttributes<"button">]> | undefined
Render the element yourself