TextField

TextFieldElementProps

• autocomplete

  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.

  AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | "on" | "off"

• defaultValue

  The default value for the field.

  string

• disabled

  Disables the field, disallowing any interaction.

  boolean

• error

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

  string

• icon

  The type of icon to be displayed in the field.

  "" | ReducedIconTypes

• id

  A unique identifier for the element.

  string

• label

  Content to use as the field label.

  string

• labelAccessibilityVisibility

  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.

  ExtractStrict<AccessibilityVisibilityProps["accessibilityVisibility"], "visible" | "exclusive">

• maxLength

  Specifies the maximum number of characters allowed.

  number

• minLength

  Specifies the min number of characters allowed.

  number

• name

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

  string

• placeholder

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

  string

• prefix

  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.

  string

• readOnly

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

  boolean

• required

  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.

  boolean

• suffix

  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.

  string

• value

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

  string

export interface TextFieldElementProps extends Pick<TextFieldProps$1, 'autocomplete' | 'defaultValue' | 'disabled' | 'error' | 'id' | 'icon' | 'label' | 'labelAccessibilityVisibility' | 'maxLength' | 'minLength' | 'name' | 'placeholder' | 'prefix' | 'readOnly' | 'required' | 'suffix' | 'value'> {
    icon?: IconProps['type'];
}

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"

ReducedIconTypes

The list of available icon types.

'cart' | 'note' | 'settings' | 'reset' | 'map' | 'menu' | 'search' | 'circle' | 'filter' | 'image' | 'info' | 'disabled' | 'email' | 'organization' | 'mobile' | 'alert-circle' | 'x'

ExtractStrict

Like `Extract`, but ensures that the extracted type is a strict subtype of the input type.

AccessibilityVisibilityProps

• accessibilityVisibility

  Changes the visibility of the element. - `visible`: the element is visible to all users. - `hidden`: the element is removed from the accessibility tree but remains visible. - `exclusive`: the element is visually hidden but remains in the accessibility tree.

  'visible' | 'hidden' | 'exclusive'

export interface AccessibilityVisibilityProps {
	/**
	 * Changes the visibility of the element.
	 *
	 * - `visible`: the element is visible to all users.
	 * - `hidden`: the element is removed from the accessibility tree but remains visible.
	 * - `exclusive`: the element is visually hidden but remains in the accessibility tree.
	 *
	 * @default 'visible'
	 */
	accessibilityVisibility?: "visible" | "hidden" | "exclusive";
}

TextFieldElementEvents

• blur

  Callback when the element loses focus.

  ((event: CallbackEventListener<typeof tagName>) => void) | null

• change

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

  ((event: CallbackEventListener<typeof tagName>) => void) | null

• focus

  Callback when the element receives focus.

  ((event: CallbackEventListener<typeof tagName>) => void) | null

• input

  Callback when the user makes any changes in the field.

  ((event: CallbackEventListener<typeof tagName>) => void) | null

export interface TextFieldElementEvents {
    /**
     * Callback when the element loses focus.
     */
    blur?: ((event: CallbackEventListener<typeof tagName>) => void) | null;
    /**
     * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.
     */
    change?: ((event: CallbackEventListener<typeof tagName>) => void) | null;
    /**
     * Callback when the element receives focus.
     */
    focus?: ((event: CallbackEventListener<typeof tagName>) => void) | null;
    /**
     * Callback when the user makes any changes in the field.
     */
    input?: ((event: CallbackEventListener<typeof tagName>) => void) | null;
}

CallbackEventListener

(EventListener & {
    (event: CallbackEvent<TTagName, TEvent>): void;
}) | null

CallbackEvent

TEvent & {
    currentTarget: HTMLElementTagNameMap[TTagName];
}

TextFieldElementSlots

• accessory

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

  HTMLElement

export interface TextFieldElementSlots {
    /**
     * Additional content to be displayed in the field.
     * Commonly used to display an icon that activates a tooltip providing more information.
     */
    accessory?: HTMLElement;
}