- components
- ›
- pagination
- ›
- svelte
Pagination
Navigate between multiple pages of content.
ID | Name | Country | |
---|---|---|---|
1 | Mrs. Lorene Hane | Raegan_Kessler42@gmail.com | Slovakia |
2 | Mitchell Nienow | Reymundo2@yahoo.com | Iraq |
3 | Percy Runte DDS | Aryanna.Spencer@yahoo.com | Spain |
4 | Israel Corwin | Annabell.Kuhic@gmail.com | Macao |
5 | Maureen Mraz | Hilda.Balistreri@hotmail.com | Comoros |
6 | Raymond Price | Katelyn57@hotmail.com | Gabon |
7 | Kristopher Mann | Thad.Gerlach@yahoo.com | Burundi |
8 | Jane MacGyver-Senger PhD | Kayley_DAmore51@gmail.com | Bouvet Island |
9 | Eric Veum DVM | Gudrun37@yahoo.com | Montenegro |
10 | Amanda Dickinson | Jonathan83@yahoo.com | Comoros |
Page Size
ID | Name | Country | |
---|---|---|---|
1 | Curtis Beier | Clare25@gmail.com | Cook Islands |
2 | Jean Cassin | Kelli66@yahoo.com | Svalbard & Jan Mayen Islands |
3 | Dianne Cartwright | Vince.Boyer@gmail.com | Bouvet Island |
4 | Felicia Runolfsdottir | Noemie_Wuckert25@gmail.com | Angola |
5 | William Batz | Rashawn22@hotmail.com | Argentina |
6 | Cynthia Beatty | Santa_Padberg@hotmail.com | Czechia |
7 | Essie Dach | Danika75@gmail.com | Oman |
8 | Allan Schamberger | Elyssa.Nienow@yahoo.com | Niue |
9 | Grace Boyer | Saige41@hotmail.com | Norfolk Island |
10 | Edna Heidenreich | Elmer.Cassin@gmail.com | South Africa |
Direction
ID | Name | Country | |
---|---|---|---|
1 | Dr. Conrad Raynor | Catherine.Boyle-Wilkinson@yahoo.com | Northern Mariana Islands |
2 | Mrs. Lisa White-Walsh | Ricardo84@hotmail.com | Liechtenstein |
3 | Mr. Salvatore Grady Jr. | Colleen_Casper20@yahoo.com | Northern Mariana Islands |
4 | Dr. Salvador Zulauf | Gunner50@gmail.com | Guam |
5 | Alfred Grimes Jr. | Julio.Kohler43@hotmail.com | Italy |
6 | Clinton Cruickshank | Johnnie_Rodriguez10@yahoo.com | Sierra Leone |
7 | Tanya Schimmel | Arielle_Farrell70@hotmail.com | Israel |
8 | Mr. Josh Dach II | Jerald.Wolf11@hotmail.com | Taiwan |
9 | Mr. Jason Hessel | Hershel.Jakubowski@gmail.com | Cameroon |
10 | Angel Kessler | Rene.Hickle@hotmail.com | Malaysia |
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 |