Skip to main content

The File Input component for Retool Mobile

An input field to select single or multiple files.

Demo

Settings​

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

File typesCustom ruleDisabledEvent handlersForm data keyHide 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.

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

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. Refer to the events section for a list of supported events.

method​

enum

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

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.

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

global​

boolean

Whether the object is globally scoped for use in all app pages.

​

boolean

Whether the component is visible.

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.

Whether the component is visible in the desktop layout.

Whether the component is visible in the mobile layout.

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

label​

string

The text label to display.

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

The amount of margin to render outside.

Values
4px 8px

Normal margin.

0

No margin.

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

pluginType​

string

The plugin type.

Whether a value is required.

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

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.

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

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

​

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.