Declaration
Initializers
5 SwiftUI initializers back <Gauge>. The props you pass pick one.
<Gauge
value: number
in?: SwiftRange<number>
>
children?: ReactNode
</Gauge>nonisolated init<V>(
value: V,
in bounds: ClosedRange<V> = 0...1,
@ContentBuilder label: () -> Label
)
where CurrentValueLabel == EmptyView, BoundsLabel == EmptyView, MarkedValueLabels == EmptyView, V : BinaryFloatingPointvalue*numberThe value to show in the gauge.
inSwiftRange<number>The range of the valid values. Defaults to
0...1.Default
`0...1`Swiftin bounds: ClosedRange<V>childrenReactNodeContent. Strings become
Text; React Native views are laid out by Yoga and placed by SwiftUI.Swift
label: () -> Label
Also takes the common view props: modifiers, style and testID.
Overview
A gauge is a view that shows a current level of a value in relation to a specified finite capacity, very much like a fuel gauge in an automobile. Gauge displays are configurable; they can show any combination of the gauge's current value, the range the gauge can display, and a label describing the purpose of the gauge itself.
In its most basic form, a gauge displays a single value along the path of the gauge mapped into a range from 0 to 100 percent. The example below sets the gauge's indicator to a position 40 percent along the gauge's path:
struct SimpleGauge: View {
@State private var batteryLevel = 0.4
var body: some View {
Gauge(value: batteryLevel) {
Text("Battery Level")
}
}
}You can make a gauge more descriptive by describing its purpose, showing its current value and its start and end values. This example shows the gauge variant that accepts a range and adds labels using multiple trailing closures describing the current value and the minimum and maximum values of the gauge:
struct LabeledGauge: View {
@State private var current = 67.0
@State private var minValue = 0.0
@State private var maxValue = 170.0
var body: some View {
Gauge(value: current, in: minValue...maxValue) {
Text("BPM")
} currentValueLabel: {
Text("\(Int(current))")
} minimumValueLabel: {
Text("\(Int(minValue))")
} maximumValueLabel: {
Text("\(Int(maxValue))")
}
}
}As shown above, the default style for gauges is a linear, continuous bar with an indicator showing the current value, and optional labels describing the gauge's purpose, current, minimum, and maximum values.
To change the style of a gauge, use the View.gaugeStyle(_:)
view modifier and supply an initializer for a specific gauge style. For
example, to display the same gauge in a circular style, apply the
GaugeStyle.circular style to the view:
struct LabeledGauge: View {
@State private var current = 67.0
@State private var minValue = 0.0
@State private var maxValue = 170.0
var body: some View {
Gauge(value: current, in: minValue...maxValue) {
Text("BPM")
} currentValueLabel: {
Text("\(Int(current))")
} minimumValueLabel: {
Text("\(Int(minValue))")
} maximumValueLabel: {
Text("\(Int(maxValue))")
}
.gaugeStyle(.circular)
}
}To style elements of a gauge's presentation, you apply view modifiers to the elements that you want to change. In the example below, the current value, minimum and maximum value labels have custom colors:
struct StyledGauge: View {
@State private var current = 67.0
@State private var minValue = 50.0
@State private var maxValue = 170.0
var body: some View {
Gauge(value: current, in: minValue...maxValue) {
Image(systemName: "heart.fill")
.foregroundColor(.red)
} currentValueLabel: {
Text("\(Int(current))")
.foregroundColor(Color.green)
} minimumValueLabel: {
Text("\(Int(minValue))")
.foregroundColor(Color.green)
} maximumValueLabel: {
Text("\(Int(maxValue))")
.foregroundColor(Color.red)
}
.gaugeStyle(.circular)
}
}You can further style a gauge's appearance by supplying a tint color or
a gradient to the style's initializer. The following example shows the
effect of a gradient in the initialization of a CircularGaugeStyle
gauge with a colorful gradient across the length of the gauge:
struct StyledGauge: View {
@State private var current = 67.0
@State private var minValue = 50.0
@State private var maxValue = 170.0
let gradient = Gradient(colors: [.green, .yellow, .orange, .red])
var body: some View {
Gauge(value: current, in: minValue...maxValue) {
Image(systemName: "heart.fill")
.foregroundColor(.red)
} currentValueLabel: {
Text("\(Int(current))")
.foregroundColor(Color.green)
} minimumValueLabel: {
Text("\(Int(minValue))")
.foregroundColor(Color.green)
} maximumValueLabel: {
Text("\(Int(maxValue))")
.foregroundColor(Color.red)
}
.gaugeStyle(CircularGaugeStyle(tint: gradient))
}
}From Apple’s SwiftUI documentation. Code samples there are Swift.
Relationships
Conforms to
- View
See also
More in Views.
- ArrangementViewA view that arranges primary and secondary content using an adaptive layout that responds to the environment.
- ControlGroupA container view that displays semantically-related controls in a visually-appropriate manner for the context
- DividerA visual element that can be used to separate other content.
- EditButtonA button that toggles the edit mode environment value.
- EmptyViewA view that doesn't contain any content.
- GroupA type that collects multiple instances of a content type --- like views, scenes, or commands --- into a single unit.
- GroupBoxA stylized view, with an optional label, that visually collects a logical grouping of content.
- RenameButtonA button that triggers a standard rename action.
- SwipeActionsSwipe actions of a list row (SwiftUI swipeActions(edge:allowsFullSwipe:content:)). Place it inside a List.
- TimelineViewA view that updates according to a schedule that you provide.
- ViewThatFitsA view that adapts to the available space by providing the first child view that fits.