Skip to main content

The Signature component for Retool Mobile

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

Demo

Settings​

Signature includes the following configurable options when building apps in the IDE.

DisabledEvent handlersInstructionsShow on desktopShow on mobileLabelLabelsMaintain space when hiddenMarginPlaceholderAlways show in edit modeStylesValue

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.

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. Refer to the events section for a list of supported events.

method​

enum

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

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

global​

boolean

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

​

boolean

Whether the component is visible.

id​

string

The unique identifier.

Additional text to display.

Whether the component is visible in the desktop layout.

Whether the component is visible in the mobile layout.

label​

string

The text label to display.

The label for the node.

Whether the component takes up space on the canvas if hidden is true.

The amount of margin to render outside.

Values
4px 8px

Normal margin.

0

No margin.

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

pluginType​

string

The plugin type.

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.

value​

string

The value.

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.

signature.setDisabled(disabled)
Parameters

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.

signature.setHidden(hidden)
Parameters

​

boolean

Whether the component is visible.

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 value is captured.