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.

Read-only

readOnly

Boolean

Determines if the field should display as not editable. Default: false.

Disabled

disabled

Boolean

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

Maximum Selections

maxSelections

Number (Integer)

Maximum number of allowed selections. Once this number is reached, further selections are blocked until a selection is removed.

Suggestion Function

suggestFunction

Any Type

A reference to a rule or function that populates the suggestion pane. The rule or function must take a single Text parameter and must return a DataSubset, created via a!dataSubset() or a plugin function, where "data" contains the labels to display and "identifiers" contains the values to save.

Selected Labels

selectedLabels

List of Text String

Array of text display labels for the currently selected items.

Selection Tooltips

selectedTooltips

List of Text String

Array of text tooltips for the currently selected items.

Display Value

value

Any Type

Array of selected identifiers.

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 array of selected identifiers when the user adds or removes an item. Use a!save() to save a modified or alternative value to a variable.

Validation Group

validationGroup

Text

When present, the requiredness of the field is only evaluated when a button in the same validation group is pressed. The value for this parameter cannot contain spaces. For example, “validation group” is not a valid value. You need to add an underscore between words: “validation_group”. See the following recipes for more information:

• Configure Buttons with Conditional Requiredness
• Validation Groups for Buttons with Multiple Validation Rules'

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.

Placeholder

placeholder

Text

Text to display in the field when it is empty. Does not show if the field is read only.

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

Selected Links

selectedLinks

List of Variant

Array of links to apply to the selected tokens. Create links with a!authorizationLink(), a!documentDownloadLink(), a!dynamicLink(), a!newsEntryLink(), a!processTaskLink(), a!recordLink(), a!reportLink(), a!safeLink(), a!startProcessLink(), a!submitLink(), or a!userRecordLink().

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.