- components
- ›
- pagination
- ›
- svelte
Pagination
Navigate between multiple pages of content.
ID | Name | Country | |
---|---|---|---|
1 | Gina Heller | Russ16@gmail.com | Somalia |
2 | Patrick Kuhlman | Nicolas93@hotmail.com | Burundi |
3 | Gregory Bergstrom | Whitney_Russel@gmail.com | Zambia |
4 | Mrs. Hannah Marks | Wendell3@gmail.com | American Samoa |
5 | Bridget Johnson Jr. | Ashlynn84@hotmail.com | Japan |
6 | Mr. Dewey Smith | Pink_Gutkowski61@hotmail.com | Moldova |
7 | Roxanne Treutel MD | Lamar_DAmore29@yahoo.com | Tunisia |
8 | Gwen Kautzer PhD | Jordy.Hayes@yahoo.com | Oman |
9 | Holly Purdy | Crawford.Orn@hotmail.com | Mongolia |
10 | Everett Bradtke | Christina.Boyer@yahoo.com | Germany |
Page Size
ID | Name | Country | |
---|---|---|---|
1 | Jeremy Hand | Meta.Shanahan77@gmail.com | Virgin Islands, British |
2 | Jan Toy | Bessie_Kessler33@hotmail.com | Georgia |
3 | Rodolfo Stoltenberg | Amely_Adams@hotmail.com | North Macedonia |
4 | Sam Beier III | Richard_Hettinger83@gmail.com | Albania |
5 | Helen Pacocha | Alford30@gmail.com | Uganda |
6 | Amos Emmerich | Ricky_Russel@yahoo.com | Armenia |
7 | Mathew Bernier | Jody_MacGyver79@hotmail.com | Denmark |
8 | Blake Fay-Steuber | Santino.Toy22@yahoo.com | Sweden |
9 | Nina Schaden-Cummerata | Kylee_Pfannerstill2@gmail.com | Tajikistan |
10 | Cornelius Carter III | Lenora74@yahoo.com | Argentina |
Direction
ID | Name | Country | |
---|---|---|---|
1 | Derek Bahringer-Macejkovic | Aurelio88@yahoo.com | Nauru |
2 | Ada Gibson | Bryana90@hotmail.com | Eswatini |
3 | Misty Marquardt | Alexys24@yahoo.com | Sao Tome and Principe |
4 | Nicolas Hegmann | Caitlyn69@hotmail.com | Greenland |
5 | Diane Balistreri | Oral.Kautzer@hotmail.com | Myanmar |
6 | Rudolph Ullrich | Deshaun81@hotmail.com | Uzbekistan |
7 | Paula Nienow | Cristian_Tremblay64@gmail.com | Spain |
8 | Mr. Marshall Hayes-Emard | Kathleen7@hotmail.com | South Sudan |
9 | Shelly Weimann | Marilie_Mueller@hotmail.com | Ukraine |
10 | Grant Medhurst | Gene42@hotmail.com | Algeria |
Total Count
For server-side pagination, your data source may be truncated. Make sure to specify the total records using count
.
{ "data": [...], "pagination": { "page": 1, "limit": 10, "count": 500, }}
<Pagination page={response.pagination.page} count={response.pagination.count} pageSize={response.pagination.limit}> ...</Pagination>
API Reference
Root
inline-flex gap-2 p-2 rounded-container preset-outlined-surface-200-800 w-fit
Property | Default | Type |
---|---|---|
ids | - | Partial<{ root: string; ellipsis: (index: number) => string; prevTrigger: string; nextTrigger: string; item: (page: number) => string; }> | undefinedThe 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
btn preset-tonal
Property | Default | Type |
---|---|---|
element | - | Snippet<[HTMLAttributes<"button">]> | undefinedRender the element yourself |
Item
btn preset-tonal cursor-pointer select-none data-selected:preset-filled
Property | Default | Type |
---|---|---|
type | - | "page" |
value | - | number |
element | - | Snippet<[HTMLAttributes<"a">]> | undefinedRender the element yourself |
Ellipsis
btn preset-tonal pointer-events-none
Property | Default | Type |
---|---|---|
index | - | number |
element | - | Snippet<[HTMLAttributes<"span">]> | undefinedRender the element yourself |
NextTrigger
btn preset-tonal
Property | Default | Type |
---|---|---|
element | - | Snippet<[HTMLAttributes<"button">]> | undefinedRender the element yourself |