Skip to main content
161

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
Apple docs
Data displayApple

Gauge

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

Public APILumenGaugeApple / SwiftUISwift product: LumenUI

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 Gauge

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

Gauge rendered in the iPhone simulator Lumen playground
Verified runtime captureiPhone simulator
swift
LumenGauge(
    "Thermal pressure",
    value: 48,
    valueLabel: "Fair",
    systemName: "thermometer.medium",
    tone: .warning
)

Reference

Public API

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

APIValues or typeDefaultDescription
labelLocalizedStringKeyRequiredNames the bounded metric.
valueDoubleRequiredProvides the current value.
maxDouble100Provides 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 NativeAndroid / Compose
Apple docsSwiftUI package