Compose Multiplatform Material3/androidx.compose.material3.carousel

Package-level declarations

Types

Link copied to clipboard
object CarouselDefaults

Contains the default values used by Carousel.

Link copied to clipboard
sealed interface CarouselItemDrawInfo

Interface to hold information about a Carousel item and its size.

Link copied to clipboard
sealed interface CarouselItemScope

Receiver scope for Carousel item content.

Link copied to clipboard
class CarouselState(currentItem: Int = 0, @FloatRange(from = -0.5, to = 0.5) currentItemOffsetFraction: Float = 0.0f, itemCount: () -> Int) : ScrollableState

The state that can be used to control all types of carousels.

Functions

Link copied to clipboard
@Composable
fun HorizontalCenteredHeroCarousel(state: CarouselState, modifier: Modifier = Modifier, maxItemWidth: Dp = Dp.Unspecified, itemSpacing: Dp = 0.dp, flingBehavior: TargetedFlingBehavior = CarouselDefaults.singleAdvanceFlingBehavior(state = state), userScrollEnabled: Boolean = true, minSmallItemWidth: Dp = CarouselDefaults.MinSmallItemSize, maxSmallItemWidth: Dp = CarouselDefaults.MaxSmallItemSize, contentPadding: PaddingValues = PaddingValues(0.dp), content: @Composable CarouselItemScope.(itemIndex: Int) -> Unit)

Material Design Carousel

Link copied to clipboard
@Composable
fun HorizontalMultiBrowseCarousel(state: CarouselState, preferredItemWidth: Dp, modifier: Modifier = Modifier, itemSpacing: Dp = 0.dp, flingBehavior: TargetedFlingBehavior = CarouselDefaults.singleAdvanceFlingBehavior(state = state), userScrollEnabled: Boolean = true, minSmallItemWidth: Dp = CarouselDefaults.MinSmallItemSize, maxSmallItemWidth: Dp = CarouselDefaults.MaxSmallItemSize, contentPadding: PaddingValues = PaddingValues(0.dp), content: @Composable CarouselItemScope.(itemIndex: Int) -> Unit)

Material Design Carousel

Link copied to clipboard
@Composable
fun HorizontalUncontainedCarousel(state: CarouselState, itemWidth: Dp, modifier: Modifier = Modifier, itemSpacing: Dp = 0.dp, flingBehavior: TargetedFlingBehavior = CarouselDefaults.noSnapFlingBehavior(), userScrollEnabled: Boolean = true, contentPadding: PaddingValues = PaddingValues(0.dp), content: @Composable CarouselItemScope.(itemIndex: Int) -> Unit)

Material Design Carousel

Link copied to clipboard
@Composable
fun rememberCarouselState(initialItem: Int = 0, itemCount: () -> Int): CarouselState

Creates a CarouselState that is remembered across compositions.