- components
- ›
- pagination
- ›
- svelte
Pagination
Navigate between multiple pages of content.
ID | Name | Country | |
---|---|---|---|
1 | Raul Nitzsche IV | Marcia.Sipes@hotmail.com | Uzbekistan |
2 | Timothy Champlin | Caleigh.Bradtke@hotmail.com | Micronesia |
3 | Jo Reilly MD | Jacquelyn_Runolfsdottir35@gmail.com | Moldova |
4 | Calvin Hessel | Shyann23@hotmail.com | Germany |
5 | Tyrone Hudson | Celestine_Veum53@yahoo.com | Mozambique |
6 | Dave Quigley | Elisabeth8@hotmail.com | Saint Vincent and the Grenadines |
7 | Paulette Reichel | Zoila_Schaden76@yahoo.com | Sao Tome and Principe |
8 | Dr. Jacqueline Thiel | Lolita_Homenick@gmail.com | Italy |
9 | Erik Torp | Heloise.Runolfsdottir80@hotmail.com | Slovakia |
10 | Ms. Maureen Hyatt DVM | Coy41@gmail.com | Honduras |
Page Size
ID | Name | Country | |
---|---|---|---|
1 | Gwen Heidenreich | Allen_Stiedemann66@hotmail.com | Luxembourg |
2 | Joyce Bechtelar | Hunter71@hotmail.com | Dominican Republic |
3 | Kerry Schimmel | Lorenza7@hotmail.com | Marshall Islands |
4 | Ana Murray | Bailee.MacGyver50@hotmail.com | Sao Tome and Principe |
5 | Dennis Lehner | Audreanne_Cummings13@yahoo.com | Bouvet Island |
6 | Ana Tillman | Nasir4@yahoo.com | Egypt |
7 | Lance Labadie | Bulah39@yahoo.com | Republic of Korea |
8 | Kristine McClure Jr. | Sigrid82@gmail.com | Wallis and Futuna |
9 | Ramona Jacobi | Tressie_Beahan@gmail.com | Malaysia |
10 | Kathy Fay | Tessie96@gmail.com | Eswatini |
Direction
ID | Name | Country | |
---|---|---|---|
1 | Juana Monahan | Hershel.VonRueden@gmail.com | Yemen |
2 | Elias Morissette | Milan_Lesch53@gmail.com | Saint Vincent and the Grenadines |
3 | Dustin Baumbach-Feil | Sasha_Ryan@hotmail.com | Mexico |
4 | Eva Leannon | Donna_Shields13@yahoo.com | Norway |
5 | Alejandro Keebler | Halle91@hotmail.com | Singapore |
6 | Dr. Jeremiah Lind | Elouise56@gmail.com | Tunisia |
7 | Mindy Hintz | Elza3@gmail.com | Algeria |
8 | Elaine Tillman | Douglas_Streich-Ullrich78@gmail.com | Micronesia |
9 | Tonya Balistreri | Arvilla98@hotmail.com | Belgium |
10 | Lynn Block | Sharon.Corkery@yahoo.com | Jersey |
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
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
Property | Default | Type |
---|---|---|
element | - | Snippet<[HTMLAttributes<"button">]> | undefinedRender the element yourself |
Item
Property | Default | Type |
---|---|---|
type | - | "page" |
value | - | number |
element | - | Snippet<[HTMLAttributes<"a">]> | undefinedRender the element yourself |
Ellipsis
Property | Default | Type |
---|---|---|
index | - | number |
element | - | Snippet<[HTMLAttributes<"span">]> | undefinedRender the element yourself |
NextTrigger
Property | Default | Type |
---|---|---|
element | - | Snippet<[HTMLAttributes<"button">]> | undefinedRender the element yourself |