GaugeStyle

Defines the implementation of all gauge instances within a view hierarchy.

ProtocoliOS 16.0+macOS 13.0+watchOS 7.0+GaugeStyle in SwiftUI

Declaration

React
type GaugeStyle =
  | 'accessoryCircular'
  | 'accessoryCircularCapacity'
  | 'accessoryLinear'
  | 'accessoryLinearCapacity'
  | 'automatic'
  | 'linearCapacity'
  | AccessoryCircularCapacityGaugeStyle
  | AccessoryCircularGaugeStyle
  | AccessoryLinearCapacityGaugeStyle
  | AccessoryLinearGaugeStyle
  | DefaultGaugeStyle
  | LinearCapacityGaugeStyle;
Swift
@MainActor @preconcurrency protocol GaugeStyle

Pass a literal, or build one with SwiftUI.GaugeStyle from import { SwiftUI } from 'swiftui-react-native'.

Type properties

  • 'accessoryCircular'SwiftUI.GaugeStyle.accessoryCircular

    A gauge style that displays an open ring with a marker that appears at a point along the ring to indicate the gauge's current value.

  • 'accessoryCircularCapacity'SwiftUI.GaugeStyle.accessoryCircularCapacity

    A gauge style that displays a closed ring that's partially filled in to indicate the gauge's current value.

  • 'accessoryLinear'SwiftUI.GaugeStyle.accessoryLinear

    A gauge style that displays bar with a marker that appears at a point along the bar to indicate the gauge's current value.

  • 'accessoryLinearCapacity'SwiftUI.GaugeStyle.accessoryLinearCapacity

    A gauge style that displays bar that fills from leading to trailing edges as the gauge's current value increases.

  • 'automatic'SwiftUI.GaugeStyle.automatic

    The default gauge view style in the current context of the view being styled.

  • 'linearCapacity'SwiftUI.GaugeStyle.linearCapacity

    A gauge style that displays a bar that fills from leading to trailing edges as the gauge's current value increases.

Overview

To configure the style for all the Gauge instances in a view hierarchy, use the View.gaugeStyle(_:) modifier. For example, you can configure a gauge to use the circular style:

Gauge(value: batteryLevel, in: 0...100) {
    Text("Battery Level")
}
.gaugeStyle(.circular)

A type conforming to this protocol inherits @preconcurrency @MainActor isolation from the protocol if the conformance is included in the type's base declaration:

struct MyCustomType: Transition {
    // `@preconcurrency @MainActor` isolation by default
}

Isolation to the main actor is the default, but it's not required. Declare the conformance in an extension to opt out of main actor isolation:

extension MyCustomType: Transition {
    // `nonisolated` by default
}

From Apple’s SwiftUI documentation. Code samples there are Swift.

Used by

See also

More in Styles.