STextArea <s-text-area>

A multi-line text input for longer content such as notes or descriptions. STextArea is the typed Vue 3 wrapper for Shopify's Polaris <s-text-area> web component.

import { STextArea } from 'polaris-vue-elements'

Best practices

• Size it for the expected answer. The number of visible rows signals how much to write: a short area invites a brief reply, while a taller one asks for more detail.
• Set length limits that reflect real needs. Choose minLength and maxLength based on what the content actually requires, and tell merchants about those limits up front.
• Use the placeholder as an example. Write placeholder text that shows the kind of content, format and tone you expect, rather than repeating what the field is for.
• Show how much room is left. When you enforce a maximum length, let merchants see how many characters remain so they can fit their content without going over.

<STextArea label="Product description" :rows="6" :maxLength="500" placeholder="Handwoven from organic cotton, this throw adds warmth to any room." />

See Shopify's best practices for <s-text-area> for the full guidance.

Example

Value: (empty)

<script setup>
import { ref } from 'vue'
import { STextArea } from 'polaris-vue-elements'

const value = ref('')
</script>

<template>
  <STextArea label="Bio" placeholder="Tell us about yourself" :rows="3" v-model="value" />
  <p>Value: {{ value }}</p>
</template>

v-model

v-model on <STextArea> binds to the value property and listens for the input DOM event.

<STextArea v-model="value" />

is equivalent to:

<STextArea :value="value" @input="value = $event.target.value" />

Props

Prop	Type	Description
autocomplete	"language" | "organization" | "name" | "additional-name" | "address-level1" | "address-level2" | "address-level3" | "address-level4" … (84 more)	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.
defaultValue	string	The default value for the field.
details	any	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.
disabled	boolean	Disables the field, disallowing any interaction.
error	any	Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.
id	string	A unique identifier for the element.
label	any	Content to use as the field label.
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.
maxLength	number	Specifies the maximum number of characters allowed.
minLength	number	Specifies the min number of characters allowed.
name	string	An identifier for the field that is unique within the nearest containing form.
placeholder	string	A short hint that describes the expected value of the field.
readOnly	boolean	The field cannot be edited by the user. It is focusable will be announced by screen readers.
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.
rows	number	A number of visible text lines.
value	string	The current value for the field. If omitted, the field will be empty.

Some type columns above are truncated for readability; the full union is available in the library's generated TypeScript types (src/lib/generated/types.ts).

Events

Event	Type
blur	FocusEvent
change	Event
focus	FocusEvent
input	Event

Listen for these with @blur-style listeners on <STextArea>.

Slots

Slot	Description
details
error