The Signature component for Retool Apps

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

true

`emptyMessage`

The message to display if no value is set.

Type	string
Configurability	Inspector > Appearance > Empty state
Default	`null`

`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

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

Default null

`id`

The unique identifier (name).

Type	string
Format	Plain Text
Configurability	Inspector
Default	`signature1`

Examples

query1

button1

`isHiddenOnDesktop`

Whether to show or hide this object in the desktop layout.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Show on desktop
Default	`false`

Examples

true

`isHiddenOnMobile`

Whether to show or hide this object in the mobile layout.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Show on mobile
Default	`true`

Examples

true

`labelPosition`

The position of the label relative to the input field or value.

Type string

Format Plain Text

Configurability Inspector > Content > Add-ons > Label > Position

Allowed Values

Value	UI Option	Description
`top`	Top	Above the input field or value.
`left`	Left	Left of the input field or value.

Default left

Examples

top

`maintainSpaceWhenHidden`

Whether to take up space on the canvas if hidden is true.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Maintain space when hidden
Default	`false`

Examples

true

`margin`

The amount of margin to render outside.

Type string

Format Plain Text

Configurability

Inspector > Spacing > Margin

Allowed Values

Value	UI Option	Description
`4px 8px`	Normal	Normal margin.
`0`	None	No margin.

Default 4px 8px

Examples

4px 8px

`required`

Whether a value is required to be selected.

Type	boolean
Format	True/False
Configurability	Inspector > Interaction > Validation rules > Required
Default	`false`

Examples

true

`showInEditor`

Whether the component remains visible in the editor if hidden is true.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Always show in edit mode
Default	`false`

Examples

true

`showRedrawIcon`

Whether to display the Clear signature button.

Type	boolean
Configurability	Inspector
Default	`null`

`style`

Custom style options.

Type	object
Configurability	Inspector > Appearance > style
Default	`null`

`tooltipText`

The tooltip text to display next to the label on hover.

Type	string
Format	Markdown
Configurability	Inspector > Content > Add-ons > Helper text
Default	`null`

Examples

Submit

`value`

The current value.

Type	string
Configurability	Read-only
Default	`null`

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.clearValidation()`

Clear the validation message from the input field.

Definition
signature.clearValidation()

Examples

Clear the validation message from signature.

signature.clearValidation();

`signature.focus()`

Set focus on the input field.

Definition
signature.focus()

Examples

Set focus on signature.

signature.focus();

`signature.resetValue()`

Reset the current value to the default value.

Definition
signature.resetValue()

Examples

Reset the current value of signature.

signature.resetValue();

`signature.scrollIntoView()`

Scrolls the canvas or parent container so that the selected component appears in the visible area.

Definition
signature.scrollIntoView(options)

Parameters

`options`

The scroll options.

Type

object

Object Properties

`behavior`

The scroll behavior.

Type string

Allowed Values

Value	Description
`auto`	Scroll immediately to the specified position.
`smooth`	Scroll gradually to the specified position.

`block`

The scroll position relative to the component.

Type string

Allowed Values

Value	Description
`nearest`	Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view.
`start`	Scrolls to position the component at the top of the visible area.
`center`	Scrolls to position the component in the middle of the visible area.
`end`	Scrolls to position the component at the bottom of the visible area.

Examples

Scroll the minimum amount to immediately bring signature into view.

signature.scrollIntoView({behavior: 'auto', block: 'nearest'});

`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);

`signature.validate()`

Validates the value of the input field.

Definition
signature.validate()

Examples

Validate the value of signature.

signature.validate();

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
Change	The value is changed.

Properties​

disabled​

emptyMessage​

events​

event​

method​

type​

id​

isHiddenOnDesktop​

isHiddenOnMobile​

labelPosition​

maintainSpaceWhenHidden​

margin​

required​

showInEditor​

showRedrawIcon​

style​

tooltipText​

value​

Methods​

signature.clearValidation()​

signature.focus()​

signature.resetValue()​

signature.scrollIntoView()​

options​

behavior​

block​

signature.setDisabled()​

disabled​

signature.setHidden()​

hidden​

signature.validate()​

Events​

Properties

`disabled`

`emptyMessage`

`events`

`event`

`method`

`type`

`id`

`isHiddenOnDesktop`

`isHiddenOnMobile`

`labelPosition`

`maintainSpaceWhenHidden`

`margin`

`required`

`showInEditor`

`showRedrawIcon`

`style`

`tooltipText`

`value`

Methods

`signature.clearValidation()`

`signature.focus()`

`signature.resetValue()`

`signature.scrollIntoView()`

`options`

`behavior`

`block`

`signature.setDisabled()`

`disabled`

`signature.setHidden()`

`hidden`

`signature.validate()`

Events