ListSubHeader

Component in Wear Material 3 Compose

A two slot based composable for creating a list sub-header item. [ListSubHeader]s offer slots for an icon and for a text label. The contents will be start and end padded.

Last updated: 2024-10-22 13:47

Installation

dependencies {
   implementation("androidx.wear.compose:compose-material3:1.0.0-alpha27")
}

Overloads

@Composable
fun ListSubHeader(
    modifier: Modifier = Modifier,
    backgroundColor: Color = Color.Transparent,
    contentColor: Color = ListHeaderDefaults.subHeaderContentColor,
    contentPadding: PaddingValues = ListHeaderDefaults.SubHeaderContentPadding,
    icon: (@Composable BoxScope.() -> Unit)? = null,
    label: @Composable RowScope.() -> Unit,
)

Parameters

name	description
modifier	The modifier for the [ListSubHeader].
backgroundColor	The background color to apply - typically Color.Transparent
contentColor	The color to apply to content.
contentPadding	The spacing values to apply internally between the container and the content.
icon	A slot for providing icon to the [ListSubHeader].
label	A slot for providing label to the [ListSubHeader].

Code Examples

ListSubHeaderSample

@Composable
fun ListSubHeaderSample() {
    ListSubHeader { Text("SubHeader") }
}

ListSubHeaderWithIconSample

@Composable
fun ListSubHeaderWithIconSample() {
    ListSubHeader(
        label = { Text(text = "SubHeader") },
        icon = { Icon(imageVector = Icons.Outlined.Home, "home") }
    )
}