Skip to content

API

Vue Snap Carousel – API

Props

PropTypeDefaultDescription
hideArrowsBooleanfalseHides navigation arrows
hideArrowsOnBoundBooleanfalseHides arrows when at the first or last slide
tagString'ul'HTML tag used for the slide container
i18nObject{ slideLeft: 'Slide left', slideRight: 'Slide right' }Translations for accessibility and tooltips

Events

EventPayloadDescription
mounted-Emitted when the carousel is mounted
slide-changeNumberEmitted on slide change (new index)
left-boundBooleanEmitted when the first slide is reached
right-boundBooleanEmitted when the last slide is reached

Slots

SlotDescription
defaultSlot for slide content
arrowsSlot for custom arrow controls

Functions

MethodParametersDescription
goToSlideindex: NumberNavigates to a specific slide by index
changeSlidedirection: Number (1 or -1)Moves forward (1) or backward (-1) one slide