alert

Presents an alert 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

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

React
compose().alert(
  titleResource: string,
  options: {
    isPresented: Binding<boolean>;
    actions: ReactNode;
  }
)
Swift
@export(implementation) nonisolated func alert<A>(
    _ titleResource: LocalizedStringResource,
    isPresented: Binding<Bool>,
    @ContentBuilder actions: () -> A
) -> some View
where A : View
3 more Swift overloads share this form
Swift
nonisolated func alert<A>(
    _ titleKey: LocalizedStringKey,
    isPresented: Binding<Bool>,
    @ContentBuilder actions: () -> A
) -> some View
where A : View
Swift
nonisolated func alert<A>(
    _ title: Text,
    isPresented: Binding<Bool>,
    @ContentBuilder actions: () -> A
) -> some View
where A : View
Swift
nonisolated func alert<S, A>(
    _ title: S,
    isPresented: Binding<Bool>,
    @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 alert.

  • options.isPresented*Binding<boolean>

    A binding to a Boolean value that determines whether to present the alert. When the user presses or taps one of the alert's actions, the system sets this value to false and dismisses.

  • options.actions*ReactNode

    A ContentBuilder returning the alert's actions.

Discussion

In the example below, a login form conditionally presents an alert by setting the didFail state variable. When the form sets the value to to true, the system displays an alert with an "OK" action.

struct Login: View {
    @State private var didFail = false

    var body: some View {
        LoginForm(didFail: $didFail)
            .alert(
                "Login failed.",
                isPresented: $didFail
            ) {
                Button("OK") {
                    // Handle the acknowledgement.
                }
            }
    }
}

All actions in an alert dismiss the alert after the action runs. The default button is 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.

If no actions are present, the system includes a standard "OK" action. No default cancel action is provided. If you want to show a cancel action, use a button with a role of ButtonRole.cancel.

On iOS, tvOS, and watchOS, alerts 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.