dialogSuppressionToggle

Enables user suppression of dialogs and alerts presented within self, with a custom suppression message on macOS. Unused on other platforms.

View ModifieriOS 17.0+macOS 14.0+tvOS 17.0+watchOS 10.0+

Overloads

2 ways to call compose().dialogSuppressionToggle(). Each is one SwiftUI overload, picked by the arguments you pass.

React
compose().dialogSuppressionToggle(
  titleResource: string,
  options: {
    isSuppressed: Binding<boolean>;
  }
)
Swift
@export(implementation) nonisolated func dialogSuppressionToggle(
    _ titleResource: LocalizedStringResource,
    isSuppressed: Binding<Bool>
) -> some View
3 more Swift overloads share this form
Swift
nonisolated func dialogSuppressionToggle(
    _ titleKey: LocalizedStringKey,
    isSuppressed: Binding<Bool>
) -> some View
Swift
nonisolated func dialogSuppressionToggle(
    _ label: Text,
    isSuppressed: Binding<Bool>
) -> some View
Swift
nonisolated func dialogSuppressionToggle<S>(
    _ title: S,
    isSuppressed: Binding<Bool>
) -> some View
where S : StringProtocol

Parameters

  • titleResource*string

    The title of the suppression toggle in the dialog. This parameter can be elided to use the default suppression title.

  • options.isSuppressed*Binding<boolean>

    Whether the suppression toggle is on or off in the dialog.

Discussion

Applying dialog suppression adds a toggle to dialogs on macOS, which allows the user to request the alert not be displayed again. Typically whether a dialog is suppressed is stored in AppStorage and used to decide whether to present the dialog in the future.

The following example configures a confirmationDialog with a suppression toggle. The toggle's state is stored in AppStorage and used to determine whether or not to show the dialog when the "Delete Items" button is pressed.

struct ConfirmEraseItems: View {
    @State private var isShowingDialog = false

    @AppStorage("suppressEraseItemAlert")
    private var suppressAlert = false

    var body: some View {
        Button("Delete Items") {
            if !suppressAlert {
                isShowingDialog = true
            } else {
                // Handle item deletion.
            }
        }
        .confirmationDialog(
            "Are you sure you want to erase these items?",
            isPresented: $isShowingDialog
        ) {
            Button("Erase", role: .destructive) {
                // Handle item deletion.
            }
            Button("Cancel", role: .cancel) {
                isShowingDialog = false
            }
        }
        .dialogSuppressionToggle(
            "Do not ask about erasing items again",
            isSuppressed: $suppressAlert)
    }
}

See also

More in Presentation.