Skip to main content

The Signature component for Retool Mobile

An input field to digitally capture a signature as an image.

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.

disabled

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

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Interaction > Disabled
MethodsetDisabled()
Default
false
Examples
true

hidden

Whether this object is hidden from view.

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Appearance > Hidden
MethodsetHidden()
Default
false
Examples
true

instructions

Additional text to display.

Type string
Mutability
ControlUsage
Retool UI Inspector

label

The text label to display.

Type string
Format Plain Text
Mutability
ControlUsage
Retool UI Inspector > Content > Add-ons > Label > Label
Default
null
Examples
"Label"

labelCaption

The additional text to display with the label.

Type string
Format Plain Text
Mutability
ControlUsage
Retool UI Inspector > Content > Add-ons > Label > Caption

placeholder

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

Type string
Formatstring
Mutability
ControlUsage
Retool UI Inspector > Content > Placeholder
Default
Enter a value
Examples
Enter a value

value

The value.

Type string
Format Blob or file URI
Mutability Read-only
Examples
blob:example.com/12345678-1234-5678-1234-567812345678
file://path/to/file

Retool recommends saving signatures with utils.getDataByObjectURL(), which converts blobs into a Base64-encoded string. For more information, refer to the Accept digital signatures guide.

Methods

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

signature.clear()

Clear all values.

Definition
signature.clear()
Examples

Clear the value of signature.

signature.clear();

signature.clearValue()

Clear the current values.

Definition
signature.clearValue()
Examples

Clear the current value of signature.

signature.clearValue();

signature.open()

Open the component.

Definition
signature.open()
Examples

Open signature.

signature.open();

signature.resetValue()

Reset the current value to the default value.

Definition
signature.resetValue()
Examples

Reset the current value of signature.

signature.resetValue();

signature.setDisabled()

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

Definition
signature.setDisabled(disabled)
Parameters

disabled

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

Type boolean
Format True/False
Default
false
Examples
true

Examples

Disable signature.

signature.setDisabled(true);

Enable signature.

signature.setDisabled(false);

signature.setHidden()

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

Definition
signature.setHidden(hidden)
Parameters

hidden

Whether this object is hidden from view.

Type boolean
Format True/False
Default
false
Examples
true

Examples

Hide signature.

signature.setHidden(true);

Unhide signature.

signature.setHidden(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.

EventDescription
CaptureA value is captured.