Skip to main content

PasswordField

Securely collect sensitive information from users.

"on" | "off" | | `section-${string} current-password` | `section-${string} new-password` | "shipping current-password" | "shipping new-password" | "billing current-password" | "billing new-password" | `section-${string} shipping current-password` | `section-${string} shipping new-password` | `section-${string} billing current-password` | `section-${string} billing new-password`

A hint as to the intended content of the field.

When set to on (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.

When set to off, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.

Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.

string

The default value for the field.

string

Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user.

This will also be exposed to screen reader users.

boolean

Disables the field, disallowing any interaction.

string

Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.

string

A unique identifier for the element.

string

Content to use as the field label.

Anchor to labelAccessibilityVisibility
labelAccessibilityVisibility
"visible" | "exclusive"

Changes the visibility of the component's label.

  • visible: the label is visible to all users.
  • exclusive: the label is visually hidden but remains in the accessibility tree.
number

Specifies the maximum number of characters allowed.

number

Specifies the min number of characters allowed.

string

An identifier for the field that is unique within the nearest containing form.

string

A short hint that describes the expected value of the field.

boolean

The field cannot be edited by the user. It is focusable will be announced by screen readers.

boolean

Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the error property.

string

The current value for the field. If omitted, the field will be empty.

Was this section helpful?

Learn more about registering events.

<'input'>
<'input'>
<'input'>
<'input'>
Was this section helpful?

Code

<s-password-field
label="Password"
placeholder="Enter your password"
details="Must be at least 8 characters long"
minLength="8"
></s-password-field>

Preview