The Image Input component for Retool Mobile

An input field to select images or take a photo with the camera.

Version: Cloud and 3.234 Edge

Captured images are temporarily stored on the device for native apps and in the Retool organization for web apps.

Demo

Properties

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

cameraOpened

Whether the camera was in use.

Type	boolean
Configurability	Read-only

---

disabled

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

Type	boolean
Format	True/False
Configurability	Inspector > Interaction > Disabled
Default	false

Examples

true

---

events

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

Type	array
Array values	object
Configurability	Inspector > Interaction > Event handlers

Array Object Properties

event

The event that triggers the action. Refer to the events section for details of available events for this object.

Type	string
Configurability	Inspector > Interaction > Event handlers > Event

---

method

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

Type	string
Configurability	Inspector > Interaction > Event handlers > Edit event handler > Run script actions

---

type

The type of action to perform.

Type	string
Configurability	Inspector > Interaction > Event handlers > Edit event handler > Action
Allowed Values	Value Description 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

A list of metadata from the selected files.

Type	array
Array values	object
Configurability	Read-only

Array Object Properties

lastModified

The last modified date as a timestamp.

Type	number
Format	Timestamp
Configurability	Read-only

Examples

1617024000000

---

name

The file name with extension.

Type	string
Configurability	Read-only

---

retoolStorageId

The file ID if uploaded to Retool Storage.

Type	string
Configurability	Read-only

---

size

The file size, in bytes.

Type	string
Configurability	Read-only

---

type

The MIME type.

Type	string
Configurability	Read-only

---

uploading

Whether the file is uploading.

Type	boolean
Configurability	Read-only

---

---

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Hidden
Default	false

Examples

true

---

isPublic

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

Type	boolean
Configurability	Inspector

---

label

The text label to display.

Type	string
Format	Plain Text
Configurability	Inspector > Content > Add-ons > Label > Label
Default	null

Examples

"Label"

---

launchMode

The input method to use.

Type	string
Configurability	Inspector
Allowed Values	Value Description camera Take photos with the device camera or select photos to upload. cameraOnly Take photos with the device camera only. libraryOnly Select photos to upload only.

---

libraryOpened

Whether the library was in use.

Type	boolean
Configurability	Read-only

---

maxCount

The maximum number of items to allow.

Type	number
Configurability	Inspector

---

minCount

The minimum number of items to allow.

Type	number
Configurability	Inspector

---

placeholder

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

Type	string
Format	string
Configurability	Inspector > Content > Placeholder
Default	Enter a value

Examples

Enter a value

---

resolution

Whether to resize images to a different resolution.

Type	string
Configurability	Inspector
Allowed Values	Value Description original Images retain their original resolution. high High resolution. medium Medium resolution. low Low resolution.

---

selectionType

The type of file selection.

Type	string
Configurability	Inspector
Allowed Values	Value Description single Select a single file. multiple Select multiple files. directory Select a directory of files.

---

shouldCompress

Whether to compress images. If enabled, file size is reduced by 50% with minimal reduction in quality.

Type	boolean
Configurability	Inspector

---

shouldOverwriteOnNameCollision

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

Type	boolean
Configurability	Inspector

---

uploadToRetoolStorage

Whether to upload a file to Retool Storage.

Type	boolean
Configurability	Inspector

---

value

The value.

Type	array
Array values	string
Configurability	Read-only

---

Methods

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

imageInput.clearValue()

Clear the current values.

Definition

imageInput.clearValue()

Examples

Clear the current value of imageInput.

imageInput.clearValue();

---

imageInput.close()

Close the component.

Definition

imageInput.close()

Examples

Close imageInput.

imageInput.close();

---

imageInput.open()

Open the component.

Definition

imageInput.open()

Examples

Open imageInput.

imageInput.open();

---

imageInput.resetValue()

Reset the current value to the default value.

Definition

imageInput.resetValue()

Examples

Reset the current value of imageInput.

imageInput.resetValue();

---

imageInput.setDisabled()

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

Definition

imageInput.setDisabled(disabled)

Parameters

disabled

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

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Disable imageInput.

imageInput.setDisabled(true);

Enable imageInput.

imageInput.setDisabled(false);

---

Events

Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.

Event	Description
Capture	A value is captured.
Close	The component or item is closed.
Open	The component or item is opened.