Forms

TextArea

Multi-line text input with v-model support. Wraps the Polaris <s-text-area> web component.

Usage

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

<template>
  <ShTextArea v-model="description" label="Description" rows="5" />
</template>

Props

PropTypeDefaultDescription
modelValuestringBound value (use with v-model)
labelstringInput label
rowsnumberNumber of visible text rows
maxLengthnumberMaximum character length
minLengthnumberMinimum character length
placeholderstringPlaceholder text
errorstringError message
detailsstringHelp text below the input
autocompletestringAutocomplete attribute
defaultValuestringDefault value (uncontrolled)
labelAccessibilityVisibility'visible' | 'exclusive'Label visibility for assistive tech
readOnlybooleanMakes the field read-only
requiredbooleanMarks the field as required
disabledbooleanDisables the field
idstringElement ID
namestringForm field name

Events

EventPayloadDescription
update:modelValuestringEmitted when value changes (v-model)
inputInputEventNative input event
changeInputEventNative change event
focusInputEventEmitted on focus
blurInputEventEmitted on blur

Slots

SlotDescription
defaultAdditional content

Polaris Element

Renders as <s-text-area>. See Polaris TextArea docs.

© 2026 KiriminAja. Polaris and Shopify are trademarks of Shopify Inc.

KiriminAja not affiliated with Shopify.