Composable defining the background to be displayed for a given item's index. `listHasFocus` argument can be used to hide the background when the list is not in focus

background

modifier

Alignment of the List with respect to the Immersive List.

listAlignment

composable defining the list of items that has to be rendered

list

Immersive List consists of a list with multiple items and a background that displays content based on the item in focus.

ImmersiveList

A card that displays a single item (usually in a list)

ItemListCard

the state object to be used to control or observe the list's state.

state

a padding around the whole content. This will add padding for the. content after it has been clipped, which is not possible via [modifier] param. You can use it to add a padding before the first item or after the last one. If you want to add a spacing between each item use [verticalArrangement].

contentPadding

reverse the direction of scrolling and layout. When `true`, items are laid out in the reverse order and [LazyListState.firstVisibleItemIndex] == 0 means that column is scrolled to the bottom. Note that [reverseLayout] does not change the behavior of [verticalArrangement], e.g. with [Arrangement.Top] (top) 123### (bottom) becomes (top) 321### (bottom).

reverseLayout

The vertical arrangement of the layout's children. This allows to add a spacing between items and specify the arrangement of the items when we have not enough of them to fill the whole minimum size.

verticalArrangement

the horizontal alignment applied to the items.

horizontalAlignment

flingBehavior

whether the scrolling via the user gestures or accessibility actions is allowed. You can still scroll programmatically using the state even when it is disabled

userScrollEnabled

a block which describes the content. Inside this block you can use methods like [LazyListScope.item] to add a single item or [LazyListScope.items] to add a list of items

content

The vertically scrolling list that only composes and lays out the currently visible items.

LazyColumn

items

the state object to be used to control or observe the list's state

reverse the direction of scrolling and layout, when `true` items will be composed from the bottom to the top and [LazyListState.firstVisibleItemIndex] == 0 will mean we scrolled to the bottom.

the horizontal alignment applied to the items

emits the UI for an item from [items] list. May emit any number of components, which will be stacked vertically. Note that [LazyColumnFor] can start scrolling incorrectly if you emit nothing and then lazily recompose with the real content, so even if you load the content asynchronously please reserve some space for the item, for example using [Spacer]. Use [LazyColumnForIndexed] if you need to have both index and item params

itemContent

A vertically scrolling list that only composes and lays out the currently visible items.

LazyColumnFor

emits the UI for an item from [items] list. It has two params: first one is an index in the [items] list, and the second one is the item at this index from [items] list. May emit any number of components, which will be stacked vertically. Note that [LazyColumnForIndexed] can start scrolling incorrectly if you emit nothing and then lazily recompose with the real content, so even if you load the content asynchronously please reserve some space for the item, for example using [Spacer]

LazyColumnForIndexed

convenience param to specify a padding around the whole content. This will add padding for the content after it has been clipped, which is not possible via [modifier] param. Note that it isnot* a padding applied for each item's content

emits the UI for an item from [items] list. May emit any number of components, which will be stacked vertically. Note that [LazyColumnItems] can start scrolling incorrectly if you emit nothing and then lazily recompose with the real content, so even if you load the content asynchronously please reserve some space for the item, for example using [Spacer]

LazyColumnItems

a padding around the whole content. This will add padding for the content after it has been clipped, which is not possible via [modifier] param. You can use it to add a padding before the first item or after the last one. If you want to add a spacing between each item use [horizontalArrangement].

