Create new instance.
If true, a "Cancel" button will be included in the dialog. Defaults to true. If the user selects the cancel button, the show() method will return false. If false, no cancel button will be displayed and the user must select one of the button name options.
A longer message explaining the purpose of the dialog, if needed.
Short title.
After the show() method is called, this property will contain the name of the button selected by the user.
After the show() method is called, this property will contain values from any fields added to the prompt. The dictionary keys will be the names of the fields as passed in when they were created, and the value will be the current contents of that field. They type of data depends on the type of field.
Add a button to the array of buttons to be displayed. All buttons should be created before calling show().
only needed to associate a different value than will be displayed in the button. For example, if you call prompt.addButton("First Button", 1), after calling prompt.show() if that button is pressed, the prompt.buttonPressed will contain the number value 1.
used to specify a single button which will be pinned to the bottom of the prompt and respond to cmd + return as the default button. If only one button is added to a prompt, it is assumed to be the default.
Add a date and/or time picker to the prompt, with the arguments as below. The fieldValues entry for this will be a date object.
Identifier for the field. This will be used as the key in the fieldValues dictionary to access the contents of the field after calling show().
User-friendly text label to place next to the field.
The initial date to selected for the field. Minimum and maximum values should be defined in options.
A dictionary of options for configuring the text field.
Add an information text label to the prompt.
Identifier for the field.
The text of the label.
A dictionary of options for configuring the text field.
Same as addTextField, but the input field will be password masked.
Add a picker to the prompt, with the arguments as below. Picker can contain multiple rows. The fieldValues entry for this will be a array of selected index values object.
Identifier for the field. This will be used as the key in the fieldValues dictionary to access the contents of the field after calling show().
User-friendly text label to place next to the field.
The values to display in the picker. Should be an array containing arrays of string values, each sub-array representing a column in the picker. Example two column picker: [["Item 1", "Item 2"],["Column 2 Item 1", "Column 2 Item 2"]]
Array of zero-based index values to set the initial selected row in each column.
Add a segmented control. Best used for selection between a small number of values. Returns a string value in fieldValues.
Identifier for the field. This will be used as the key in the fieldValues dictionary to access the contents of the field after calling show().
User-friendly text label to place next to the field.
The array of string values that will be available in the segmented control.
String values that should be initially selected when the prompt is displayed. Value should match value in the values array.
Add a select control. Returns an array of string values in fieldValues.
Identifier for the field. This will be used as the key in the fieldValues dictionary to access the contents of the field after calling show().
User-friendly text label to place next to the field.
The array of string values that will be available to select.
Array of string values that should be initially selected when the prompt is displayed. All values in this array should match values in the values array.
If false, selecting a value will deselect all other values. If true, the user may select multiple items.
Add an on/off toggle switch. The fieldValues entry for this item will be a boolean indicating whether the switch was on.
Identifier for the field. This will be used as the key in the fieldValues dictionary to access the contents of the field after calling show().
User-friendly text label to place next to the field.
indicate if the switch should be on or off when initially displayed.
Add a text input field to the prompt
Identifier for the field. This will be used as the key in the fieldValues dictionary to access the contents of the field after calling show().
User-friendly text label to place next to the field.
The initial text contents for the field.
A dictionary of options for configuring the text field.
Should system autocorrect be enabled in field, Default: true
Placeholder text to use when field is empty
If true, focus this field when prompt is displayed
Add a text input field to the prompt
Identifier for the field. This will be used as the key in the fieldValues dictionary to access the contents of the field after calling show().
User-friendly text label to place next to the field.
The initial text contents for the field.
A dictionary of options for configuring the text field.
Should system autocorrect be enabled in field, Default: true
If true, focus this field when prompt is displayed
Displays the prompt. Returns true if the user selected one of the buttons in the buttons array, false if the user selected the "Cancel" button. After the dialog has been shown, the buttonPressed property will contain the name of the button selected by the user.
Create new instance.
Generated using TypeDoc
Prompt
Prompts allow the creation and display of custom dialogs to request information or confirmation from the user.
Example
var p = Prompt.create(); p.title = "Hello"; p.message = "World!"; p.addTextField("textFieldName", "Label", ""); p.addDatePicker("myDate", "Start date", new Date(), { "mode": "date" }); p.addButton("First"); p.addButton("Second"); var didSelect = p.show(); var textFieldContents = p.fieldValues["textFieldName"]; var startDate = p.fieldValues["myDate"]; if (p.buttonPressed == "First") { // do something }