Skip to main content
161

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
Android docs
Data displayAndroid

Badge

Display compact native status and classification labels using semantic tones.

Public APILumenBadgeAndroid / Compose

Native example

Use Badge

Use short status or classification labels. Prefer normal text for sentences, instructions, and frequently changing numeric values.

Badge rendered in the Android phone emulator Lumen playground
Verified runtime captureAndroid phone emulator
kotlin
LumenBadge(
    text = "Active",
    tone = LumenBadgeTone.Success
)

Reference

Public API

The primary shared and platform-specific options exposed by LumenBadge.

APIValues or typeDefaultDescription
textString / native textRequiredProvides the visible badge label.
toneneutral · accent · success · warning · dangerneutralSelects the semantic status treatment.
modifierNative layout APIAdds platform-native layout adjustments.

Native behavior

Design and accessibility

When to use it

Use short status or classification labels. Prefer normal text for sentences, instructions, and frequently changing numeric values.

Accessibility

Badge text remains available to assistive technology. Do not encode status only through tone.

Shared component

Available on other platforms

React NativeApple / SwiftUI
Android docsCompose module