Password
An input field to enter a password.
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.
autoFill
The password type for browsers to autofill.
Type | string | ||||||||
Format | Plain Text | ||||||||
Configurability | Inspector | ||||||||
Allowed Values |
| ||||||||
Default | current-password |
Examples
"current-password"
customValidation
A custom validation rule using {{ }}
expression with conditional logic. An invalid match evaluates to a string which is used as the validation message. An empty or nullish value is considered valid.
Type | string |
Format | Plain Text |
Configurability | Inspector > Interaction > Validation rules > Custom rule |
Default | null |
Examples
"{{ value.length > 5 ? 'Value must be longer than 5 characters' : '' }}"
disabled
Whether input, interaction, selection, or triggering is disabled.
Type | boolean |
Format | True/False |
Configurability | Inspector > Interaction > Disabled |
Default | false |
Examples
true
enforceMaxLength
Whether to enforce the maximum length.
Type | boolean |
Format | True/False |
Configurability | Inspector > Interaction > Advanced > Enforce max length |
Default | false |
Examples
true
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 |
formDataKey
The key used by a Form component to assign default values to input fields using form.initialData
, and to construct the form.data
property.
Type | string |
Format | Plain Text |
Configurability | Inspector > Interaction > Form data key |
Default | {{ self.id }} |
Examples
table1.selectedRow.id
hidden
Whether this object is hidden from view.
Type | boolean |
Format | True/False |
Configurability | Inspector > Appearance > Hidden |
Default | false |
Examples
true
hideValidationMessage
Whether to hide the validation message if the invalid
is true
.
Type | boolean |
Configurability | Inspector > Appearance > Advanced > Hide validation message |
Default | null |
iconAfter
The suffix icon to display.
Type | string |
Format | Icon Key |
Configurability | Inspector > Content > Add-ons > Suffix icon |
Default | null |
Examples
/icon:bold/shopping-gift
iconBefore
The prefix icon to display.
Type | string |
Format | Icon Key |
Configurability | Inspector > Content > Add-ons > Prefix icon |
Default | null |
Examples
/icon:bold/shopping-gift
id
The unique identifier (name).
Type | string |
Format | Plain Text |
Configurability | Inspector |
Default | password1 |
Examples
query1
button1
inputTooltip
The tooltip helper text to display below the input on focus.
Type | string |
Format | Plain Text |
Configurability | Inspector > Content > Add-ons > Helper text |
Default | `Shift+Enter` to save, `Esc` to cancel |
Examples
`Shift+Enter` to save, `Esc` to cancel
invalid
Whether the value has failed any validation rules.
Type | boolean |
Configurability | Read-only |
Default | null |
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
label
The text label to display.
Type | string |
Format | Plain Text |
Configurability | Inspector > Content > Add-ons > Label > Label |
Default | null |
Examples
"Label"
loading
Whether to display a loading indicator.
Type | boolean |
Format | True/False |
Configurability | Inspector > Interaction > Loading |
Default | false |
Examples
true
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 |
| |||||||||
Default | 4px 8px |
Examples
4px 8px
maxLength
The maximum number of characters to allow.
Type | number |
Format | Integer |
Configurability | Inspector > Interaction > Validation rules > Max length |
Default | null |
Examples
100
minLength
The minimum number of characters to allow.
Type | number |
Format | Integer |
Configurability | Inspector > Interaction > Validation rules > Min length |
Default | null |
Examples
20
pattern
A regular expression (regex), without forward slashes around the pattern, to validate input if patternType
is regex
.
Type | string |
Format | Regular Expression |
Configurability | Inspector > Interaction > Validation rules > Regex |
Default | null |
Examples
^[a-zA-Z0-9]+$
patternType
The pattern with which to validate the input.
Type | string | ||||||||
Format | Plain Text | ||||||||
Configurability | Inspector | ||||||||
Allowed Values |
| ||||||||
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
Enter a value
readOnly
Whether user input is read-only.
Type | boolean |
Format | True/False |
Configurability | Inspector > Interaction > Advanced > Read only |
Default | false |
Examples
true
required
Whether a value is required to be selected.
Type | boolean |
Format | True/False |
Configurability | Inspector > Interaction > Validation rules > Required |
Default | false |
Examples
true