Skip to main content
161

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
Android docs
Data displayAndroid

Gauge

Show a normalized circular native metric with a formatted accessible value.

Public APILumenGaugeAndroid / Compose

Native example

Use Gauge

Use for a current bounded metric, not task completion. Use Progress when the value represents work moving toward completion.

Gauge rendered in the Android phone emulator Lumen playground
Verified runtime captureAndroid phone emulator
kotlin
LumenGauge(
    label = "Thermal pressure",
    value = 48f,
    valueLabel = "Fair",
    tone = LumenMetricTone.Warning
)

Reference

Public API

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

APIValues or typeDefaultDescription
labelStringRequiredNames the bounded metric.
valueFloatRequiredProvides the current value.
maxFloat100Provides the positive maximum.
valueLabelStringRequiredProvides the visible and accessible formatted value.
toneneutral · brand · accent · success · warning · dangerbrandSelects semantic emphasis.

Native behavior

Design and accessibility

When to use it

Use for a current bounded metric, not task completion. Use Progress when the value represents work moving toward completion.

Accessibility

The visual ring is replaced by one accessible label and formatted value. Invalid values are normalized into the valid range.

Shared component

Available on other platforms

React NativeApple / SwiftUI
Android docsCompose module