The Signature mobile component
An input field to digitally capture a signature as an image.
Settings
Signature includes the following configurable options when building apps in the IDE.
| Content | InstructionsLabelCaptionPlaceholderValue |
| Interaction | DisabledEvent handlers |
| Appearance | Show on desktopShow on mobileMaintain space when hiddenMarginAlways show in edit modeStyles |
Properties
All properties for Signature with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
Properties
event
The event type.
Values
0
A user changes the value.
1
A user clicks or taps the component.
2
A user submits the value.
3
A user selects the input field.
4
A user deselects the input field.
5
A user scans a barcode.
6
A user opens the component.
7
A user closes the component.
8
A user sets the value to true.
9
A user sets the value to false.
10
A user selects a value.
11
A user clears the value.
12
A user uploads a file.
13
An uploaded file is parsed.
14
A user changes the value of the input field.
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 |
false | A user sets the value to |
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
The JavaScript method to perform when type is datasource, widget, state, or localStorage.
Values
0
Control query.
1
Control component.
2
Run script.
3
Set variable.
4
Set localStorage.
5
Perform utility action (e.g., Open URL or Confetti).
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). |
id
The name.
instructions
Additional text to display.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
labelCaption
The additional text to display with the label.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden is true.
placeholder
The text to display within the input field when there is no value.
pluginType
The plugin type.
showInEditor
Whether to remain visible in the editor if hidden is true.
Methods
JavaScript API methods for interacting with Signature. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
clear
Clear all values. The initial value must be an empty object (e.g., { }). Returns a void Promise when the method resolves.
signature.clear()
clearValue
Clear the current values.
signature.clearValue()
open
Open the component.
signature.open()
resetValue
Reset the current value to the default value.
signature.resetValue()
setDisabled
Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.
setHidden
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
signature.setHidden(hidden)
Parameters
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.
capture
A user inputs a value.