ListItemDefaults - API Reference Item in Compose TV Material

Contains the default values used by list items.

Android

object ListItemDefaults

Contains the default values used by list items.

Properties

Android

val IconSize = 32.dp

The default Icon size used by ListItem.

Android

val IconSizeDense = 20.dp

The Icon size used by DenseListItem.

Android

val TonalElevation = Elevation.Level0

The default elevation used by ListItem.

Functions

shape

@ReadOnlyComposable
    @Composable
    fun shape(
        shape: Shape = ListItemShape,
        focusedShape: Shape = shape,
        pressedShape: Shape = shape,
        selectedShape: Shape = shape,
        disabledShape: Shape = shape,
        focusedSelectedShape: Shape = shape,
        focusedDisabledShape: Shape = disabledShape,
        pressedSelectedShape: Shape = shape,
    ) =
        ListItemShape(
            shape = shape,
            focusedShape = focusedShape,
            pressedShape = pressedShape,
            selectedShape = selectedShape,
            disabledShape = disabledShape,
            focusedSelectedShape = focusedSelectedShape,
            focusedDisabledShape = focusedDisabledShape,
            pressedSelectedShape = pressedSelectedShape,
        )

Creates a ListItemShape that represents the default container shapes used in a ListItem

Parameters


shape	the default shape used when the ListItem is enabled
focusedShape	the shape used when the ListItem is enabled and focused
pressedShape	the shape used when the ListItem is enabled and pressed
selectedShape	the shape used when the ListItem is enabled and selected
disabledShape	the shape used when the ListItem is not enabled
focusedSelectedShape	the shape used when the ListItem is enabled, focused and selected
focusedDisabledShape	the shape used when the ListItem is not enabled and focused
pressedSelectedShape	the shape used when the ListItem is enabled, pressed and selected

colors

@ReadOnlyComposable
    @Composable
    fun colors(
        containerColor: Color = Color.Transparent,
        contentColor: Color = MaterialTheme.colorScheme.onSurface,
        focusedContainerColor: Color = MaterialTheme.colorScheme.inverseSurface,
        focusedContentColor: Color = contentColorFor(focusedContainerColor),
        pressedContainerColor: Color = focusedContainerColor,
        pressedContentColor: Color = contentColorFor(focusedContainerColor),
        selectedContainerColor: Color =
            MaterialTheme.colorScheme.secondaryContainer.copy(
                alpha = SelectedContainerColorOpacity
            ),
        selectedContentColor: Color = MaterialTheme.colorScheme.onSecondaryContainer,
        disabledContainerColor: Color = Color.Transparent,
        disabledContentColor: Color = MaterialTheme.colorScheme.onSurface,
        focusedSelectedContainerColor: Color = focusedContainerColor,
        focusedSelectedContentColor: Color = focusedContentColor,
        pressedSelectedContainerColor: Color = pressedContainerColor,
        pressedSelectedContentColor: Color = pressedContentColor,
    ) =
        ListItemColors(
            containerColor = containerColor,
            contentColor = contentColor,
            focusedContainerColor = focusedContainerColor,
            focusedContentColor = focusedContentColor,
            pressedContainerColor = pressedContainerColor,
            pressedContentColor = pressedContentColor,
            selectedContainerColor = selectedContainerColor,
            selectedContentColor = selectedContentColor,
            disabledContainerColor = disabledContainerColor,
            disabledContentColor = disabledContentColor,
            focusedSelectedContainerColor = focusedSelectedContainerColor,
            focusedSelectedContentColor = focusedSelectedContentColor,
            pressedSelectedContainerColor = pressedSelectedContainerColor,
            pressedSelectedContentColor = pressedSelectedContentColor,
        )

Creates a ListItemColors that represents the default container & content colors used in a ListItem

Parameters


containerColor	the default container color used when the ListItem is enabled
contentColor	the default content color used when the ListItem is enabled
focusedContainerColor	the container color used when the ListItem is enabled and focused
focusedContentColor	the content color used when the ListItem is enabled and focused
pressedContainerColor	the container color used when the ListItem is enabled and pressed
pressedContentColor	the content color used when the ListItem is enabled and pressed
selectedContainerColor	the container color used when the ListItem is enabled and selected
selectedContentColor	the content color used when the ListItem is enabled and selected
disabledContainerColor	the container color used when the ListItem is not enabled
disabledContentColor	the content color used when the ListItem is not enabled
focusedSelectedContainerColor	the container color used when the ListItem is enabled, focused and selected
focusedSelectedContentColor	the content color used when the ListItem is enabled, focused and selected
pressedSelectedContainerColor	the container color used when the ListItem is enabled, pressed and selected
pressedSelectedContentColor	the content color used when the ListItem is enabled, pressed and selected

