Skip to content

CarouselLayout

Displays children as slides in a carousel with optional navigation buttons, dots, auto-play, and keyboard support.

new CarouselLayout(slide1, slide2, slide3)
PropertyTypeDefaultDescription
idStringOptional component ID
contentList<Component>Slide components
altbooleanfalseFlips navigation position (top for horizontal, left for vertical)
autobooleantrueAdvances slides automatically
directionOrientationhorizontalhorizontal or vertical
disabledbooleanfalseDisables the carousel
disableSwipebooleanfalseDisables swipe/drag navigation
disableKeysbooleanfalseDisables keyboard navigation
durationint0Auto-play interval in milliseconds (0 = default 4000 ms)
dotsbooleanfalseShows navigation dots
loopbooleanfalseLoops back to first slide from last
navbooleantrueShows previous/next navigation buttons
selectedint0Initially selected slide index
styleStringInline CSS
cssClassesStringCSS class names
CarouselLayout.builder()
.content(List.of(slide1, slide2, slide3))
.auto(true)
.dots(true)
.loop(true)
.duration(3000)
.build()
CarouselLayout.builder()
.content(List.of(slide1, slide2, slide3))
.auto(false)
.nav(true)
.dots(true)
.build()
CarouselLayout.builder()
.content(List.of(slide1, slide2))
.direction(Orientation.vertical)
.nav(true)
.build()