Password

An input field to enter a password.

Version: Cloud and 3.185 Edge

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
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description current-password Current password. new-password New password. one-time-code One-time code.
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
Mutability	Control Usage Retool UI Inspector > Interaction > Validation rules > Custom rule

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	Control Usage Retool UI Inspector > Interaction > Disabled Method setDisabled()
Default	false

Examples

true

---

enforceMaxLength

Whether to enforce the maximum length.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Advanced > Enforce max length
Default	false

Examples

true

---

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	Control Usage Retool UI 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
Mutability	Control Usage Retool UI Inspector > Appearance > Hidden Method setHidden()
Default	false

Examples

true

---

hideValidationMessage

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

Type	boolean
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Hide validation message

---

iconAfter

The suffix icon to display.

Type	string
Format	Icon Key
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Suffix icon
Default	null

Examples

/icon:bold/shopping-gift

---

iconBefore

The prefix icon to display.

Type	string
Format	Icon Key
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Prefix icon
Default	null

Examples

/icon:bold/shopping-gift

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector
Default	password1

Examples

query1

button1

---

inputTooltip

The tooltip helper text to display below the input on focus.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI 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
Mutability	Read-only

---

isHiddenOnDesktop

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

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI 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
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Show on mobile
Default	true

Examples

true

---

label

The text label to display.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Label > Label
Default	null

Examples

"Label"

---

loading

Whether to display a loading indicator.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI 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
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Maintain space when hidden
Default	false

Examples

true

---

margin

The amount of margin to render outside.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Spacing > Margin
Allowed Values	Value UI Option Description 4px 8px Normal Normal margin. 0 None No margin.
Default	4px 8px

Examples

4px 8px

---

maxLength

The maximum number of characters to allow.

Type	number
Format	Integer
Mutability	Control Usage Retool UI Inspector > Interaction > Validation rules > Max length
Default	null

Examples

100

---

minLength

The minimum number of characters to allow.

Type	number
Format	Integer
Mutability	Control Usage Retool UI 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
Mutability	Control Usage Retool UI 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
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description email Email address. regex Regular expression statement. url URL.
Default	null

---

placeholder

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

Type	string
Format	string
Mutability	Control Usage Retool UI Inspector > Content > Placeholder
Default	Enter a value

Examples

Enter a value

---

readOnly

Whether user input is read-only.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Advanced > Read only
Default	false

Examples

true

---

required

Whether a value is required to be selected.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Validation rules > Required
Default	false

Examples

true

---

showCharacterCount

Whether to display a character count with the input field.

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

showClear

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

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Show clear button
Default	false

Examples

true

---

showInEditor

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

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Always show in edit mode
Default	false

Examples

true

---

spellCheck

Whether the browser can perform spellcheck on the input field.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Advanced > Enable spell check
Default	false

Examples

true

---

style

Custom style options.

Type	object
Mutability	Control Usage Retool UI Inspector > Appearance > style

---

textAfter

The suffix text to display.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Suffix text
Default	null

Examples

USD

px

@example.com

---

textBefore

The prefix text to display.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Prefix text
Default	null

Examples

$

Email address

SKU

---

tooltipText

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

Type	string
Format	Markdown
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Helper text
Default	null

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	Control Usage Retool UI Inspector > Content > Default value Method setValue()
Default	null

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

Event	Description
Blur	The input field is deselected.
Change	The value is changed.
Focus	The input field is selected.
Submit	The value is submitted.