The File Button component for Retool Apps

A button to select single or multiple files.

Refer to the File inputs guide for more information on how to use this component.

Demo

Settings

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

File typesAppend newly selected filesCustom ruleDisabledEvent handlersForm data keyHiddenHide validation messageSuffix iconPrefix iconShow on desktopShow on mobileMake file public on uploadLoadingMaintain space when hiddenMarginMax itemsMax sizeMin itemsMax sizeParse filesRequiredSelection typeReplace file with same nameAlways show in edit modeStylesVariantTextHelper textUpload file to Retool StorageValue

Properties

All properties for File Button 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.

---

appendNewSelection

boolean

Whether to append additional files to the value.

---

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).

---

---

files

Deprecated

object[]

A list of metadata from the selected files. Includes name, type, size, and lastModified.

---

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.

---

global

boolean

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

---

hidden

boolean

Whether the component is visible.

---

hideValidationMessage

boolean

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

---

iconAfter

enum

The suffix icon to display.

Values

You can select an icon or dynamically set one with a valid icon key.

Demo

---

iconBefore

enum

The prefix icon to display.

Values

You can select an icon or dynamically set one with a valid icon key.

Demo

---

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.

---

loaderPosition

The position of the loading indicator if loading is true.

---

loading

boolean

Whether to display a loading indicator.

---

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.

---

maxCount

number

The maximum number of items to allow.

---

maxSize

number

The maximum file size allowed.

---

minCount

number

The minimum number of items to allow.

---

minSize

number

The minimum file size allowed.

---

parsedValue

The parsed value of the input.

---

parseFiles

boolean

Whether to parse plain-text content.

---

parsing

boolean

Whether content is being parsed.

---

pluginType

string

The plugin type.

---

required

boolean

Whether a value is required.

---

selectionType

enum

The type of file selection.

Values

single	Select a single file.
multiple	Select multiple files.
directory	Select a directory of files.

---

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.

---

styleVariant

enum

The button variant to use.

Values

solid	Solid background color.
outline	Button outline only.

---

text

string

The primary text content.

---

tooltipText

string

The tooltip text to display.

---

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 Button. 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.

fileButton.clearValidation()

---

clearValue

Clear the current values.

fileButton.clearValue()

---

focus

Set focus on the input field.

fileButton.focus()

---

resetValue

Reset the current value to the default value.

fileButton.resetValue()

---

scrollIntoView

Scrolls the canvas or parent container so that the selected component appears in the visible area.

fileButton.scrollIntoView(scrollIntoViewOptions)

Parameters

scrollIntoViewOptions

object

The scroll options.

Properties

behavior

enum

The scroll behavior.

Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

---

block

enum

The scroll position relative to the component.

Values

nearest	Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view.
start	Scrolls to position the component at the top of the visible area.
center	Scrolls to position the component in the middle of the visible area.
end	Scrolls to position the component at the bottom of the visible area.

---

---

---

setDisabled

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

fileButton.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.

fileButton.setHidden(hidden)

Parameters

hidden

boolean

Whether the component is visible.

---

---

validate

Validates the value of the input field.

fileButton.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.

---

parse

Data is parsed.

---