ListHeader

Component in Wear Material 3 Compose

A slot based composable for creating a list header item. [ListHeader]s are typically expected to be a few words of text on a single line. 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 ListHeader(
    modifier: Modifier = Modifier,
    backgroundColor: Color = Color.Transparent,
    contentColor: Color = ListHeaderDefaults.ContentColor,
    contentPadding: PaddingValues = ListHeaderDefaults.ContentPadding,
    content: @Composable RowScope.() -> Unit
)

Parameters

name	description
modifier	The modifier for the [ListHeader].
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.
content	Slot for [ListHeader] content, expected to be a single line of text.

Code Example

ListHeaderSample

@Composable
fun ListHeaderSample() {
    ListHeader { Text("Header") }
}