androidx.compose.material3.carousel

Interfaces

`CarouselItemDrawInfo`	Interface to hold information about a Carousel item and its size.	Cmn
`CarouselItemScope`	Receiver scope for `Carousel` item content.	Cmn

Classes

CarouselState

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

Cmn

Objects

CarouselDefaults

Contains the default values used by Carousel.

Cmn

Top-level functions summary

`Unit`	`@ExperimentalMaterial3Api @Composable HorizontalMultiBrowseCarousel( state: CarouselState, preferredItemWidth: Dp, modifier: Modifier, itemSpacing: Dp, flingBehavior: TargetedFlingBehavior, minSmallItemWidth: Dp, maxSmallItemWidth: Dp, contentPadding: PaddingValues, content: @Composable CarouselItemScope.(itemIndex: Int) -> Unit )` Material Design Carousel	Cmn
`Unit`	`@ExperimentalMaterial3Api @Composable HorizontalUncontainedCarousel( state: CarouselState, itemWidth: Dp, modifier: Modifier, itemSpacing: Dp, flingBehavior: TargetedFlingBehavior, contentPadding: PaddingValues, content: @Composable CarouselItemScope.(itemIndex: Int) -> Unit )` Material Design Carousel	Cmn
`CarouselState`	`@ExperimentalMaterial3Api @Composable rememberCarouselState(initialItem: Int, itemCount: () -> Int)` Creates a `CarouselState` that is remembered across compositions.	Cmn

Top-level functions

HorizontalMultiBrowseCarousel

Cmn

Artifact: androidx.compose.material3:material3

View Source

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

Material Design Carousel

A horizontal carousel meant to display many items at once for quick browsing of smaller content like album art or photo thumbnails.

Note that this carousel may adjust the size of items in order to ensure a mix of large, medium, and small items fit perfectly into the available space and are arranged in a visually pleasing way. Carousel then lays out items using the large item size and clips (or masks) items depending on their scroll offset to create items which smoothly expand and collapse between the large, medium, and small sizes.

For more information, see design guidelines.

Example of a multi-browse carousel:

import androidx.annotation.DrawableRes
import androidx.annotation.StringRes
import androidx.compose.foundation.Image
import androidx.compose.foundation.layout.PaddingValues
import androidx.compose.foundation.layout.height
import androidx.compose.foundation.layout.width
import androidx.compose.material.icons.filled.Image
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.carousel.HorizontalMultiBrowseCarousel
import androidx.compose.material3.carousel.rememberCarouselState
import androidx.compose.runtime.remember
import androidx.compose.ui.Modifier
import androidx.compose.ui.layout.ContentScale
import androidx.compose.ui.res.painterResource
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.unit.dp

data class CarouselItem(
    val id: Int,
    @DrawableRes val imageResId: Int,
    @StringRes val contentDescriptionResId: Int
)

val items =
    listOf(
        CarouselItem(0, R.drawable.carousel_image_1, R.string.carousel_image_1_description),
        CarouselItem(1, R.drawable.carousel_image_2, R.string.carousel_image_2_description),
        CarouselItem(2, R.drawable.carousel_image_3, R.string.carousel_image_3_description),
        CarouselItem(3, R.drawable.carousel_image_4, R.string.carousel_image_4_description),
        CarouselItem(4, R.drawable.carousel_image_5, R.string.carousel_image_5_description),
    )

HorizontalMultiBrowseCarousel(
    state = rememberCarouselState { items.count() },
    modifier = Modifier.width(412.dp).height(221.dp),
    preferredItemWidth = 186.dp,
    itemSpacing = 8.dp,
    contentPadding = PaddingValues(horizontal = 16.dp)
) { i ->
    val item = items[i]
    Image(
        modifier = Modifier.height(205.dp).maskClip(MaterialTheme.shapes.extraLarge),
        painter = painterResource(id = item.imageResId),
        contentDescription = stringResource(item.contentDescriptionResId),
        contentScale = ContentScale.Crop
    )
}

