Function: a!pickerFieldCustom()
Displays an autocompleting input for the selection of one or more items from an arbitrary data set.
See Also: DataSubset
Name | Keyword | Types | Description |
---|---|---|---|
Label |
|
Text |
Text to display as the field label. |
Instructions |
|
Text |
Supplemental text about this field. |
Required |
|
Boolean |
Determines if a value is required to submit the form. Default: false. |
Read-only |
|
Boolean |
Determines if the field should display as not editable. Default: false. |
Disabled |
|
Boolean |
Determines if the field should display as potentially editable but grayed out. Default: false. |
Max Selections |
|
Number (Integer) |
Maximum number of allowed selections. Once this number is reached, further selections are blocked until a selection is removed. |
Suggestion Function |
|
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 |
|
List of Text String |
Array of text display labels for the currently selected items. |
Selection Tooltips |
|
List of Text String |
Array of text tooltips for the currently selected items. |
Display Value |
|
Any Type |
Array of selected identifiers. |
Validations |
|
List of Text String |
Validation errors to display below the field when the value is not null. |
Save Input To |
|
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 |
|
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 |
|
Text |
Custom message to display when the field's value is required and not provided. |
Label Position |
|
Text |
Determines where the label appears. Valid values:
|
Placeholder |
|
Text |
Text to display in the field when it is empty. Does not show if the field is read only. |
Help Tooltip |
|
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 |
Selected Links |
|
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 |
|
Text |
Additional text to be announced by screen readers. Used only for accessibility; produces no visible change. |
Visibility |
|
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
The following patterns include usage of the Custom Picker Component.
Configure an Array Picker (Pickers): Allow users to choose from a long text array using an auto-completing picker.
Configure an Array Picker that Ignores Duplicates (Pickers): Allow users to choose from a long text array using an autocompleting picker and prevent any choice from being picked multiple times.
Configure an Array Picker with a Show All Option (Pickers): Allow users to choose from a long text array using an autocompleting picker, but also allow them to see the entire choice set using a dropdown.