Skip to main content
161

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
React Native docs
Data displayReact Native

Gauge

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

Public APILumenGaugeReact Native

Native example

Use Gauge

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

View verified React Native runtime capture
Gauge rendered in the Expo web renderer Lumen playground
Verified runtime captureExpo web renderer
tsx
<LumenGauge
  label="Thermal pressure"
  value={48}
  valueLabel="Fair"
  tone="warning"
/>

Reference

Public API

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

APIValues or typeDefaultDescription
labelstringRequiredNames the bounded metric.
valuenumberRequiredProvides the current value.
maxnumber100Provides 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

Apple / SwiftUIAndroid / Compose
React Native docsNative primitives