Action sheet
- 18 May 2022
- 1 Minute to read
-
DarkLight
-
PDF
Action sheet
- Updated on 18 May 2022
- 1 Minute to read
-
DarkLight
-
PDF
Display a blocking action sheet, allowing the user to select from a given set of label-value pairs.
Selecting one of the options triggers the first output. Pressing the cancel button or outside the action sheet will trigger the second output.
On iPad, the cancel button is not shown.
Input arguments
| Label | Key | Type | Required? | Default | Description |
|---|---|---|---|---|---|
| Action sheet options | actionSheetOptions |
Array | Yes | – | List of options to choose from. The buttons on the action sheet will display the text in the label property of the object. |
| Action sheet title text | title |
String | Yes | Pick action | Title text to show at the top of the action sheet. |
| Cancel button label | cancelLabel |
String | Yes | Cancel | Text label on the cancel button. |
Output arguments
Number of outputs: 3
| Label | Key | Type | Description |
|---|---|---|---|
| Picked action | pickedAction
|
Object | Action picked by the user, as an object with `label` and `value` properties. |
|
pickedAction.label
|
String | Action label. |
|
pickedAction.value
|
String|Number|Boolean|Array|Object | Action value. |
Events
No events.
Errors
| Label | Code | Description |
|---|---|---|
| Unknown error | unknown |
Thrown if an unknown error occurred while showing the action sheet. |
Was this article helpful?