confirmationDialog

Presents a confirmation dialog when a given condition is true, using a localized string resource for the title.

View ModifieriOS 16.0+macOS 13.0+tvOS 16.0+watchOS 9.0+

Overloads

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

React
compose().confirmationDialog(
  titleResource: string,
  options: {
    isPresented: Binding<boolean>;
    titleVisibility?: SwiftUI.Visibility;
    actions: ReactNode;
  }
)
Swift
@export(implementation) nonisolated func confirmationDialog<A>(
    _ titleResource: LocalizedStringResource,
    isPresented: Binding<Bool>,
    titleVisibility: Visibility = .automatic,
    @ContentBuilder actions: () -> A
) -> some View
where A : View
3 more Swift overloads share this form
Swift
nonisolated func confirmationDialog<A>(
    _ titleKey: LocalizedStringKey,
    isPresented: Binding<Bool>,
    titleVisibility: Visibility = .automatic,
    @ContentBuilder actions: () -> A
) -> some View
where A : View
Swift
nonisolated func confirmationDialog<A>(
    _ title: Text,
    isPresented: Binding<Bool>,
    titleVisibility: Visibility = .automatic,
    @ContentBuilder actions: () -> A
) -> some View
where A : View
Swift
nonisolated func confirmationDialog<S, A>(
    _ title: S,
    isPresented: Binding<Bool>,
    titleVisibility: Visibility = .automatic,
    @ContentBuilder actions: () -> A
) -> some View
where S : StringProtocol, A : View

Parameters

  • titleResource*string

    Text resource for the localized string that describes the title of the dialog.

  • options.isPresented*Binding<boolean>

    A binding to a Boolean value that determines whether to present the dialog. When the user presses or taps the dialog's default action button, the system sets this value to false, dismissing the dialog.

  • options.titleVisibilitySwiftUI.Visibility

    The visibility of the dialog's title. The default value is Visibility.automatic.

  • options.actions*ReactNode

    A ContentBuilder returning the dialog's actions.

Discussion

In the example below, a button conditionally presents a confirmation dialog depending upon the value of a bound Boolean variable. When the Boolean value is set to true, the system displays a confirmation dialog with a cancel action and a destructive action.

struct ConfirmEraseItems: View {
    @State private var isShowingDialog = false
    var body: some View {
        Button("Empty Trash") {
            isShowingDialog = true
        }
        .confirmationDialog(
            "Permanently erase the items in the Trash?",
            isPresented: $isShowingDialog
        ) {
            Button("Empty Trash", role: .destructive) {
                // Handle empty trash action.
            }
        }
    }
}

All actions in a confirmation dialog will dismiss the dialog after the action runs. The default button will be shown with greater prominence. You can influence the default button by assigning it the KeyboardShortcut.defaultAction keyboard shortcut.

The system may reorder the buttons based on their role and prominence.

Dialogs include a standard dismiss action by default. If you provide a button with a role of ButtonRole.cancel, that button takes the place of the default dismiss action. You don't have to dismiss the presentation with the cancel button's action.

dialogs as a popover that the user dismisses by tapping anywhere outside the popover, rather than displaying the standard dismiss action.

On iOS, tvOS, and watchOS, confirmation dialogs only support controls with labels that are Text. Passing any other type of view results in the content being omitted.

This modifier creates a Text view for the title on your behalf. See Text for more information about localizing strings.

See also

More in Presentation.