1. framework components
  2. pagination

Pagination

Client and server-side pagination controls.

IDNameEmailCountry
1Mrs. Sherry Smith Sr.Carmel18@gmail.comBenin
2Lynette MaggioCarlo.Gusikowski@yahoo.comUnited Arab Emirates
3Nathan PourosFlo.Kiehn36@hotmail.comCentral African Republic
4Delia HartmannMichaela43@hotmail.comBouvet Island
5Dr. Gabriel MooreEnid45@hotmail.comDominica

Page Size

IDNameEmailCountry
1Lyle HeidenreichArmani.Hyatt@gmail.comMoldova
2Dallas KohlerMonserrate27@yahoo.comMontenegro
3Irving DickiVern_Leannon5@yahoo.comTrinidad and Tobago
4Miss Amelia FerryRocio_Carroll-Schoen44@yahoo.comKyrgyz Republic
5Wayne LebsackKarelle_Brown71@yahoo.comUnited States of America

Direction

IDNameEmailCountry
1Dr. Jonathon Barton PhDMaximillian_Koelpin95@hotmail.comHoly See (Vatican City State)
2Geraldine PfefferRowena.Leannon35@yahoo.comAruba
3Lena KoeppAngelo_Schroeder@hotmail.comChile
4Melinda Rau IIIImogene_Kuphal75@yahoo.comPuerto Rico
5Erik KihnTheo.Green94@yahoo.comBahrain

Total Count

For server-side pagination, your data source may be truncated. Make sure to specify the total records using count.

ts
const res = {
	"results": [...],
	"pagination": {
		"page": 1,
		"limit": 10,
		"count": 500,
	}
}
astro
<Pagination page={res.pagination.page} count={res.pagination.count} pageSize={res.pagination.limit}>...</Pagination>

API Reference

Root

txt
inline-flex gap-2 p-2 rounded-container preset-outlined-surface-200-800 w-fit
PropDefaultType
idsPartial<{ 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.

translationsIntlTranslations | undefined

Specifies the localized strings that identifies the accessibility elements and their states

countnumber | undefined

Total number of data items

pageSizenumber | undefined

The controlled number of data items per page

defaultPageSize10number | 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.

siblingCount1number | undefined

Number of pages to show beside active page

pagenumber | undefined

The controlled active page

defaultPage1number | 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

Provider

PropDefaultType
valuePaginationApi<PropTypes>

element((attributes: HTMLAttributes<"nav">) => Element) | undefined

Render the element yourself

Context

PropDefaultType
children(pagination: PaginationApi<PropTypes>) => ReactNode

FirstTrigger

txt
btn btn-sm preset-tonal
PropDefaultType
element((attributes: HTMLAttributes<"button">) => Element) | undefined

Render the element yourself

PrevTrigger

txt
btn btn-sm preset-tonal
PropDefaultType
element((attributes: HTMLAttributes<"button">) => Element) | undefined

Render the element yourself

Item

txt
btn btn-sm preset-tonal cursor-pointer select-none data-selected:preset-filled
PropDefaultType
type"page"

valuenumber

element((attributes: HTMLAttributes<"a">) => Element) | undefined

Render the element yourself

Ellipsis

txt
btn btn-sm preset-tonal pointer-events-none
PropDefaultType
indexnumber

element((attributes: HTMLAttributes<"span">) => Element) | undefined

Render the element yourself

NextTrigger

txt
btn btn-sm preset-tonal
PropDefaultType
element((attributes: HTMLAttributes<"button">) => Element) | undefined

Render the element yourself

LastTrigger

txt
btn btn-sm preset-tonal
PropDefaultType
element((attributes: HTMLAttributes<"button">) => Element) | undefined

Render the element yourself

View page on GitHub