1. framework components
  2. pagination

Pagination

Client and server-side pagination controls.

IDNameEmailCountry
1Faith RosenbaumOra.Cronin@hotmail.comNorthern Mariana Islands
2Jennie PagacDee_Kshlerin@yahoo.comAnguilla
3Carla StokesRachel.Runolfsdottir@gmail.comSaint Vincent and the Grenadines
4Darrell MoenAxel.Hettinger51@hotmail.comAland Islands
5Frances KovacekLucio_Rolfson95@gmail.comBelarus

Page Size

IDNameEmailCountry
1Armando WalterReinhold37@hotmail.comBrunei Darussalam
2Clayton RutherfordMitchell84@gmail.comNiger
3Cheryl HeidenreichManley84@gmail.comDominica
4Dr. Iris SchoenDena42@gmail.comHaiti
5Dr. Alma TreutelSterling_Spencer77@gmail.comLiechtenstein

Direction

IDNameEmailCountry
1Gwendolyn HackettAlexandro_Bogisich61@gmail.comYemen
2Ms. Kate Schmidt DDSBreana.Nikolaus@gmail.comTanzania
3Joey AltenwerthBertrand.Greenholt12@gmail.comSpain
4Ben CruickshankRyan32@hotmail.comRussian Federation
5Tracy Corkery DDSAnnalise_Ritchie@hotmail.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 -
((attributes: HTMLAttributes<"nav">) => Element) | undefined
Render the element yourself

RootProvider

Property Default Type
value -
PaginationApi<PropTypes>
element -
((attributes: HTMLAttributes<"nav">) => Element) | undefined
Render the element yourself

RootContext

Property Default Type
children -
(pagination: PaginationApi<PropTypes>) => ReactNode

PrevTrigger

Property Default Type
element -
((attributes: HTMLAttributes<"button">) => Element) | undefined
Render the element yourself

Item

Property Default Type
type -
"page"
value -
number
element -
((attributes: HTMLAttributes<"a">) => Element) | undefined
Render the element yourself

Ellipsis

Property Default Type
index -
number
element -
((attributes: HTMLAttributes<"span">) => Element) | undefined
Render the element yourself

NextTrigger

Property Default Type
element -
((attributes: HTMLAttributes<"button">) => Element) | undefined
Render the element yourself