SPasswordField <s-password-field>

A text input for passwords that masks what is typed. SPasswordField is the typed Vue 3 wrapper for Shopify's Polaris <s-password-field> web component.

import { SPasswordField } from 'polaris-vue-elements'

Best practices

• Work with password managers. Set a fitting autocomplete value, such as new-password or current-password, so password managers can help merchants generate and save strong passwords.
• State the rules up front. List every password requirement before merchants start typing, instead of revealing them only after an invalid entry. This avoids frustration and abandoned forms.
• Guide merchants creating a password. Give live feedback on password strength and explain what would make it stronger, rather than simply enforcing rules without context.
• Let merchants paste. Password managers and similar tools depend on pasting, and blocking it pushes merchants toward weaker passwords they can type from memory.
• Treat client-side checks as feedback only. Always validate the password on your server, because browser constraints are easy to bypass. Client-side validation is there to respond quickly, not to provide security.

<SPasswordField label="New password" autocomplete="new-password" details="Use at least 12 characters." />

See Shopify's best practices for <s-password-field> for the full guidance.

Example

Length: 0

<script setup>
import { ref } from 'vue'
import { SPasswordField } from 'polaris-vue-elements'

const value = ref('')
</script>

<template>
  <SPasswordField label="Password" placeholder="Enter your password" v-model="value" />
  <p>Length: {{ value.length }}</p>
</template>

v-model

v-model on <SPasswordField> binds to the value property and listens for the input DOM event.

<SPasswordField v-model="value" />

is equivalent to:

<SPasswordField :value="value" @input="value = $event.target.value" />

Props

Prop	Type	Description
autocomplete	"current-password" | "new-password" | "on" | "off" | "shipping current-password" | "shipping new-password" | "billing current-password" | "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.
defaultValue	string	The default value for the field.
details	any	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.
disabled	boolean	Disables the field, disallowing any interaction.
error	any	Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.
id	string	A unique identifier for the element.
label	any	Content to use as the field label.
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.
maxLength	number	Specifies the maximum number of characters allowed.
minLength	number	Specifies the min number of characters allowed.
name	string	An identifier for the field that is unique within the nearest containing form.
placeholder	string	A short hint that describes the expected value of the field.
readOnly	boolean	The field cannot be edited by the user. It is focusable will be announced by screen readers.
required	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.
value	string	The current value for the field. If omitted, the field will be empty.

Events

Event	Type
blur	FocusEvent
change	Event
focus	FocusEvent
input	Event

Listen for these with @blur-style listeners on <SPasswordField>.

Slots

Slot	Description
details
error