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 | ||||||||
| Mutability |
| ||||||||
| Allowed Values |
| ||||||||
| Default | |
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 | ||||
| Mutability |
|
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 | ||||||
| Mutability |
| ||||||
| Default | |
Examples
true
enforceMaxLength
Whether to enforce the maximum length.
| Type | boolean | ||||
| Format | True/False | ||||
| Mutability |
| ||||
| Default | |
Examples
true
events
A list of configured event handlers that trigger actions or queries.
| Type | array | ||||
| Array values | object | ||||
| Mutability |
|
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 | ||||
| Mutability |
|
method
The JavaScript method to perform when type is datasource, widget, state, or localStorage.
| Type | string | ||||
| Mutability |
|
type
The type of action to perform.
| Type | string | ||||||||||||||
| Mutability |
| ||||||||||||||
| Allowed Values |
|
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 | ||||
| Mutability |
| ||||
| Default | |
Examples
table1.selectedRow.id
hidden
Whether this object is hidden from view.
| Type | boolean | ||||||
| Format | True/False | ||||||
| Mutability |
| ||||||
| Default | |
Examples
true
hideValidationMessage
Whether to hide the validation message if the invalid is true.
| Type | boolean | ||||
| Mutability |
|
iconAfter
The suffix icon to display.
| Type | string | ||||
| Format | Icon Key | ||||
| Mutability |
| ||||
| Default | |
Examples
/icon:bold/shopping-gift
iconBefore
The prefix icon to display.
| Type | string | ||||
| Format | Icon Key | ||||
| Mutability |
| ||||
| Default | |
Examples
/icon:bold/shopping-gift
id
The unique identifier (name).
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
| ||||
| Default | |
Examples
query1
button1
inputTooltip
The tooltip helper text to display below the input on focus.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
| ||||
| Default | |
Examples
`Shift+Enter` to save, `Esc` to cancel
isHiddenOnDesktop
Whether to show or hide this object in the desktop layout.
| Type | boolean | ||||
| Format | True/False | ||||
| Mutability |
| ||||
| Default | |
Examples
true
isHiddenOnMobile
Whether to show or hide this object in the mobile layout.
| Type | boolean | ||||
| Format | True/False | ||||
| Mutability |
| ||||
| Default | |
Examples
true
label
The text label to display.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
| ||||
| Default | |
Examples
"Label"
loading
Whether to display a loading indicator.
| Type | boolean | ||||
| Format | True/False | ||||
| Mutability |
| ||||
| Default | |
Examples
true
maintainSpaceWhenHidden
Whether to take up space on the canvas if hidden is true.
| Type | boolean | ||||
| Format | True/False | ||||
| Mutability |
| ||||
| Default | |
Examples
true
margin
The amount of margin to render outside.
| Type | string | |||||||||
| Format | Plain Text | |||||||||
| Mutability |
| |||||||||
| Allowed Values |
| |||||||||
| Default | |
Examples
4px 8px
maxLength
The maximum number of characters to allow.
| Type | number | ||||
| Format | Integer | ||||
| Mutability |
| ||||
| Default | |
Examples
100
minLength
The minimum number of characters to allow.
| Type | number | ||||
| Format | Integer | ||||
| Mutability |
| ||||
| Default | |
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 | ||||
| Mutability |
| ||||
| Default | |
Examples
^[a-zA-Z0-9]+$
patternType
The pattern with which to validate the input.
| Type | string | ||||||||
| Format | Plain Text | ||||||||
| Mutability |
| ||||||||
| Allowed Values |
| ||||||||
| Default | |
placeholder
The text to display within the input field when there is no value.
| Type | string | ||||
| Format | string | ||||
| Mutability |
| ||||
| Default | |
Examples
Enter a value
readOnly
Whether user input is read-only.
| Type | boolean | ||||
| Format | True/False | ||||
| Mutability |
| ||||
| Default | |
Examples
true
required
Whether a value is required to be selected.
| Type | boolean | ||||
| Format | True/False | ||||
| Mutability |
| ||||
| Default | |
Examples
true
showCharacterCount
Whether to display a character count with the input field.
| Type | boolean | ||||
| Mutability |
|
showClear
Whether to display a button to clear the value of the input field.
| Type | boolean | ||||
| Format | True/False | ||||
| Mutability |
| ||||
| Default | |
Examples
true
showInEditor
Whether the component remains visible in the editor if hidden is true.
| Type | boolean | ||||
| Format | True/False | ||||
| Mutability |
| ||||
| Default | |
Examples
true
spellCheck
Whether the browser can perform spellcheck on the input field.
| Type | boolean | ||||
| Format | True/False | ||||
| Mutability |
| ||||
| Default | |
Examples
true
style
Custom style options.
| Type | object | ||||
| Mutability |
|
textAfter
The suffix text to display.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
| ||||
| Default | |
Examples
USD
px
@example.com
textBefore
The prefix text to display.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
| ||||
| Default | |
Examples
$
Email address
SKU
tooltipText
The tooltip text to display next to the label on hover.
| Type | string | ||||
| Format | Markdown | ||||
| Mutability |
| ||||
| Default | |
Examples
Submit
validationMessage
The validation message to display if invalid is true.
| Type | string |
| Format | Plain Text |
| Mutability | Read-only |
value
The current or default value.
| Type | string | ||||||
| Format | Plain Text | ||||||
| Mutability |
| ||||||
| Default | |
Examples
Hello world!
Methods
JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
password.blur()
Examples
Remove focus from password.
password.blur();
password.clearValidation()
Examples
Clear the validation message from password.
password.clearValidation();
password.clearValue()
Examples
Clear the current value of password.
password.clearValue();
password.focus()
Examples
Set focus on password.
password.focus();
password.resetValue()
Examples
Reset the current value of password.
password.resetValue();
password.scrollIntoView()
Scrolls the canvas or parent container so that the selected component appears in the visible area.
password.scrollIntoView(options)
Parameters
Object Properties
behavior
The scroll behavior.
| Type | string | ||||||
| Allowed Values |
|
block
The scroll position relative to the component.
| Type | string | ||||||||||
| Allowed Values |
|
Examples
Scroll the minimum amount to immediately bring password into view.
password.scrollIntoView({behavior: 'auto', block: 'nearest'});
password.setDisabled()
Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.
password.setDisabled(disabled)
Parameters
disabled
Whether input, interaction, selection, or triggering is disabled.
| Type | boolean |
| Format | True/False |
| Default | |
Examples
true
Examples
Disable password.
password.setDisabled(true);
Enable password.
password.setDisabled(false);
password.setHidden()
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
password.setHidden(hidden)
Parameters
Examples
true
Examples
Hide password.
password.setHidden(true);
Unhide password.
password.setHidden(false);
password.setValue(value)
Examples
Set the current value of password to userValue.
password.setValue(userValue);
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 |
|---|---|
| Blur | The input field is deselected. |
| Change | The value is changed. |
| Focus | The input field is selected. |
| Submit | The value is submitted. |