a!multipleDropdownField_20r2 Component

This page contains information related to an old version of the Multiple Dropdown Component.

Old versions do not appear in category lists; only the newest versions are listed.

To take advantage of the latest features and improvements, we always recommend you use the latest versions of Interface Components whenever possible. See the latest version's page for information about what's been changed.

Multiple Dropdown

Function: a!multipleDropdownField_20r2()

Displays a long list of choices from which the user may select none, one, or many items and saves values based on the selected choices. To save the index instead of a value, use multiple dropdown by index.

If the choice is exclusive, then consider using radio buttons or a dropdown component.

If there aren't many choices, consider using checkboxes.

Parameters

Name Keyword Types Description

Label

label

Text

Text to display as the field label.

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.

Placeholder

placeholder

Text

Text to display in the field when it is empty.

Choice Labels

choiceLabels

List of Text String

Array of options for the user to select.

Choice Values

choiceValues

List of Variant

Array of values associated with the available choices.

Display Value

value

List of Variant

Values of choices to display as selected.

Validations

validations

List of Text String

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

Save Input To

saveInto

List of Save

One or more variables that are updated with the choice values when the user changes the selections. 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 the documentation 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.

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.

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.

Notes

  • If you set Label Position to "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.
  • Choices display in the same order as defined in the Choice Labels parameter. The Choice Labels argument cannot be null.
  • If a single item is selected, the system saves a single-item array.
  • If no selection is made, the system saves a null value into the component's Save Selection To field. If a single item is selected, the system saves a single-item array.
  • Choice Labels and Choice Values must be the same length.
  • Choice Values cannot contain nulls or duplicate values.

Examples

Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.

Multiple Dropdown with the First Option Selected

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

=a!localVariables(
  local!language: "en_US",
  a!multipleDropdownField_20r2(
    label: "Language",
    instructions: "In which languages are you proficient?",
    choiceLabels: {
      "English",
      "Spanish",
      "French",
      "German"
    },
    choiceValues: {
      "en_US",
      "es_ES",
      "fr_FR",
      "de_DE"
    },
    value: local!language,
    saveInto: local!language
  )
)

Displays the following:

Open in Github Built: Wed, Aug 17, 2022 (01:05:05 PM)

On This Page

FEEDBACK