Dropdown By Index Component

Function

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

Displays a list of choices for the user to select one item and saves the index of the selected choice. To save a value instead of the index, use a dropdown component.

Parameters

Name Keyword Types Description

Label

label

Text

Text to display as the field label.

Label Position

labelPosition

Text

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.
  • "COLLAPSED" Hides the label. The label will still be read by screen readers; see accessibility considerations for more information.
  • "JUSTIFIED" Aligns the label alongside the component starting at the edge of the page.

Instructions

instructions

Text

Supplemental text about this field.

Required

required

Boolean

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

Disabled

disabled

Boolean

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

Choice Labels

choiceLabels

List of Text String

Array of options for the user to select.

Placeholder

placeholder

Text

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

Selected Index

value

Number (Integer)

Index of the choice to display as selected.

Validations

validations

List of Text String

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

Save Selection To

saveInto

List of Save

One or more variables that are updated with the choice index when the user changes the selection. Use a!save() to save a modified or alternative value to a variable.

Validation Group

validationGroup

Text

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

requiredMessage

Text

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

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

Accessibility Text

accessibilityText

Text

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

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.

Search Display

searchDisplay

Text

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 selectedIndex, choiceLabels, and placeholder parameters

  • Choice index numbers start at 1.
  • The value provided to selectedIndex cannot be null, empty, less than 1, or greater than the length of the choiceLabels array.
  • Passing a null value to the dropdown's selectedIndex parameter causes the placeholder text to appear selected. The Placeholder and Selected Index parameter cannot both be null.
  • The argument passed to the placeholder parameter is null and not an index.
  • Options display in the same order as defined in the choiceLabels parameter. The choiceLabels parameter cannot be null.

Examples

Use the interactive editor below to test out your code:

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
a!dropdownFieldByIndex_20r2

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.

Open in Github Built: Tue, Sep 14, 2021 (11:54:22 AM)

On This Page

FEEDBACK