Skip to content

Reference

an-alert

The system alert or action sheet, with its buttons — presented by the platform, not drawn by us.

UIAlertController on iOS, MaterialAlertDialog on Android, NSAlert on the Mac, SwiftUI’s .alert on the watch. [sheet] switches iOS to an action sheet instead of a centred alert.

[buttons] is a list of titles and (select) reports which index was chosen. The button order, the destructive styling and which one is cancel are the platform’s conventions, which differ between iOS and Android in ways worth not overriding.

iOS · iPadOS Android macOS tvOS visionOS watchOS Wear OS
iOS · iPadOS Android macOS watchOS
UIAlertController MaterialAlertDialog NSAlert .alert
Prop Type Default
sheet boolean | null false An action sheet instead of a centred dialog.
visible boolean | null false
title string | null ''
message string | null ''
buttons readonly string[] | null null The buttons’ titles, in order. With none, an “OK” shows up.
Output Payload
(select) number The index of the button that was pressed.
<an-alert
[visible]="confirming()"
[title]="'Delete this note?'"
[message]="'It cannot be undone.'"
[buttons]="['Cancel', 'Delete']"
(select)="onChoice($event)" />

Every primitive also carries the base props — background, border, opacity, the transforms, animate, the accessibility contract — and every gesture. See Components for the full base, Events for the payloads.