ToggleStyle

The appearance and behavior of a toggle.

ProtocoliOS 13.0+macOS 10.15+tvOS 13.0+watchOS 6.0+ToggleStyle in SwiftUI

Declaration

React
type ToggleStyle =
  | 'automatic'
  | 'button'
  | 'switch'
  | ButtonToggleStyle
  | DefaultToggleStyle
  | SwitchToggleStyle;
Swift
@MainActor @preconcurrency protocol ToggleStyle

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

Type properties

Overview

To configure the style for a single Toggle or for all toggle instances in a view hierarchy, use the View.toggleStyle(_:) modifier. You can specify one of the built-in toggle styles, like ToggleStyle.switch or ToggleStyle.button:

Toggle(isOn: $isFlagged) {
    Label("Flag", systemImage: "flag.fill")
}
.toggleStyle(.button)

Alternatively, you can create and apply a custom style.

Custom styles

To create a custom style, declare a type that conforms to the ToggleStyle protocol and implement the required ToggleStyle.makeBody(configuration:) method. For example, you can define a checklist toggle style:

struct ChecklistToggleStyle: ToggleStyle {
    func makeBody(configuration: Configuration) -> some View {
        // Return a view that has checklist appearance and behavior.
    }
}

Inside the method, use the configuration parameter, which is an instance of the ToggleStyleConfiguration structure, to get the label and a binding to the toggle state. To see examples of how to use these items to construct a view that has the appearance and behavior of a toggle, see ToggleStyle.makeBody(configuration:).

To provide easy access to the new style, declare a corresponding static variable in an extension to ToggleStyle:

extension ToggleStyle where Self == ChecklistToggleStyle {
    static var checklist: ChecklistToggleStyle { .init() }
}

You can then use your custom style:

Toggle(activity.name, isOn: $activity.isComplete)
    .toggleStyle(.checklist)

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.