Skip to content

Alert - Frameworks

Alerts show high-signal messages meant to be noticed and prompting users.

AndroidreleasedElementsreleasediOSreleasedReactreleasedReact 19releasedVuereleased

iOS

Syntax

swift
Warp.Alert(
    style: Warp.AlertStyle,
    title: String,
    subtitle: String,
    link: ButtonConstructor? = nil,
    primaryButton: ButtonConstructor? = nil,
    secondaryButton: ButtonConstructor? = nil
)

ButtonConstructor is a typealias for (title: String, action: () -> Void).

swift
Warp.Alert(
    style: .critical,
    title: "This is the critical variant of the alert component",
    subtitle: "With an additional description"
)

There are four types of alert styles:

swift
enum Warp.AlertStyle {
    /// Used to display messages that provide the user with general information.
    case info
    /// Used to indicate that something is not working as expected or might need attention.
    case warning
    /// Used to indicate a severe problem or error that requires immediate attention.
    case critical
    /// Used to indicate that an action was successful or that a task was completed successfully.
    case success
}

It is possible to add an optional link text, primary button and a secondary button or all together.

swift
Warp.Alert(
    style: .critical,
    title: "This is the critical variant of the alert component",
    subtitle: "With an additional description",
    link: (title: "Link to more information", action: {}),
    primaryButton: (title: "Button", action: {}),
    secondaryButton: (title: "Button", action: {})
)

Legacy support

By default all Warp components return a SwiftUI View but there is always a UIKit UIView available to use also.

swift
Warp.Alert(
    style: .critical,
    title: "This is the critical variant of the alert component",
    subtitle: "With an additional description"
).uiView

Parameters

Required props

NameTypeDefaultDescription
styleWarp.AlertStyleThe visual style of the alert, which dictates its colors, icons, and overall appearance. Use one of the predefined AlertStyle values: .info, .warning, .critical, or .success.
titleStringThe primary text displayed at the top of the alert, used to capture the user's attention.
subtitleStringAdditional information displayed below the title, used to provide further context to the alert.

Optional Props

NameTypeDefaultDescription
link(title: String, action: () -> Void)?nilAn optional tuple containing the title and action for a clickable link that appears below the subtitle.
primaryButton(title: String, action: () -> Void)?nilAn optional tuple containing the title and action for a primary button.
secondaryButton(title: String, action: () -> Void)?nilAn optional tuple containing the title and action for a secondary button.

Questions?

Feel free to ask any questions on usage in the Warp DS Slack channel: #warp-design-system