Compose Multiplatform Material3/androidx.compose.material3.carousel/HorizontalUncontainedCarousel

HorizontalUncontainedCarousel

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

Material Design Carousel

A horizontal carousel that displays its items with the given size except for one item at the end that is cut off.

Note that the item size will be bound by the size of the carousel. Otherwise, this carousel lays out as many items as it can in the given size, and changes the size of the last cut off item such that there is a range of motion when items scroll off the edge.

For more information, see design guidelines.

Example of an uncontained carousel:

Parameters

state

The state object to be used to control the carousel's state

itemWidth

The width of items in the carousel

modifier

A modifier instance to be applied to this carousel container

itemSpacing

The amount of space used to separate items in the carousel

flingBehavior

The TargetedFlingBehavior to be used for post scroll gestures

contentPadding

a padding around the whole content. This will add padding for the content after it has been clipped. You can use it to add a padding before the first item or after the last one. Use itemSpacing to add spacing between the items.

content

The carousel's content Composable

Samples

androidx.compose.material3.samples.HorizontalUncontainedCarouselSample