OrionCarousel

<o-carousel> aims at being a simple way to display a carousel component.

It comes with many options to customize its behavior like auto sliding, pause timer when hovering and many slots to manage the content.

Usage

CarouselSimpleSlider CarouselAutoSlider CarouselPoster CarouselPlayground

Props

Name
colorOrion.Color | Orion.ColorAlt = 'brand'
hideNavigationButtonsboolean = false
hideNavigationDotsboolean = false
loopboolean = false
modelValuenumber | string = undefined
pauseOnHoverboolean = false
stepTimernumber = undefined

Events

Name
Payload type
update:modelValue
number | string

Slots

Name
Bindings
poster
step: number | string | undefined
stepIndex: number
default
step: number | string | undefined
stepIndex: number
goPreviousStep: () => void
goNextStep: () => void
navigation
step: number | string | undefined
stepIndex: number
goPreviousStep: () => void
goNextStep: () => void
actions
step: number | string | undefined
stepIndex: number
goPreviousStep: () => void
goNextStep: () => void
goToStep: (step: { name: number | string }) => void
goToStepIndex: (index: number) => void

PublicInstance

Name
Type
step
() => string | number | undefined
stepsLength
() => number
stepIndex
() => number
shouldLoop
() => boolean
goToStep
(step: { name: string | number; uid: number; }) => void
goToStepIndex
(index: number) => void
goPreviousStep
() => void
goNextStep
() => void
_el
(() => HTMLElement | undefined) | undefined

Provide

Name
Type
_carousel
publicInstance

Props

Name
lazyboolean = false
lazyOnceboolean = false
namenumber | string = undefined
Required

Slots

Name
Bindings
default
isActive: boolean