Components
Carousel

Carousel

A slideshow component that cycles through elements.

API Reference

Root

PropTypeDefault
align
'center' | 'end' | 'start'
asChild
boolean
defaultIndex
number
dir
'ltr' | 'rtl'
getRootNode
() => ShadowRoot | Node | Document
id
string
ids
Partial<{ root: string viewport: string slide(index: number): string slideGroup: string nextSlideTrigger: string prevSlideTrigger: string indicatorGroup: string indicator(index: number): string }>
index
number
loop
boolean
onSlideChange
(details: SlideChangeDetails) => void
orientation
'horizontal' | 'vertical'
slidesPerView
number | 'auto'
spacing
string

Slide

PropTypeDefault
index
number
asChild
boolean

Control

PropTypeDefault
asChild
boolean

Viewport

PropTypeDefault
asChild
boolean

Indicator

PropTypeDefault
index
number
asChild
boolean
readOnly
boolean

SlideGroup

PropTypeDefault
asChild
boolean

IndicatorGroup

PropTypeDefault
asChild
boolean

NextSlideTrigger

PropTypeDefault
asChild
boolean

PrevSlideTrigger

PropTypeDefault
asChild
boolean