Document Picker Component

Document Picker

Function: a!pickerFieldDocuments()

Displays an autocompleting input for the selection of one or more documents.

Parameters

Name Keyword Type Description
Label label Text Optional text to display as the field label to the left of the picker.
Label Position labelPosition Text Optional text to determine where the label appears. Valid values include
  • "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 Optional text displayed below the picker.
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".
Placeholder placeholder Text Optional text to display in the field when it is empty. Does not show if the field is read only.
Max Selections maxSelections Integer Once this number of selections has been reached, further selections are blocked until a selection is removed.
Folder Filter folderFilter Folder When present, only documents which are inside this folder or its subfolders are suggested.
Selected Documents value Document Array Array of currently selected documents.
Save Selection To saveInto Save Array One or more variables that are updated with the array of selected documents when the user selects or removes a document. Use a!save() to save a modified or alternative value to a variable.
Required required Boolean Determines if a value is required to submit the form. Default is false.
Required Message requiredMessage Text Custom message to be displayed when the field's value is required and not provided.
Disabled disabled Boolean Determines if the user is prevented from changing the value. Default is false.
Validations validations Text Array Validation errors to be displayed below the field when the value is not null.
Validation Group validationGroup Text When present, this field is only validated when a button in the same validation group is clicked.
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>

  • Any nulls in the array passed to Selected Documents are not displayed.
  • The user viewing the picker must have access to view documents passed to the value. Only documents that the viewing user has permissions to see appear in the suggestions list. When Folder Filter is not null, the viewing user must have permission to view the filtering folder for any suggestions to be made.
  • The component always saves an array regardless of how many selections have been made.
  • Whether placeholder text clears on focus or input varies by device and browser. Placeholder text does not display on Microsoft Internet Explorer 9.
Open in Github

On This Page

FEEDBACK