The File Input component for Retool Mobile

An input field to select single or multiple files.

Settings

File Input includes the following configurable options when building apps in the IDE.

File typesCustom ruleDisabledEvent handlersForm data keyHiddenHide validation messageShow on desktopShow on mobileMake file public on uploadLabelMaintain space when hiddenMarginPlaceholderRequiredReplace file with same nameAlways show in edit modeStylesUpload file to Retool StorageValue

Properties

All properties for File Input with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

accept

string[]

A list of file extensions or file-type specifiers to accept.

customValidation

string

The custom validation message to display if the invalid is true.

disabled

boolean

Whether input, interaction, selection, or triggering is disabled.

events

object[]

A list of configured event handlers that trigger actions or queries.

Properties

event

enum

The event type.

Values

change	A user changes the value.
click	A user clicks or taps the component.
submit	A user submits the value.
focus	A user selects the input field.
blur	A user deselects the input field.
scan	A user scans a barcode.
open	A user opens the component.
close	A user closes the component.
true	A user sets the value to true.
false	A user sets the value to false.
select	A user selects a value.
clear	A user clears the value.
upload	A user uploads a file.
parse	An uploaded file is parsed.
inputValueChange	A user changes the value of the input field.

method

enum

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

type

enum

The type of action to perform.

Values

datasource	Control query.
widget	Control component.
script	Run script.
state	Set variable.
localStorage	Set localStorage.
util	Perform utility action (e.g., Open URL or Confetti).

file

object

Details about the selected file.

Properties

lastModified

number

The last modified date as a UNIX timestamp.

name

string

The file name with extension.

retoolStorageId

string

The file ID if uploaded to Retool Storage.

size

string

The file size, in bytes.

type

string

The MIME type.

uploading

boolean

Whether the file is uploading.

formDataKey

string

The key used by a Form component to assign default values to input fields using form.initialData, and to construct the form.data property.

hidden

boolean

Whether the component is visible.

hideValidationMessage

boolean

Whether to hide the validation message if the invalid is true.

id

string

The unique identifier.

invalid

boolean

Whether the value has failed any validation rules.

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

isPublic

boolean

Whether to make the file public when uploading with Retool Storage.

label

string

The text label to display.

maintainSpaceWhenHidden

boolean

Whether the component takes up space on the canvas if hidden is true.

margin

enum

The amount of margin to render outside.

Values

4px 8px	Normal margin.
0	No margin.

placeholder

string

The text to display within the input field when there is no value.

pluginType

string

The plugin type.

required

boolean

Whether a value is required to be selected.

shouldOverwriteOnNameCollision

boolean

Whether to replace a file with the same name when uploading with Retool Storage.

showInEditor

boolean

Whether to remain visible in the editor if hidden is true.

style

object

Custom style options in use. Not all style options may be available for all components.

uploadToRetoolStorage

boolean

Whether to upload a file to Retool Storage.

validationMessage

string

The validation message to display if invalid is true.

value

object[]

A list of uploaded files.

Properties

base64Data

string

The base64 encoded data of the item.

sizeBytes

number

The size of the item in bytes.

type

string

The MIME type.

Methods

JavaScript API methods for interacting with File Input. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

clearValidation

Clear the validation message from the input field.

fileInput.clearValidation()

clearValue

Clear the current values.

fileInput.clearValue()

focus

Set focus on the input field.

fileInput.focus()

resetValue

Reset the current value to the default value.

fileInput.resetValue()

setDisabled

Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.

fileInput.setDisabled(disabled)

Parameters

disabled

boolean

Whether input, interaction, selection, or triggering is disabled.

setHidden

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

fileInput.setHidden(hidden)

Parameters

hidden

boolean

Whether the component is visible.

setValue

Set the current value.

fileInput.setValue(value)

Parameters

value

object[]

A list of uploaded files.

Properties

base64Data

string

The base64 encoded data of the item.

sizeBytes

number

The size of the item in bytes.

type

string

The MIME type.

validate

Validates the value of the input field.

fileInput.validate()

Events

Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.

change

The value is changed.