Badge

Component in Material Compose

Badge is a component that can contain dynamic information, such as the presence of a new notification or a number of pending requests. Badges can be icon only or contain short text.

See [BadgedBox] for a top level layout that will properly place the badge relative to content such as text or an icon.

Last updated: 2024-10-22 13:47

Installation

dependencies {
   implementation("androidx.compose.material:material:1.8.0-alpha04")
}

Overloads

@Composable
fun Badge(
    modifier: Modifier = Modifier,
    backgroundColor: Color = MaterialTheme.colors.error,
    contentColor: Color = contentColorFor(backgroundColor),
    content: @Composable (RowScope.() -> Unit)? = null,
)

Parameters

name	description
modifier	optional [Modifier] for this item
backgroundColor	the background color for the badge
contentColor	the color of label text rendered in the badge
content	optional content to be rendered inside the badge