Carousel API
API reference docs for the Stash Carousel
component. Learn about the props, CSS, and other APIs of this exported module.
Import
ts
import Carousel from '@leaflink/stash/Carousel.vue';
Props
Name | Type | Default | Description |
---|---|---|---|
slides | Array | () => [] | The slides to display in the carousel. |
autoplayInterval | number | 0 | Time, in ms, before slides will automatically transition. If not specified, slides are static until manually transitioned. |
hideNavigation | boolean | false | Hide the navigation buttons |
hidePagination | boolean | false | Hide the pagination dots/tile |
itemsToScroll | number | 1 | Number of slides to be scrolled at a time |
itemsToShow | number | 1 | Number of items to show on each slide |
loop | boolean | false | Whether the carousel should loop back to the first slide after the last slide. |
pagination | "tile" | "dot" | tile | The type of pagination to display. |
paginationTileRadius | "standard" | "full" | standard | The radius of the pagination tiles. |
pauseAutoplayOnHover | boolean | false | Prevents slides from automatically transitioning when hovering over the slide. |
roundBorders | boolean | false | Whether to round the borders of the slides. |
staticPaginationDots | boolean | false | Whether to show the pagination dots on all screen sizes. |
Slots
Name | Description |
---|---|
slide |
Events
Name | Description |
---|---|
click | |
transition | |
transition:multi |