Skip to main content
196

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
Android docs
Data displayAndroid

Carousel

Page through controlled native slides with accessible navigation.

Public APILumenCarouselAndroid / Compose

Native example

Use Carousel

Hosts own stable slide identities and rich content. Native paging requests bounded index changes; there is no autoplay or wrapping. Invalid host indices show recovery without rewriting state.

Carousel rendered in the Android phone emulator Lumen playground
Captured exampleAndroid phone emulator
kotlin
LumenCarousel("Project slides", slides, index, { index = it }) { slide, _ -> LumenText(slide.label) }

Reference

Public API

The primary shared and platform-specific options exposed by LumenCarousel.

APIValues or typeDefaultDescription
slides / indexStable LumenCarouselSlide records / controlled integerRequiredControls the dataset and current visible page.
height / disabled / statusNumeric height / boolean / ready-loading-error200 / false / readyBounds the viewport and guards native paging and result states.

Native behavior

Design and accessibility

When to use it

Hosts own stable slide identities and rich content. Native paging requests bounded index changes; there is no autoplay or wrapping. Invalid host indices show recovery without rewriting state.

Accessibility

Localized slide positions, named previous/next and selected indicators with native paging.

Shared component

Available on other platforms

React NativeApple / SwiftUI
Android docsCompose module