| Prop | Default | Type |
|---|---|---|
as | 'nav' | AsTag | ComponentThe element or component this component should render as. Can be overwritten by |
asChild | booleanChange the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details. | |
defaultPage | 1 | numberThe value of the page that should be active when initially rendered. Use when you do not need to control the value state. |
disabled | booleanWhen | |
itemsPerPage* | numberNumber of items per page | |
page | numberThe controlled value of the current page. Can be binded as | |
showEdges | false | booleanWhen |
siblingCount | 2 | numberNumber of sibling should be shown around the current page |
total | 0 | numberNumber of items in your list |
| Emit | Payload |
|---|---|
update:page | [value: number]Event handler called when the page value changes |
| Slots (default) | Payload |
|---|---|
page | numberCurrent page state |
pageCount | numberNumber of pages |
