← Back to Tv Material
ImmersiveList
Component
in
Tv Material
. Since 1.0.0-alpha07Overview
Code Examples
Video
Immersive List consists of a list with multiple items and a background that displays content based on the item in focus. To animate the background's entry and exit, use ImmersiveListBackgroundScope.AnimatedContent. To display the background only when the list is in focus, use ImmersiveListBackgroundScope.AnimatedVisibility.
Overloads
ImmersiveList
@Suppress("IllegalExperimentalApiUsage")
@OptIn(ExperimentalComposeUiApi::class)
@ExperimentalTvMaterial3Api
@Composable
fun ImmersiveList(
background:
@Composable ImmersiveListBackgroundScope.(index: Int, listHasFocus: Boolean) -> Unit,
modifier: Modifier = Modifier,
listAlignment: Alignment = Alignment.BottomEnd,
list: @Composable ImmersiveListScope.() -> Unit,
)
Parameters
| Name | Description |
|---|---|
background | 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 |
modifier | applied to Immersive List. |
listAlignment | Alignment of the List with respect to the Immersive List. |
list | composable defining the list of items that has to be rendered |
