Dropdown Component


a!dropdownField( label, labelPosition, instructions, required, disabled, choiceLabels, choiceValues, placeholder, value, validations, saveInto, validationGroup, requiredMessage, helpTooltip, accessibilityText, showWhen, searchDisplay )

Displays a list of choices for the user to select one item and saves a value based on the selected choice.

If the user may select none, one, or many of the choices, use either the checkbox component or a multiple dropdown component.

If there aren't many choices and users would benefit from easily seeing them all at once, consider using radio buttons.


Name Keyword Types Description




Text to display as the field label.

Label Position



Determines where the label appears. Valid values:

  • "ABOVE" (default) Displays the label above the component.
  • "ADJACENT" Displays the label to the left of the component.
  • "JUSTIFIED" Aligns the label alongside the component starting at the edge of the page.
  • "COLLAPSED" Hides the label. The label will still be read by screen readers; see accessibility considerations for more information.




Supplemental text about this field.




Determines if a value is required to submit the form. Default: false.




Determines if the field should display as potentially editable but grayed out. Default: false.

Choice Labels


List of Text String

Array of options for the user to select.

Choice Values


List of Variant

Array of values associated with the available choices.




Text to display when nothing is selected and the value is null.

Selected Value


Any Type

Value of the choice to display as selected.



List of Text String

Validation errors to display below the field when the value is not null.

Save Selection To


List of Save

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.

Validation Group



When present, this field is only validated when a button in the same validation group is pressed. See this recipe for more information about how to use validation groups.

Required Message



Custom message to display when the field's value is required and not provided.

Help Tooltip



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".

Accessibility Text



Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.




Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true.

Search Display



Determines when a search box displays above the options. Valid values: "AUTO" (default), "ON", "OFF". When set to "AUTO", the search box displays if there are more than 11 options.

Usage considerations

Using the placeholder parameter

  • To allow users on web to clear the selected value, text must be specified for the placeholder parameter. Users can always clear the value on the Appian for Mobile application.
  • Passing a null value to the dropdown's Selected Value parameter causes the placeholder text to appear selected. The Placeholder and Selected Value parameter cannot both be null.

Using the choiceLabels and choiceValues parameters

  • Options display in the same order as defined in the Choice Labels parameter. The Choice Labels parameter cannot be null.
  • Choice Values cannot contain nulls or duplicate values.
  • The Choice Labels list and Choice Values list must be the same length.
  • If you are trying to decide whether to use a dropdown with search or a picker component, keep in mind that the dropdown search runs client-side and the performance cost of loading options happens on initial load whereas the picker search runs server-side and the performance cost of loading options happens while the user is searching. For small sets of options, we recommend using the dropdown component.


Use the interactive editor below to test out your code:

Since the searchDisplay parameter is set to AUTO and the number of choiceValues is less than 12, no search box will be displayed.

Since the searchDisplay parameter is set to AUTO and the number of choiceValues is more than 11, a search box will be displayed.

Since the searchDisplay parameter is set to ON, even though the number of choiceValues is less than 12, a search box will be displayed.

Old versions

There are older versions of this Interface Component. You can identify older versions by looking at the name to see if there is a version suffix. If you are using an old version, be sure to refer to the corresponding documentation from the list below.

Old Versions Reason for Update

Added an optional search box and renamed the placeholderLabel parameter to placeholder.'

To learn more about how Appian handles this kind of versioning, see the Function and Component Versions page.

The following patterns include usage of the Dropdown Component.

Open in Github Built: Tue, May 23, 2023 (06:12:33 PM)

On This Page