reverse the direction of scrolling and layout. When `true`, items are laid out in the reverse order and [LazyListState.firstVisibleItemIndex] == 0 means that row is scrolled to the end. Note that [reverseLayout] does not change the behavior of [horizontalArrangement], e.g. with [Arrangement.Start] [123###] becomes [321###].

The horizontal arrangement of the layout's children. This allows to add a spacing between items and specify the arrangement of the items when we have not enough of them to fill the whole minimum size.

horizontalArrangement

the vertical alignment applied to the items

verticalAlignment

whether the scrolling via the user gestures or accessibility actions is allowed. You can still scroll programmatically using the state even when it is disabled.

The horizontally scrolling list that only composes and lays out the currently visible items.

LazyRow

reverse the direction of scrolling and layout, when `true` items will be composed from the end to the start and [LazyListState.firstVisibleItemIndex] == 0 will mean the first item is located at the end.

the vertical alignment applied to the items.

emits the UI for an item from [items] list. May emit any number of components, which will be stacked horizontally. Note that [LazyRowFor] can start scrolling incorrectly if you emit nothing and then lazily recompose with the real content, so even if you load the content asynchronously please reserve some space for the item, for example using [Spacer]. Use [LazyRowForIndexed] if you need to have both index and item params

A horizontally scrolling list that only composes and lays out the currently visible items.

LazyRowFor

emits the UI for an item from [items] list. It has two params: first one is an index in the [items] list, and the second one is the item at this index from [items] list. May emit any number of components, which will be stacked horizontally. Note that [LazyRowForIndexed] can start scrolling incorrectly if you emit nothing and then lazily recompose with the real content, so even if you load the content asynchronously please reserve some space for the item, for example using [Spacer]

LazyRowForIndexed

emits the UI for an item from [items] list. May emit any number of components, which will be stacked horizontally. Note that [LazyRowItems] can start scrolling incorrectly if you emit nothing and then lazily recompose with the real content, so even if you load the content asynchronously please reserve some space for the item, for example using [Spacer]

LazyRowItems

The background color to apply - typically Color.Transparent

backgroundColor

contentColor

A slot based composable for creating a list header item.

ListHeader

headlineContent

[Modifier] to be applied to the list item

the content displayed above the headline content

overlineContent

supportingContent

leadingContent

the trailing meta text, icon, switch or checkbox

trailingContent

[ListItemColors] that will be used to resolve the background and content color for this list item in different states. See [ListItemDefaults.colors]

colors

tonalElevation

shadowElevation

ListItem

data

Composable layout for a list template app widget.

ListTemplate

The modifier to be applied to the component

reverse the direction of scrolling and layout, when `true` items will be composed from the bottom to the top

The vertical arrangement of the layout's children. This allows us to add spacing between items and specify the arrangement of the items when we have not enough of them to fill the whole minimum size

Logic describing fling behavior. If snapping is required use [ScalingLazyColumnDefaults.snapFlingBehavior].

The parameters to configure the scaling and transparency effects for the component

scalingParams

How to anchor list items to the center-line of the viewport

anchorType

AutoCenteringParams parameter to control whether space/padding should be automatically added to make sure that list items can be scrolled into the center of the viewport (based on their [anchorType]). If non-null then space will be added before the first list item, if needed, to ensure that items with indexes greater than or equal to the itemIndex (offset by itemOffset pixels) will be able to be scrolled to the center of the viewport. Similarly space will be added at the end of the list to ensure that items can be scrolled up to the center. If null no automatic space will be added and instead the developer can use [contentPadding] to manually arrange the items.

autoCentering

ScalingLazyColumn

reverse the direction of scrolling and layout. When `true`, items are laid out in the reverse order and [TvLazyListState.firstVisibleItemIndex] == 0 means that column is scrolled to the bottom. Note that [reverseLayout] does not change the behavior of [verticalArrangement], e.g. with [Arrangement.Top] (top) 123### (bottom) becomes (top) 321### (bottom).

a block which describes the content. Inside this block you can use methods like

offsets of child element within the parent and starting edge of the child from the pivot defined by the parentOffset. [TvLazyListScope.item] to add a single item or [TvLazyListScope.items] to add a list of items

pivotOffsets

TvLazyColumn

reverse the direction of scrolling and layout. When `true`, items are laid out in the reverse order and [TvLazyListState.firstVisibleItemIndex] == 0 means that row is scrolled to the end. Note that [reverseLayout] does not change the behavior of [horizontalArrangement], e.g. with [Arrangement.Start] [123###] becomes [321###].

offsets of child element within the parent and starting edge of the child from the pivot defined by the parentOffset.

a block which describes the content. Inside this block you can use methods like [TvLazyListScope.item] to add a single item or [TvLazyListScope.items] to add a list of items

TvLazyRow

A list of all Jetpack Compose List components listed on our website, you can use in your Jetpack Compose projects.

Jetpack Compose List components

ItemListCard

ListItem

Bring your next idea to life with Compose UI