Function: a!dropdownField()
Displays a limited set of exclusive choices from which the user must select one item and saves a value based on the selected choice. To save the index of the choice instead of a value, use dropdown by index.
If the user may select none, one, or many of the choices, then consider using checkboxes or a multiple dropdown.
If there aren't many choices and users would benefit from easily seeing them all at once, consider using radio buttons.
See Also: Interface Recipe: Configure a Dropdown Field to Save a CDT, Interface Recipe: Configure a Dropdown with an Extra Option for Other, Interface Recipe: Configure Cascading Dropdowns
Parameters
Name | Keyword | Type | Description |
---|---|---|---|
Label | label | Text | Optional text to display as the field label. |
Label Position | labelPosition | Text | Optional text to determine where the label appears. Valid values include
|
Instructions | instructions | Text | Optional text displayed below the dropdown. |
Help Tooltip | helpTooltip | Text | Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is "COLLAPSED" . |
Choice Labels | choiceLabels | Text Array | List of options for the user to choose from. |
Placeholder Label | placeholderLabel | Text Array | Text to display at the top of the list. |
Choice Values | choiceValues | Any Type | List of values associated with the available choices. |
Selected Value | value | Any Type | Value corresponding to the selected choice. |
Save Selection To | saveInto | Save Array | One or more variables that are updated with the choice value when the user changes the selection. Use a!save() to save a modified or alternative value to a variable. |
Required | required | Boolean | Determines if a value is required to submit the form. Default is false . |
Required Message | requiredMessage | Text | Custom message to be displayed when the field's value is required and not provided. |
Disabled | disabled | Boolean | Determines if the user is prevented from changing the value. Default is false . |
Validations | validations | Text Array | Validation errors to be displayed below the field when the value is not null. |
Validation Group | validationGroup | Text | When present, this field is only validated when a button in the same validation group is clicked. |
Visibility | showWhen | Boolean | Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true. |
Notes
"ADJACENT"
or "ABOVE"
, but do not give a value for Label, a space still displays to the left-side or above, respectively, of the component as if there was a label displayed. To ensure the component appears to the far left when Label has no value, use "COLLAPSED"
for Label Position.Examples
Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.
Disabled Dropdown with Label Displayed Above
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
=a!dropdownField(
label: "Language",
labelPosition: "ABOVE",
instructions: "In which language are you most proficient?",
choiceLabels: {
"English",
"Spanish",
"French",
"German"
},
choiceValues: {
"en_US",
"es_ES",
"fr_FR",
"de_DE"
},
value: "en_US",
disabled: true
)
Displays the following:
Editable Dropdown with the First Choice Selected by Default
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
=load(
local!language: "en_US",
a!dropdownField(
label: "Language",
instructions: "In which language are you most proficient?",
choiceLabels: {
"English",
"Spanish",
"French",
"German"
},
choiceValues: {
"en_US",
"es_ES",
"fr_FR",
"de_DE"
},
value: local!language,
saveInto: local!language
)
)
Displays the following:
Dropdown with a Blank Choice Selected by Default
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
=load(
local!language: null,
a!dropdownField(
label: "Language",
instructions: "In which language are you most proficient?",
choiceLabels: {
"English",
"Spanish",
"French",
"German"
},
placeholderLabel: "Select a language...",
choiceValues: {
"en_US",
"es_ES",
"fr_FR",
"de_DE"
},
value: local!language,
saveInto: local!language
)
)
Displays the following:
On This Page