Skip to main content

URLField

Collect URLs from users with built-in formatting and validation.

Anchor to urlfieldURLField

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` |

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.

Anchor to defaultValue
defaultValue
string

The default value for the field.

Anchor to details
details
string

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.

Anchor to disabled
disabled
boolean

Disables the field, disallowing any interaction.

Anchor to error
error
string

Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.

Anchor to id
id
string

A unique identifier for the element.

Anchor to label
label
string

Content to use as the field label.

Anchor to labelAccessibilityVisibility
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.
Anchor to maxLength
maxLength
number

Specifies the maximum number of characters allowed.

Anchor to minLength
minLength
number

Specifies the min number of characters allowed.

Anchor to name
name
string

An identifier for the field that is unique within the nearest containing form.

Anchor to placeholder
placeholder
string

A short hint that describes the expected value of the field.

Anchor to readOnly
readOnly
boolean

The field cannot be edited by the user. It is focusable will be announced by screen readers.

Anchor to required
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.

Anchor to value
value
string

The current value for the field. If omitted, the field will be empty.

Was this section helpful?

Anchor to eventsEvents

Learn more about registering events.

Anchor to blur
blur
<'input'>
Anchor to change
change
<'input'>
Anchor to focus
focus
<'input'>
Anchor to input
input
<'input'>
Was this section helpful?

Code

<s-url-field
label="Your website"
details="Join the partner ecosystem"
placeholder="https://shopify.com/partner"
></s-url-field>

Preview