Choose a version:

Password field

The password field component securely collects sensitive information from users. Use password field for password entry, where input characters are automatically masked for privacy.

Password fields support validation, help text, and accessibility features to create secure and user-friendly authentication experiences. For general text input, use text field.

Password field doesn't include a visibility toggle, complexity enforcement, or strength indicator. Implement these in your extension if needed.

Support

Targets (29)

Supported targets

Anchor to PropertiesProperties

Configure the following properties on the password field component.

Anchor to autocomplete autocomplete AutocompleteField | `${} ${AutocompleteField}` | `${} ${AutocompleteField}` | `${} ${} ${AutocompleteField}` | "on" | "off" Default: 'on': A hint about the intended content of the field for browser autofill.

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.

Learn more about the set of autocomplete values supported in browsers.
Anchor to defaultValue defaultValue string: The initial value of the field when it first loads. Unlike placeholder, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.
Anchor to disabled disabled boolean Default: false: Whether the field is disabled, preventing any user interaction.
Anchor to error error string: An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.
Anchor to id id string: A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.
Anchor to label label string: The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.
Anchor to labelAccessibilityVisibility labelAccessibilityVisibility 'visible' | 'exclusive' Default: 'visible': Controls whether the label is visible to all users or only to screen readers.

visible: The label is shown to everyone.

exclusive: The label is visually hidden but still announced by screen readers.
Anchor to maxLength maxLength number Default: Infinity: Specifies the maximum number of characters allowed.
Anchor to minLength minLength number Default: 0: Specifies the minimum number of characters allowed.
Anchor to name name string: The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.
Anchor to readOnly readOnly boolean Default: false: Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.
Anchor to required required boolean Default: false: 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.
Anchor to value value string: The current value for the field. If omitted, the field will be empty.

AutocompleteSection

The “section” scopes the autocomplete data that should be inserted to a specific area of the page. Commonly used when there are multiple fields with the same autocomplete needs in the same page. For example: 2 shipping address forms in the same page.

`section-${string}`

AutocompleteGroup

The contact information group the autocomplete data should be sourced from.

"shipping" | "billing"

Anchor to EventsEvents

The password field component provides event callbacks for handling user interactions. Learn more about handling events.

Anchor to blur blur <typeof tagName>: A callback fired when the password field loses focus.

Learn more about the blur event.
Anchor to change change <typeof tagName>: A callback fired when the password field value changes.

Learn more about the change event.
Anchor to focus focus <typeof tagName>: A callback fired when the password field receives focus.

Learn more about the focus event.
Anchor to input input <typeof tagName>: A callback fired when the user inputs data into the password field.

Learn more about the input event.

CallbackEventListener

A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag.

(EventListener & {
    (event: CallbackEvent<TTagName, Event> & TData): void;
}) | null

CallbackEvent

An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners.

TEvent & {
    currentTarget: HTMLElementTagNameMap[TTagName];
}

Anchor to SlotsSlots

The password field component supports slots for additional content placement within the component. Learn more about using slots.

Anchor to accessory accessory HTMLElement: Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.

Anchor to ExamplesExamples

Anchor to Collect a passwordCollect a password

Add a password input with a pre-filled value. This example shows an s-password-field with a label and defaultValue that masks the content by default.

Collect a password

A rendered example of the password-field component

html

<s-password-field label="Password" defaultValue="12345678"></s-password-field>

Anchor to Enforce a minimum password lengthEnforce a minimum password length

Validate that a password meets the required character length before submission. This example presents a required password field with minLength set to 8 and an error message.

html

<s-password-field

label="Create a password"

required

minLength="8"

error="Password must be at least 8 characters"

></s-password-field>

Anchor to Display a read-only masked valueDisplay a read-only masked value

Show a masked value in a non-editable state for reference or confirmation. This example displays an s-password-field with the readonly attribute and a defaultValue.

html

<s-password-field

label="API key"

defaultValue="sk-1234567890"

readonly

></s-password-field>

Anchor to Best practicesBest practices

Set minimum length requirements: Use minLength to enforce password length requirements and display clear error messages using error.
Don't pre-fill passwords: Avoid setting defaultValue for new password fields.

Was this page helpful?