Skip to main content
Version: 3.0.0-LTS

File Picker

File Picker component allows the user to drag and drop files or upload files by browsing the filesystem and selecting one or more files in a directory.

info

File types must be a valid MIME type according to input element specification or a valid file extension.

To accept any/all file type(s), set Accept file types to an empty value.

tip

MIME type determination is not reliable across platforms. CSV files, for example, are reported as text/plain under macOS but as application/vnd.ms-excel under Windows.

Properties

Property
Description
Instruction textInstruction text can be set to give information on the file picker.
Use drop zoneCreates a drag & drop zone. Files can be dragged and dropped to the "drag & drop" zone.
Use file pickerOn clicking it invokes the default OS file prompt.
Pick multiple filesAllows drag and drop (or selection from the file dialog) of multiple files. Pick multiple files is disabled by default.
Max file countThe maximum accepted number of files The default value is 2.
Accept file typesBy providing types, you can make the dropzone accept specific file types and reject the others. Example: {{"image/*,application/pdf,application/msword"}}.
Max size limitMaximum file size (in bytes).
Min size limitMinimum file size (in bytes).
tip

Files can be accepted or rejected based on the file types, maximum file count, maximum file size (in bytes) and minimum file size (in bytes). If Pick multiple files is set to false and additional files are dropped, all files besides the first will be rejected. Any file that does not have a size in the range of Max size limit and Min size limit will be rejected.

Events

Event
Description
On file selectedTriggers whenever one or more files are selected by the selector dialogue box.
On file loadedTriggers whenever a file is loaded in the browser.
On file deselectedTriggers whenever one or more files are removed from the picker.
info

Checkout this guide to learn how to refer or display images/PDFs using base64 string.

Component Specific Actions (CSA)

ActionsDescriptionHow To Access
clearFiles()
Clears the selected files from the file picker component.Employ a RunJS query (for e.g., await components.filepicker1.clearFiles()) or trigger it using an event.

Exposed Variables

Variables
Description
How To Access
fileHolds an array of file objects loaded in the file picker, each with properties: name, type, content, dataURL, base64Data, parsedData, filePath.Accessible dynamically with JS (for e.g., {{components.filepicker1.file[0].base64Data}}).

Options

Option
Description
Parse contentParse the selected files, supports CSV, xls, and xlsx files.
File typeIf Parse content is enabled, options to auto-detect files and parse content or parse selected file types.
info
  • If Parse content option is toggled off, File Type option will not be available.
  • If the Parse content option is toggled on, it only parses the next file that is selected, not the already selected one.

General

Tooltip

A Tooltip is often used to specify extra information about something when the user hovers the mouse pointer over the component.

Under the General accordion, you can set the value in the string format. Now hovering over the component will display the string as the tooltip.

Devices

Property
Description
Expected Value
Show on desktopMakes the component visible in desktop view.You can set it with the toggle button or dynamically configure the value by clicking on fx and entering a logical expression.
Show on mobileMakes the component visible in mobile view.You can set it with the toggle button or dynamically configure the value by clicking on fx and entering a logical expression.

Styles

Style
Description
Default Value
VisibilityThis is to control the visibility of the component. If {{false}} the component will not visible after the app is deployed. It can only have boolean values i.e. either {{true}} or {{false}}.By default, it's set to {{true}}.
DisableThis property only accepts boolean values. If set to {{true}}, the component will be locked and becomes non-functional.By default, its value is set to {{false}}.
Border radiusUse this property to modify the border radius of the File Picker component. The field expects only numerical value from 1 to 100.By default, its value is set to 0.
info

Any property having fx button next to its field can be programmatically configured.