Skip to content

UIAlertAction ​

UIAlertAction represents a button on a system alert. A button has a title and a style. When the user taps it, the alert closes first, and then the button fires the click event.

Add buttons to an alert with addAction(). The title and style are given at creation and can't be changed afterward.

Inheritance: EventTarget → NSObject → UIAlertAction

For how to build common alerts with buttons, see the guide Showing alerts and menus.

Constructor ​

Can't be created with new. new UIAlertAction() throws TypeError: Illegal constructor: UIAlertAction has no public initializer; use UIAlertAction.actionWithTitle(title, { style }). Create one with the static method below.

Static methods ​

UIAlertAction.actionWithTitle()

Creates a button with a title and a style.

Instance properties ​

PropertyDescription
title read-onlyThe text on the button
style read-onlyThe style: normal, cancel, or destructive
isEnabledWhether it can be tapped

Events ​

EventWhen it fires
clickThe user taps this button. Fires after the alert closes

This is the only name the system fires. Listening for other names doesn't throw: such a name is treated as a custom event and only fires when you dispatch it yourself with dispatchEvent().

The three button styles ​

styleEffect
'default'A normal button
'cancel'Cancel. Its position is arranged by the system, not by the order buttons were added. At most one per alert. In an action sheet, tapping outside the menu is the same as tapping it
'destructive'The title is red, indicating the action deletes something or can't be undone

How the three styles look on screen is not verified in the simulator.

Examples ​

js
const alert = UIAlertController.alertControllerWithTitle('Delete this photo?', {
  preferredStyle: 'alert',
});
const remove = UIAlertAction.actionWithTitle('Delete', { style: 'destructive' });
remove.addEventListener('click', () => {
  console.log('photo deleted');
});
alert.addAction(UIAlertAction.actionWithTitle('Cancel', { style: 'cancel' }));
alert.addAction(remove);

Effect (not verified in the simulator): Once presented, the bottom of the alert has "Cancel" and a red "Delete". Tap "Delete": the alert disappears and the console prints photo deleted.

Corresponding iOS API ​

ObjCJS
[UIAlertAction actionWithTitle:@"OK" style:UIAlertActionStyleDefault handler:^(UIAlertAction *a) { … }]const a = UIAlertAction.actionWithTitle('OK', { style: 'default' });
a.addEventListener('click', () => { … })
action.enabled = NOaction.isEnabled = false

See also ​