Alert
When the user takes an important action (for example when irreversibly deleting something), you can ask for confirmation by using confirmAlert
.
API Reference
confirmAlert
Creates and shows a confirmation Alert with the given options.
Signature
Example
Parameters
Name | Description | Type |
---|---|---|
options* | The options used to create the Alert. |
Return
A Promise that resolves to a boolean when the user triggers one of the actions. It will be true
for the primary Action, false
for the dismiss Action.
Types
Alert.Options
The options to create an Alert.
Example
Properties
Property | Description | Type |
---|---|---|
title* | The title of an alert. Displayed below the icon. |
|
dismissAction | The Action to dismiss the alert. There usually shouldn't be any side effects when the user takes this action. | |
icon | The icon of an alert to illustrate the action. Displayed on the top. | |
message | An additional message for an Alert. Useful to show more information, e.g. a confirmation message for a destructive action. |
|
primaryAction | The primary Action the user can take. | |
rememberUserChoice | If set to true, the Alert will also display a |
|
Alert.ActionOptions
The options to create an Alert Action.
Properties
Property | Description | Type |
---|---|---|
title* | The title of the action. |
|
style | The style of the action. | |
onAction | A callback called when the action is triggered. |
|
Alert.ActionStyle
Defines the visual style of an Action of the Alert.
Use Alert.ActionStyle.Default for confirmations of a positive action. Use Alert.ActionStyle.Destructive for confirmations of a destructive action (eg. deleting a file).
Enumeration members
Name | Value |
---|---|
Default | |
Destructive | |
Cancel |
Last updated