Skip to main content

Password Input

Rocket 2.0

The Password Input component is a text field that hides what the user types, for entering a password, an API key or another secret. It can show a meter that rates how strong the password is.

Properties​

Property
Description
Expected Value
LabelText shown above the field.Text. Default: Password
Help textHint text shown under the field.Text
PlaceholderText shown in the field when it is empty.Text. Default: Enter password
Default valueText in the field when the app loads.Text
Show/hide buttonShows an eye button in the field that reveals or hides the password.On or off. Default: On
Strength meterShows a meter under the field that rates the password as Weak, Fair or Strong, based on its length and mix of lowercase, uppercase, digits and symbols.On or off. Default: Off

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off
Dynamic heightLets the component grow with its content in the running app instead of keeping a fixed height.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Events​

Add a handler from the Events section of the properties panel. See Event Triggers for the steps.

Event
Description
On changeTriggers when the text in the field changes.
On enter pressedTriggers when the user presses Enter in the field.
On focusTriggers when the field gets focus.
On blurTriggers when the field loses focus.

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
Set textSets the field to the given Value.components.passwordinput1.setText("")
ClearEmpties the field.components.passwordinput1.clear()
Set focusMoves keyboard focus to the field.components.passwordinput1.setFocus()
Set blurRemoves focus from the field.components.passwordinput1.setBlur()
Set visibilityShows the component when true, hides it when false.components.passwordinput1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.passwordinput1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.passwordinput1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
labelText shown above the field.{{components.passwordinput1.label}}
descriptionHint text shown under the field.{{components.passwordinput1.description}}
placeholderText shown in the field when it is empty.{{components.passwordinput1.placeholder}}
defaultValueText in the field when the app loads.{{components.passwordinput1.defaultValue}}
showToggleShows an eye button in the field that reveals or hides the password.{{components.passwordinput1.showToggle}}
showStrengthShows a meter under the field that rates the password as Weak, Fair or Strong, based on its length and mix of lowercase, uppercase, digits and symbols.{{components.passwordinput1.showStrength}}
valueThe text in the field.{{components.passwordinput1.value}}
strengthHow strong the password is: weak, fair or strong, or empty when the field is empty.{{components.passwordinput1.strength}}
isVisibleWhether the component is visible.{{components.passwordinput1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.passwordinput1.isLoading}}
isDisabledWhether the component is disabled.{{components.passwordinput1.isDisabled}}

Styles​

Style
Default
Label colorTheme: Primary text
Help text colorTheme: Placeholder text
Field backgroundTheme: Surface 1
Field text colorTheme: Primary text
Placeholder colorTheme: Placeholder text
Field border colorTheme: Default border
Accent (focus ring, selection)Theme: Brand primary
Error color (message and border)Theme: Error
Field radius—
Eye icon colorTheme: Placeholder text
Strength color: weakTheme: Error
Strength color: fairTheme: Warning
Strength color: strongTheme: Success
Strength meter track colorTheme: Surface 3
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.