Choose a version:

Email field

The email field component captures email address input. Use it to collect email information in forms, customer profiles, or contact workflows.

Email field doesn't perform automatic email validation. Implement your own validation logic, and use the error property to display validation results. For general text input, use text field.

Support

Targets (29)

Supported targets

Anchor to PropertiesProperties

Configure the following properties on the email 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 email 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 email field loses focus.

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

Learn more about the change event.
Anchor to focus focus <typeof tagName>: A callback fired when the email 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 email 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 email 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 an email addressCollect an email address

Display an email input with a pre-filled value for returning buyers. This example presents an s-email-field with a label and defaultValue.

Collect an email address

A rendered example of the email-field component

html

<s-email-field label="Email" defaultValue="snowdevil@shopify.com"></s-email-field>

Anchor to Validate a required email addressValidate a required email address

Enforce that an email address is provided before the form can be submitted. This example shows a required email field with an error message for missing input.

html

<s-email-field

label="Email address"

required

error="Enter a valid email to receive your receipt"

></s-email-field>

Anchor to Enable browser autocompleteEnable browser autocomplete

Speed up email entry by enabling browser autocomplete suggestions. This example displays an s-email-field with autocomplete set to email.

html

<s-email-field

label="Contact email"

autocomplete="email"

></s-email-field>

Anchor to Best practicesBest practices

Validate on submission: Email fields don't validate the address format automatically. Validate email format when the form is submitted, and display errors using the error property.
Use autocomplete: Set autocomplete="email" so browsers can suggest previously used email addresses.
Pre-fill for returning buyers: Set defaultValue with the buyer's known email to reduce checkout friction.
Don't duplicate validation: Avoid using required and custom validation together unless they serve different purposes. For example, required for presence and custom validation only for format or policy rules, not a second empty-field check.

Was this page helpful?