New Compose Multiplatform components arrived on Composables UICheck it out →

Badge

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:

Installation

dependencies {
   implementation("androidx.compose.material:material:1.7.0-beta03")
}

Overloads

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

Parameters

namedescription
modifieroptional [Modifier] for this item
backgroundColorthe background color for the badge
contentColorthe color of label text rendered in the badge
contentoptional content to be rendered inside the badge