When to use it
Use short status or classification labels. Prefer normal text for sentences, instructions, and frequently changing numeric values.
Data displayApple
Badge
Display compact native status and classification labels using semantic tones.
Apple availability
Supported native targets
Import LumenUI in the target that uses this component. iPad support follows the iOS package baseline and uses native iPad layout behavior.
iPhone · iOS 16+iPad · iPadOS 16+Mac · macOS 13+Apple TV · tvOS 16+Apple Vision · visionOS 1+Apple Watch · watchOS 9+
Native example
Use Badge
Use short status or classification labels. Prefer normal text for sentences, instructions, and frequently changing numeric values.
LumenBadge("Active", tone: .success)Reference
Public API
The primary shared and platform-specific options exposed by LumenBadge.
| API | Values or type | Default | Description |
|---|---|---|---|
| content | String / native text | Required | Provides the visible badge label. |
| tone | neutral · accent · success · warning · danger | neutral | Selects the semantic status treatment. |
| SwiftUI modifiers | Native layout API | — | Adds platform-native layout adjustments. |
Native behavior
Design and accessibility
Accessibility
Badge text remains available to assistive technology. Do not encode status only through tone.
Shared component