ComponentsCarousel
Carousel
The Carousel component is a dynamic and responsive content display tool for your applications. It provides support for various configurations, including slide alignment, text direction, and slide orientation.
The Carousel component is a dynamic and responsive content display tool for your applications. It provides support for various configurations, including slide alignment, text direction, and slide orientation.
API reference docs for the component. Learn about the props, CSS, and other APIs of this exported module.
'center' | 'end' | 'start'
The alignment of the slides in the carousel.
'ltr' | 'rtl'
The document's text/writing direction.
() => ShadowRoot | Node | Document
A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.
string
The unique identifier of the machine.
Partial<{ root: string viewport: string slide(index: number): string slideGroup: string nextSlideTrigger: string prevSlideTrigger: string indicatorGroup: string indicator(index: number): string }>
The ids of the elements in the carousel. Useful for composition.
number
The current slide index.
boolean
Whether the carousel should loop around.
(details: SlideChangeDetails) => void
Function called when the slide changes.
'horizontal' | 'vertical'
The orientation of the carousel.
number | 'auto'
The number of slides to show at a time.
string
The amount of space between slides.
boolean
Whether the carousel is can scroll to the next slide
boolean
Whether the carousel is can scroll to the previous slide
(props: SlideIndicatorProps) => Dict<any>
(props: SlideProps) => Dict<any>
(props: SlideProps) => SlideState
Returns the state of a specific slide
number
The current index of the carousel
Dict<any>
boolean
Whether the carousel is currently auto-playing
Dict<any>
() => void
Function to pause autoplay
() => void
Function to start/resume autoplay
Dict<any>
Dict<any>
number
The current scroll progress of the carousel
(index: number, jump?: boolean | undefined) => void
Function to scroll to a specific slide index
() => void
Function to scroll to the next slide
() => void
Function to scroll to the previous slide
Dict<any>
Dict<any>
number
number
boolean