URL field

The URL field component collects URLs from users with built-in formatting and validation. Use URL field for website addresses, link destinations, or any URL input to provide URL-specific keyboard layouts and automatic validation.

URL fields support protocol prefixing, validation, and help text to guide users toward entering properly formatted web addresses. For general text input, use text field.

Anchor to PropertiesProperties

Configure the following properties on the URL field component.

Anchor to autocomplete autocomplete "on" | "off" | `section-${string} url` | `section-${string} photo` | `section-${string} impp` | `section-${string} home impp` | `section-${string} mobile impp` | `section-${string} fax impp` | `section-${string} pager impp` | "shipping url" | "shipping photo" | "shipping impp" | "shipping home impp" | "shipping mobile impp" | "shipping fax impp" | "shipping pager impp" | "billing url" | "billing photo" | "billing impp" | "billing home impp" | "billing mobile impp" | "billing fax impp" | "billing pager impp" | `section-${string} shipping url` | `section-${string} shipping photo` | `section-${string} shipping impp` | `section-${string} shipping home impp` | `section-${string} shipping mobile impp` | `section-${string} shipping fax impp` | `section-${string} shipping pager impp` | `section-${string} billing url` | `section-${string} billing photo` | `section-${string} billing impp` | `section-${string} billing home impp` | `section-${string} billing mobile impp` | `section-${string} billing fax impp` | `section-${string} billing pager impp` | 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 URL value in the field as a string. 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 a URL 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.

URLAutocompleteField

Represents autocomplete values that are valid for URL input fields. This is a subset of `AnyAutocompleteField` containing only fields suitable for URL inputs. Available values: - `url` - General URL or web address - `photo` - URL to a photo or image - `impp` - Instant messaging protocol URL - `home impp` - Home instant messaging protocol URL - `mobile impp` - Mobile instant messaging protocol URL - `fax impp` - Fax instant messaging protocol URL - `pager impp` - Pager instant messaging protocol URL

'url' | 'photo' | 'impp' | 'home impp' | 'mobile impp' | 'fax impp' | 'pager impp'

Anchor to EventsEvents

The URL 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 URL field loses focus.

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

Learn more about the change event.
Anchor to focus focus <'input'> required: A callback fired when the URL 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 URL 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 Collect a URLCollect a URL

Capture web addresses from users with URL-specific input. This example pairs a label with placeholder text guiding the expected format.

Preview

html

<s-url-field

label="Your website"

details="Enter your business website"

placeholder="https://example.com"

></s-url-field>

Anchor to Set validation constraintsSet validation constraints

Enforce URL requirements before form submission. This example configures required validation with length constraints and custom error messages.

Preview

html

<s-url-field

label="Company website"

required

minLength="10"

maxLength="200"

error="Please enter a valid website URL"

></s-url-field>

Anchor to Pre-fill a URLPre-fill a URL

Display a URL that users can copy but not edit. This example uses readOnly to prevent changes while keeping the value selectable and included in form submissions.

Preview

html

<s-url-field

label="Profile URL"

value="https://shop.myshopify.com"

readOnly

></s-url-field>

Anchor to Show a disabled fieldShow a disabled field

Show a URL in a non-interactive state. This example uses disabled to gray out the field and exclude it from form submission.

Preview

html

<s-url-field

label="Store URL"

value="https://your-store.myshopify.com"

disabled

></s-url-field>

Anchor to Best practicesBest practices

Validate URL structure: Browser validation for URL fields is minimal and inconsistent. Implement your own validation to ensure URLs have proper structure, valid protocols, and acceptable formats for your use case.
Make the expected format clear: Users need to know whether to include protocols, what protocols are acceptable, and what type of URL you're expecting. Show complete example URLs in placeholders to demonstrate the required format.
Handle missing protocols gracefully: Users often forget to include https:// when entering URLs. Decide whether to automatically add it, accept URLs without protocols, or show clear error messages explaining what's missing.
Set realistic length constraints: URL length limits vary across browsers and servers. Set constraints based on where the URL will be used, not just arbitrary maximums. Communicate these limits clearly when they're necessary.
Provide clear context: Make the URL's purpose obvious through labels and help text. Users entering a product image URL have different needs than those entering a social media profile link or external reference.

Anchor to LimitationsLimitations

The HTML5 URL input type (type="url") has very basic validation that varies by browser. Most browsers only check for :// somewhere in the string. Invalid URLs like ht://invalid might pass browser validation. Always implement comprehensive server-side URL validation.
While RFC 3986 doesn't specify a maximum URL length, the practical recommended limit for broad compatibility across web clients and servers is 2,048 characters. Modern browsers support much longer URLs, but many servers have lower limits for request URIs. Setting maxLength above 2,048 might create URLs that work in some contexts but fail in others.
URLs starting with // (protocol-relative, like //example.com) are technically valid but might not pass HTML5 URL validation. Users must include the full protocol (http:// or https://).
This component doesn't automatically prepend https:// if merchants omit the protocol. A value like example.com will be invalid and require manual correction. You must implement this behavior yourself if desired.
URLs with special characters (spaces, quotes, Unicode) should be percent-encoded (%20, %22), but the component doesn't auto-encode. Provide guidance to merchants or implement encoding in your validation logic.

Was this page helpful?