Skip to main content

TextField

Lets users enter or edit text within a single-line input. Use to collect short, free-form information from users.

Anchor to propertiesProperties

Anchor to autocomplete
autocomplete
AutocompleteField | `${} ${AutocompleteField}` | `${} ${AutocompleteField}` | `${} ${} ${AutocompleteField}` | "on" | "off"
Default: 'on' for everything else

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 disabled
disabled
boolean
Default: false

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 icon
icon
'' | 'cart' | 'note' | 'settings' | 'reset' | 'map' | 'menu' | 'search' | 'circle' | 'filter' | 'image' | 'alert-circle' | 'alert-triangle-filled' | 'alert-triangle' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up-right' | 'arrow-up' | 'bag' | 'bullet' | 'calendar' | 'camera' | 'caret-down' | 'cash-dollar'
Default: ''

The type of icon to be displayed in the field.

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'
Default: 'visible'

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
Default: Infinity

Specifies the maximum number of characters allowed.

Anchor to minLength
minLength
number
Default: 0

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 prefix
prefix
string
Default: ''

A value to be displayed immediately before the editable portion of the field.

This is useful for displaying an implied part of the value, such as "https://" or "+353".

This cannot be edited by the user, and it isn't included in the value of the field.

It may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.

Anchor to readOnly
readOnly
boolean
Default: false

The field cannot be edited by the user. It is focusable will be 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 suffix
suffix
string
Default: ''

A value to be displayed immediately after the editable portion of the field.

This is useful for displaying an implied part of the value, such as "@shopify.com", or "%".

This cannot be edited by the user, and it isn't included in the value of the field.

It may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.

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

Anchor to blur
blur
((event: <typeof tagName>) => void) | null

Callback when the element loses focus.

Anchor to change
change
((event: <typeof tagName>) => void) | null

Callback when the user has finished editing a field, e.g. once they have blurred the field.

Anchor to focus
focus
((event: <typeof tagName>) => void) | null

Callback when the element receives focus.

Anchor to input
input
((event: <typeof tagName>) => void) | null

Callback when the user makes any changes in the field.

Was this section helpful?

Anchor to slotsSlots

Anchor to accessory
accessory
HTMLElement

Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.

Was this section helpful?

Code

<s-text-field
label="First name (optional)"
defaultValue="Taylor"
></s-text-field>

Preview

Anchor to best-practicesBest Practices

  • Clearly label text fields so that it’s obvious what customers should enter.
  • Label text fields as optional when input isn’t required. For example, use the label First name (optional).
  • Don’t have optional fields pass true to the required property.
Was this section helpful?