Skip to main content

Password

Ant Design

The Password component is Ant Design's password input. It hides what the user types, with an optional show and hide toggle and a strength meter.

Properties​

Property
Description
Expected Value
LabelText shown above the field, or beside it when Layout is horizontal.Text. Default: Password
ExtraHelp text shown under the field. A validation message replaces it while the value is not valid.Text
TooltipText shown from an info icon after the label.Text
LayoutWhere the label sits: vertical puts it above the field, horizontal puts it to the left.vertical, horizontal. Default: vertical
ValueThe password the field starts with.Text
PlaceholderHint text shown while the field is empty.Text. Default: Enter your password
Visibility toggleShows an eye icon that reveals or hides the password.On or off. Default: On
Show strengthShows a four-step meter under the field that rates the password as Weak, Fair, Good or Strong.On or off. Default: Off
Min lengthFewest characters the password needs. A shorter password is not valid. 0 sets no minimum.Number. Default: 0
Allow clearShows a clear icon in the field once it has text.On or off. Default: Off
VariantBorder style of the field. filled uses a light background, borderless has no border, and underlined shows only a bottom line.outlined, filled, borderless, underlined. Default: outlined
SizeHeight and text size of the field.small, middle, large. Default: middle

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 password changes.
On press enterTriggers when the user presses Enter in the field.
On focusTriggers when the field gets keyboard focus.
On blurTriggers when the field loses keyboard 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 valueSets the password to the given Value.components.password1.setFieldValue("")
ClearSets the field back to the Value property, which empties it when Value is empty.components.password1.resetFields()
FocusMoves keyboard focus to the field.components.password1.focus()
BlurRemoves keyboard focus from the field.components.password1.blur()
Set visibilityShows the component when true, hides it when false.components.password1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.password1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.password1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
labelText shown above the field, or beside it when Layout is horizontal.{{components.password1.label}}
extraHelp text shown under the field. A validation message replaces it while the value is not valid.{{components.password1.extra}}
tooltipText shown from an info icon after the label.{{components.password1.tooltip}}
layoutWhere the label sits: vertical puts it above the field, horizontal puts it to the left.{{components.password1.layout}}
valueThe password the field starts with.{{components.password1.value}}
placeholderHint text shown while the field is empty.{{components.password1.placeholder}}
visibilityToggleShows an eye icon that reveals or hides the password.{{components.password1.visibilityToggle}}
showStrengthShows a four-step meter under the field that rates the password as Weak, Fair, Good or Strong.{{components.password1.showStrength}}
minLengthFewest characters the password needs. A shorter password is not valid. 0 sets no minimum.{{components.password1.minLength}}
allowClearShows a clear icon in the field once it has text.{{components.password1.allowClear}}
variantBorder style of the field. filled uses a light background, borderless has no border, and underlined shows only a bottom line.{{components.password1.variant}}
sizeHeight and text size of the field.{{components.password1.size}}
strengthRating of the password: Weak, Fair, Good or Strong, or empty when the field is empty. Length, mixed case, digits and symbols raise it.{{components.password1.strength}}
isVisibleWhether the component is visible.{{components.password1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.password1.isLoading}}
isDisabledWhether the component is disabled.{{components.password1.isDisabled}}

Styles​

Style
Default
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border radius—
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.