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.

Anchor to PropertiesProperties

Configure the following properties on the email field component.

Anchor to autocomplete autocomplete "on" | "off" | | `section-${string} email` | `section-${string} home email` | `section-${string} mobile email` | `section-${string} fax email` | `section-${string} pager email` | "shipping email" | "shipping home email" | "shipping mobile email" | "shipping fax email" | "shipping pager email" | "billing email" | "billing home email" | "billing mobile email" | "billing fax email" | "billing pager email" | `section-${string} shipping email` | `section-${string} shipping home email` | `section-${string} shipping mobile email` | `section-${string} shipping fax email` | `section-${string} shipping pager email` | `section-${string} billing email` | `section-${string} billing home email` | `section-${string} billing mobile email` | `section-${string} billing fax email` | `section-${string} billing pager email` Default: 'on' for everything else required: Controls browser autofill behavior for the field.

Basic values:

on - Enables autofill without specifying content type (default)

off - Disables autofill for sensitive data or one-time codes

Specific field values describe the expected data type. You can optionally prefix these with:

section-${string} - Scopes autofill to a specific form section (when multiple forms exist on the same page)

shipping or billing - Indicates whether the data is for shipping or billing purposes

Both section and group (for example, section-primary shipping email)

Providing a specific autofill token helps browsers suggest more relevant saved data.

Learn more about the set of autocomplete values supported in browsers.
Anchor to maxLength maxLength number Default: Infinity required: The maximum number of characters allowed in the field.
Anchor to minLength minLength number Default: 0 required: The minimum number of characters required in the field.
Anchor to value value string required: The current email address value in the field. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The field validates this value as an email address format when the user finishes editing.
Anchor to defaultValue defaultValue string required: 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 it. Changing this property after the field has loaded has no effect. To update the field value at any time, use value instead.
Anchor to details details string required: Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.
Anchor to error error string required: An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.
Anchor to label label string required: 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' required: Controls whether the label is visible to all users or only to screen readers.

visible: The label is shown to everyone (default).

exclusive: The label is visually hidden but still announced by screen readers.

Use exclusive when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.
Anchor to placeholder placeholder string required: The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.
Anchor to readOnly readOnly boolean Default: false required: 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 required: Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the error property to display validation messages.
Anchor to disabled disabled boolean Default: false required: Whether the field is disabled, preventing any user interaction.
Anchor to id id string required: 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 name name string required: 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.

EmailAutocompleteField

Represents autocomplete values that are valid for email input fields. This is a subset of `AnyAutocompleteField` containing only fields suitable for email inputs. Available values: - `email` - Primary email address - `home email` - Home email address - `mobile email` - Mobile device email address - `fax email` - Fax machine email address - `pager email` - Pager device email address

'email' | 'home email' | 'mobile email' | 'fax email' | 'pager email'

Anchor to EventsEvents

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

Anchor to blur blur <'input'> required: A callback fired when the email field loses focus.

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

Learn more about the change event.
Anchor to focus focus <'input'> required: A callback fired when the email field receives focus.

Learn more about the focus event.
Anchor to input input <'input'> required: A callback fired when the user inputs data into the email field.

Learn more about the input event.

CallbackEventListener

A function that handles events from UI components. This type represents an event listener callback that receives a `CallbackEvent` with a strongly-typed `currentTarget`. Use this for component event handlers like `click`, `focus`, `blur`, and other DOM events.

(EventListener & {
      (event: CallbackEvent<T>): void;
    }) | null

CallbackEvent

An event object with a strongly-typed `currentTarget` property that references the specific HTML element that triggered the event. This type extends the standard DOM `Event` interface and ensures type safety when accessing the element that fired the event.

Event & {
  currentTarget: HTMLElementTagNameMap[T];
}

Anchor to ExamplesExamples

Anchor to Add a basic email fieldAdd a basic email field

Collect an email address from merchants with a labeled input and helper text. This example shows a basic email field with a placeholder and details text.

Preview

html

<s-email-field

label="Email"

placeholder="bernadette.lapresse@jadedpixel.com"

details="Used for sending notifications"

></s-email-field>

Anchor to Show an error with help textShow an error with help text

Display an error message and help text to guide merchants toward entering a valid email. This example shows a required email field with both a details hint and an error message.

Preview

html

<s-stack gap="base">

<s-email-field

label="Contact email"

details="We'll send your order confirmation here"

error="Please enter a valid email address"

required

></s-email-field>

</s-stack>

Anchor to Make an email field read-onlyMake an email field read-only

Display an existing email address that merchants can see but not edit. This example shows a read-only email field with a pre-filled value.

Preview

html

<s-stack gap="base">

<s-email-field

label="Account email"

value="user@example.com"

readOnly

></s-email-field>

</s-stack>

Anchor to Disable an email fieldDisable an email field

Disable an email field to prevent all interaction while keeping the value visible. This example shows a disabled field with a pre-filled email address.

Preview

html

<s-email-field

label="Account email"

value="admin@example.com"

disabled

></s-email-field>

Anchor to Set character length constraintsSet character length constraints

Set minimum and maximum character lengths to add validation beyond the standard email format check. This example shows a required email field with minLength and maxLength constraints.

Preview

html

<s-stack gap="base">

<s-email-field

label="Business email"

minLength="5"

maxLength="100"

required

></s-email-field>

</s-stack>

Anchor to Best practicesBest practices

Write descriptive labels: Use specific labels like Customer Email, Receipt Email Address, or Order Notification Email rather than generic Email or Email Address.
Provide context in details: Use details for additional context like "Required for digital receipts" or "We'll send order updates to this address."
Show format examples in placeholders: Use placeholders like you@example.com or support@yourstore.com to demonstrate expected format, but don't repeat the label text.
Write actionable error messages: Provide clear validation messages like "Please enter a valid email address" or "Email must include @ symbol" that help merchants correct their input.

Anchor to LimitationsLimitations

Email addresses can't exceed 254 characters total per RFC 5321. Setting maxLength higher than 254 allows values that will fail during email delivery.
Different browsers implement email validation differently. Always validate email format server-side for critical functionality.

Was this page helpful?