Prop | Default | Type |
---|---|---|
as | 'nav' | AsTag | Component The element or component this component should render as. Can be overwritten by |
asChild | boolean Change 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 | number The value of the page that should be active when initially rendered. Use when you do not need to control the value state. |
disabled | boolean When | |
itemsPerPage* | number Number of items per page | |
page | number The controlled value of the current page. Can be binded as | |
showEdges | false | boolean When |
siblingCount | 2 | number Number of sibling should be shown around the current page |
total | 0 | number Number of items in your list |
Emit | Payload |
---|---|
update:page | [value: number] Event handler called when the page value changes |
Slots (default) | Payload |
---|---|
page | number Current page state |
pageCount | number Number of pages |