Skip to main content
Applies to: Self-hosted 3.196 Stable

Password

An input field to enter a password.

Demo

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
ValueDescription
current-password

Current password.

new-password

New password.

one-time-code

One-time code.

Defaultcurrent-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
Defaultnull
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
Defaultfalse
Examples
true

enforceMaxLength​

Whether to enforce the maximum length.

Type boolean
Format True/False
Configurability Inspector > Interaction > Advanced > Enforce max length
Defaultfalse
Examples
true

events​

A list of configured event handlers that trigger actions or queries.

Type array
Array values object
Configurability Inspector > Interaction > Event handlers
Defaultnull
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
Defaultnull

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
Defaultnull

type​

The type of action to perform.

Type string
Configurability Inspector > Interaction > Event handlers > Edit event handler > Action
Allowed Values
ValueDescription
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).

Defaultnull

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
Defaultfalse
Examples
true

hideValidationMessage​

Whether to hide the validation message if the invalid is true.

Type boolean
Configurability Inspector > Appearance > Advanced > Hide validation message
Defaultnull

iconAfter​

The suffix icon to display.

Type string
Format Icon Key
Configurability Inspector > Content > Add-ons > Suffix icon
Defaultnull
Examples
/icon:bold/shopping-gift

iconBefore​

The prefix icon to display.

Type string
Format Icon Key
Configurability Inspector > Content > Add-ons > Prefix icon
Defaultnull
Examples
/icon:bold/shopping-gift

id​

The unique identifier (name).

Type string
Format Plain Text
Configurability Inspector
Defaultpassword1
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
Defaultnull

isHiddenOnDesktop​

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

Type boolean
Format True/False
Configurability Inspector > Appearance > Advanced > Show on desktop
Defaultfalse
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
Defaulttrue
Examples
true

label​

The text label to display.

Type string
Format Plain Text
Configurability Inspector > Content > Add-ons > Label > Label
Defaultnull
Examples
"Label"

loading​

Whether to display a loading indicator.

Type boolean
Format True/False
Configurability Inspector > Interaction > Loading
Defaultfalse
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
Defaultfalse
Examples
true

margin​

The amount of margin to render outside.

Type string
Format Plain Text
Configurability Inspector > Spacing > Margin
Allowed Values
ValueUI OptionDescription
4px 8pxNormal

Normal margin.

0None

No margin.

Default4px 8px
Examples
4px 8px

maxLength​

The maximum number of characters to allow.

Type number
Format Integer
Configurability Inspector > Interaction > Validation rules > Max length
Defaultnull
Examples
100

minLength​

The minimum number of characters to allow.

Type number
Format Integer
Configurability Inspector > Interaction > Validation rules > Min length
Defaultnull
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
Defaultnull
Examples
^[a-zA-Z0-9]+$

patternType​

The pattern with which to validate the input.

Type string
Format Plain Text
Configurability Inspector
Allowed Values
ValueDescription
email

Email address.

regex

Regular expression statement.

url

URL.

Defaultnull

placeholder​

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

Type string
Formatstring
Configurability Inspector > Content > Placeholder
DefaultEnter a value
Examples
Enter a value

readOnly​

Whether user input is read-only.

Type boolean
Format True/False
Configurability Inspector > Interaction > Advanced > Read only
Defaultfalse
Examples
true

required​

Whether a value is required to be selected.

Type boolean
Format True/False
Configurability Inspector > Interaction > Validation rules > Required
Defaultfalse
Examples
true

showCharacterCount​

Whether to display a character count with the input field.

Type boolean
Configurability Inspector
Defaultnull

showClear​

Whether to display a button to clear the value of the input field.

Type boolean
Format True/False
Configurability Inspector > Appearance > Show clear button
Defaultfalse
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
Defaultfalse
Examples
true

spellCheck​

Whether the browser can perform spellcheck on the input field.

Type boolean
Format True/False
Configurability Inspector > Interaction > Advanced > Enable spell check
Defaultfalse
Examples
true

style​

Custom style options.

Type object
Configurability Inspector > Appearance > style
Defaultnull

textAfter​

The suffix text to display.

Type string
Format Plain Text
Configurability Inspector > Content > Add-ons > Suffix text
Defaultnull
Examples
USD
px
@example.com

textBefore​

The prefix text to display.

Type string
Format Plain Text
Configurability Inspector > Content > Add-ons > Prefix text
Defaultnull
Examples
$
Email address
SKU

tooltipText​

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

Type string
Format Markdown
Configurability Inspector > Content > Add-ons > Helper text
Defaultnull
Examples
Submit

validationMessage​

The validation message to display if invalid is true.

Type string
Format Plain Text
Configurability Read-only
Defaultnull

value​

The current or default value.

Type string
Format Plain Text
Configurability Inspector > Content > Default value
Defaultnull
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()​

Remove focus from the input field.

Definition
password.blur()
Examples

Remove focus from password.

password.blur();

password.clearValidation()​

Clear the validation message from the input field.

Definition
password.clearValidation()
Examples

Clear the validation message from password.

password.clearValidation();

password.clearValue()​

Clear the current values.

Definition
password.clearValue()
Examples

Clear the current value of password.

password.clearValue();

password.focus()​

Set focus on the input field.

Definition
password.focus()
Examples

Set focus on password.

password.focus();

password.resetValue()​

Reset the current value to the default value.

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

Definition
password.scrollIntoView(options)
Parameters

options​

The scroll options.

Type object
Object Properties

behavior​

The scroll behavior.

Type string
Allowed Values
ValueDescription
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
ValueDescription
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 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.

Definition
password.setDisabled(disabled)
Parameters

disabled​

Whether input, interaction, selection, or triggering is disabled.

Type boolean
Format True/False
Default
false
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.

Definition
password.setHidden(hidden)
Parameters

hidden​

Whether this object is hidden from view.

Type boolean
Format True/False
Default
false
Examples
true
Examples

Hide password.

password.setHidden(true);

Unhide password.

password.setHidden(false);

password.setValue()​

Set the current value.

Definition
password.setValue(value)
Parameters

value​

(No description available)

Type unknown
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.

EventDescription
BlurThe input field is deselected.
ChangeThe value is changed.
FocusThe input field is selected.
SubmitThe value is submitted.