1. framework components
  2. pagination

Pagination

Client and server-side pagination controls.

IDNameEmailCountry
1Dr. Jacob LuettgenMarie44@yahoo.comSouth Sudan
2Pedro Koelpin-TorphyMara31@yahoo.comJersey
3Neil KossLenore.Hegmann0@yahoo.comSaint Kitts and Nevis
4Joanna NolanCynthia_Pfeffer@yahoo.comBahrain
5Traci KautzerBeulah.Hegmann88@yahoo.comEgypt

Page Size

IDNameEmailCountry
1Veronica Volkman Sr.Mortimer.VonRueden42@gmail.comTuvalu
2Lawrence ChamplinNoemi.Kemmer76@hotmail.comNigeria
3Karen WymanSanta56@yahoo.comGreece
4Troy BayerJoel_Rippin61@yahoo.comDenmark
5Kathleen ParkerJeff_Heidenreich@yahoo.comFalkland Islands (Malvinas)

Direction

IDNameEmailCountry
1Valerie Little-BinsGuy81@hotmail.comGuinea
2Rosie RutherfordJamison_Swaniawski53@gmail.comFaroe Islands
3Shelly RomagueraMargaret.Lockman@gmail.comLesotho
4Nelson KonopelskiAgustin.Bauch@yahoo.comNew Zealand
5Deanna SchoenMonroe_Langosh48@hotmail.comItaly

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.

elementSnippet<[HTMLAttributes<"div">]> | undefined

Render the element yourself

Provider

PropDefaultType
value() => PaginationApi<PropTypes>

elementSnippet<[HTMLAttributes<"div">]> | undefined

Render the element yourself

Context

PropDefaultType
childrenSnippet<[() => PaginationApi<PropTypes>]>

FirstTrigger

txt
btn btn-sm preset-tonal
PropDefaultType
elementSnippet<[HTMLAttributes<"button">]> | undefined

Render the element yourself

PrevTrigger

txt
btn btn-sm preset-tonal
PropDefaultType
elementSnippet<[HTMLAttributes<"button">]> | undefined

Render the element yourself

Item

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

valuenumber

elementSnippet<[HTMLAttributes<"a">]> | undefined

Render the element yourself

Ellipsis

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

elementSnippet<[HTMLAttributes<"span">]> | undefined

Render the element yourself

NextTrigger

txt
btn btn-sm preset-tonal
PropDefaultType
elementSnippet<[HTMLAttributes<"button">]> | undefined

Render the element yourself

LastTrigger

txt
btn btn-sm preset-tonal
PropDefaultType
elementSnippet<[HTMLAttributes<"button">]> | undefined

Render the element yourself

View page on GitHub