Forms

TextField

Text input with v-model support. Wraps the Polaris <s-text-field> web component.

Usage

<script setup>
const title = ref('')
</script>

<template>
  <ShTextField
    v-model="title"
    label="Product title"
    placeholder="Enter product title"
    required
  />
</template>

Props

Prop	Type	Default	Description
`modelValue`	`string`	—	Bound value (use with `v-model`)
`label`	`string`	—	Input label
`placeholder`	`string`	—	Placeholder text
`error`	`string`	—	Error message
`details`	`string`	—	Help text below the input
`icon`	`PolarisIcon`	—	Icon displayed in the field
`prefix`	`string`	—	Text prefix
`suffix`	`string`	—	Text suffix
`maxLength`	`number`	—	Maximum character length
`minLength`	`number`	—	Minimum character length
`autocomplete`	`string`	—	Autocomplete attribute
`defaultValue`	`string`	—	Default value (uncontrolled)
`labelAccessibilityVisibility`	`'visible' \| 'exclusive'`	—	Label visibility for assistive tech
`readOnly`	`boolean`	—	Makes the field read-only
`required`	`boolean`	—	Marks the field as required
`disabled`	`boolean`	—	Disables the field
`id`	`string`	—	Element ID
`name`	`string`	—	Form field name

Events

Event	Payload	Description
`update:modelValue`	`string`	Emitted when value changes (v-model)
`input`	`InputEvent`	Native input event
`change`	`InputEvent`	Native change event
`focus`	`InputEvent`	Emitted on focus
`blur`	`InputEvent`	Emitted on blur

Slots

Slot	Description
`default`	Additional content

Polaris Element

Renders as <s-text-field>. See Polaris TextField docs.

Edit this pageorReport an issue

Link

Styled link element. Wraps the Polaris <s-link> web component.

NumberField

Number input with v-model support. Wraps the Polaris <s-number-field> web component.