scale

fun scale(
        @FloatRange(from = 0.0) scale: Float = 1f,
        @FloatRange(from = 0.0) focusedScale: Float = 1.05f,
        @FloatRange(from = 0.0) pressedScale: Float = scale,
        @FloatRange(from = 0.0) selectedScale: Float = scale,
        @FloatRange(from = 0.0) disabledScale: Float = scale,
        @FloatRange(from = 0.0) focusedSelectedScale: Float = focusedScale,
        @FloatRange(from = 0.0) focusedDisabledScale: Float = disabledScale,
        @FloatRange(from = 0.0) pressedSelectedScale: Float = scale,
    ) =
        ListItemScale(
            scale = scale,
            focusedScale = focusedScale,
            pressedScale = pressedScale,
            selectedScale = selectedScale,
            disabledScale = disabledScale,
            focusedSelectedScale = focusedSelectedScale,
            focusedDisabledScale = focusedDisabledScale,
            pressedSelectedScale = pressedSelectedScale,
        )

Creates a ListItemScale that represents the default scales used in a ListItem. scales are used to modify the size of a composable in different Interaction states e.g. 1f (original) in default state, 1.2f (scaled up) in focused state, 0.8f (scaled down) in pressed state, etc.

Parameters


scale	the scale used when the ListItem is enabled.
focusedScale	the scale used when the ListItem is enabled and focused.
pressedScale	the scale used when the ListItem is enabled and pressed.
selectedScale	the scale used when the ListItem is enabled and selected.
disabledScale	the scale used when the ListItem is not enabled.
focusedSelectedScale	the scale used when the ListItem is enabled, focused and selected.
focusedDisabledScale	the scale used when the ListItem is not enabled and focused.
pressedSelectedScale	the scale used when the ListItem is enabled, pressed and selected.

border

@ReadOnlyComposable
    @Composable
    fun border(
        border: Border = Border.None,
        focusedBorder: Border = border,
        pressedBorder: Border = focusedBorder,
        selectedBorder: Border = border,
        disabledBorder: Border = border,
        focusedSelectedBorder: Border = focusedBorder,
        focusedDisabledBorder: Border = FocusedDisabledBorder,
        pressedSelectedBorder: Border = border,
    ) =
        ListItemBorder(
            border = border,
            focusedBorder = focusedBorder,
            pressedBorder = pressedBorder,
            selectedBorder = selectedBorder,
            disabledBorder = disabledBorder,
            focusedSelectedBorder = focusedSelectedBorder,
            focusedDisabledBorder = focusedDisabledBorder,
            pressedSelectedBorder = pressedSelectedBorder,
        )

Creates a ListItemBorder that represents the default Borders applied on a ListItem in different Interaction states

Parameters


border	the default Border used when the ListItem is enabled
focusedBorder	the Border used when the ListItem is enabled and focused
pressedBorder	the Border used when the ListItem is enabled and pressed
selectedBorder	the Border used when the ListItem is enabled and selected
disabledBorder	the Border used when the ListItem is not enabled
focusedSelectedBorder	the Border used when the ListItem is enabled, focused and selected
focusedDisabledBorder	the Border used when the ListItem is not enabled and focused
pressedSelectedBorder	the Border used when the ListItem is enabled, pressed and selected

glow

fun glow(
        glow: Glow = Glow.None,
        focusedGlow: Glow = glow,
        pressedGlow: Glow = glow,
        selectedGlow: Glow = glow,
        focusedSelectedGlow: Glow = focusedGlow,
        pressedSelectedGlow: Glow = glow,
    ) =
        ListItemGlow(
            glow = glow,
            focusedGlow = focusedGlow,
            pressedGlow = pressedGlow,
            selectedGlow = selectedGlow,
            focusedSelectedGlow = focusedSelectedGlow,
            pressedSelectedGlow = pressedSelectedGlow,
        )

Creates a ListItemGlow that represents the default Glows used in a ListItem.

Parameters


glow	the Glow used when the ListItem is enabled, and has no other Interactions.
focusedGlow	the Glow used when the ListItem is enabled and focused.
pressedGlow	the Glow used when the ListItem is enabled and pressed.
selectedGlow	the Glow used when the ListItem is enabled and selected.
focusedSelectedGlow	the Glow used when the ListItem is enabled, focused and selected.
pressedSelectedGlow	the Glow used when the ListItem is enabled, pressed and selected.