Parameters
`state: CarouselState`	The state object to be used to control the carousel's state
`preferredItemWidth: Dp`	The width that large, fully visible items would like to be in the horizontal axis. This width is a target and will likely be adjusted by carousel in order to fit a whole number of items within the container. Carousel adjusts small items first (between the `minSmallItemWidth` and `maxSmallItemWidth`) then medium items when present, and finally large items if necessary.
`modifier: Modifier = Modifier`	A modifier instance to be applied to this carousel container
`itemSpacing: Dp = 0.dp`	The amount of space used to separate items in the carousel
`flingBehavior: TargetedFlingBehavior = CarouselDefaults.singleAdvanceFlingBehavior(state = state)`	The `TargetedFlingBehavior` to be used for post scroll gestures
`minSmallItemWidth: Dp = CarouselDefaults.MinSmallItemSize`	The minimum allowable width of small items in dp. Depending on the `preferredItemWidth` and the width of the carousel, the small item width will be chosen from a range of `minSmallItemWidth` and `maxSmallItemWidth`
`maxSmallItemWidth: Dp = CarouselDefaults.MaxSmallItemSize`	The maximum allowable width of small items in dp. Depending on the `preferredItemWidth` and the width of the carousel, the small item width will be chosen from a range of `minSmallItemWidth` and `maxSmallItemWidth`
`contentPadding: PaddingValues = PaddingValues(0.dp)`	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: @Composable CarouselItemScope.(itemIndex: Int) -> Unit`	The carousel's content Composable

HorizontalUncontainedCarousel

Cmn

Artifact: androidx.compose.material3:material3

View Source

@ExperimentalMaterial3Api
@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
): 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:

import androidx.annotation.DrawableRes
import androidx.annotation.StringRes
import androidx.compose.foundation.Image
import androidx.compose.foundation.layout.PaddingValues
import androidx.compose.foundation.layout.height
import androidx.compose.foundation.layout.width
import androidx.compose.material.icons.filled.Image
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.carousel.HorizontalUncontainedCarousel
import androidx.compose.material3.carousel.rememberCarouselState
import androidx.compose.runtime.remember
import androidx.compose.ui.Modifier
import androidx.compose.ui.layout.ContentScale
import androidx.compose.ui.res.painterResource
import androidx.compose.ui.res.stringResource
import androidx.compose.ui.unit.dp

data class CarouselItem(
    val id: Int,
    @DrawableRes val imageResId: Int,
    @StringRes val contentDescriptionResId: Int
)

val items =
    listOf(
        CarouselItem(0, R.drawable.carousel_image_1, R.string.carousel_image_1_description),
        CarouselItem(1, R.drawable.carousel_image_2, R.string.carousel_image_2_description),
        CarouselItem(2, R.drawable.carousel_image_3, R.string.carousel_image_3_description),
        CarouselItem(3, R.drawable.carousel_image_4, R.string.carousel_image_4_description),
        CarouselItem(4, R.drawable.carousel_image_5, R.string.carousel_image_5_description),
    )
HorizontalUncontainedCarousel(
    state = rememberCarouselState { items.count() },
    modifier = Modifier.width(412.dp).height(221.dp),
    itemWidth = 186.dp,
    itemSpacing = 8.dp,
    contentPadding = PaddingValues(horizontal = 16.dp)
) { i ->
    val item = items[i]
    Image(
        modifier = Modifier.height(205.dp).maskClip(MaterialTheme.shapes.extraLarge),
        painter = painterResource(id = item.imageResId),
        contentDescription = stringResource(item.contentDescriptionResId),
        contentScale = ContentScale.Crop
    )
}

Parameters
`state: CarouselState`	The state object to be used to control the carousel's state
`itemWidth: Dp`	The width of items in the carousel
`modifier: Modifier = Modifier`	A modifier instance to be applied to this carousel container
`itemSpacing: Dp = 0.dp`	The amount of space used to separate items in the carousel
`flingBehavior: TargetedFlingBehavior = CarouselDefaults.noSnapFlingBehavior()`	The `TargetedFlingBehavior` to be used for post scroll gestures
`contentPadding: PaddingValues = PaddingValues(0.dp)`	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: @Composable CarouselItemScope.(itemIndex: Int) -> Unit`	The carousel's content Composable

rememberCarouselState

Cmn

Artifact: androidx.compose.material3:material3

View Source

Added in 1.3.0

@ExperimentalMaterial3Api
@Composable
fun rememberCarouselState(initialItem: Int = 0, itemCount: () -> Int): CarouselState

Creates a CarouselState that is remembered across compositions.

Parameters
`initialItem: Int = 0`	The initial item that should be scrolled to.
`itemCount: () -> Int`	The number of items this Carousel will have.