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 |
| Configurability | Inspector > Interaction > Disabled |
| Default | false |
Examples
falsetrue
events
A list of configured event handlers that trigger actions or queries.
| Type | array |
| Array values | object |
| Configurability | Inspector > Interaction > Event handlers |
| Default | null |
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 |
| Default | null |
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 |
| Default | null |
type
The type of action to perform.
| Type | string | ||||||||||||||
| Configurability | Inspector > Interaction > Event handlers > Edit event handler > Action | ||||||||||||||
| Allowed Values |
| ||||||||||||||
| Default | null |
hidden
Whether this object is hidden from view.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Hidden |
| Default | false |
Examples
falsetrue
label
The text label to display.
| Type | string |
| Format | Plain Text |
| Configurability | Inspector > Content > Add-ons > Label > Label |
| Default | null |
Examples
false"Label"
labelCaption
The additional text to display with the label.
| Type | string |
| Format | Plain Text |
| Configurability | Inspector > Content > Add-ons > Label > Caption |
| Default | null |
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
falseEnter a value
Examples
falseblob:example.com/12345678-1234-5678-1234-567812345678
falsefile://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()
Examples
Clear the value of signature.
signature.clear();
signature.clearValue()
Examples
Clear the current value of signature.
signature.clearValue();
signature.open()
Examples
Open signature.
signature.open();
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.
signature.setDisabled(disabled)
Parameters
disabled
Whether input, interaction, selection, or triggering is disabled.
| Type | boolean |
| Format | True/False |
| Default | |
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.
signature.setHidden(hidden)
Parameters
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.
| Event | Description |
|---|---|
| Capture | A value is captured. |