STextArea <s-text-area>

用于输入备注、描述等较长内容的多行文本输入框。 STextArea 是 Shopify Polaris <s-text-area> web component 的带类型 Vue 3 wrapper。

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

最佳实践

• 根据预期的回答设置大小。 可见的 rows 数量暗示了应写多少内容：较矮的文本区域引导简短的回答，较高的则要求更多细节。
• 设置符合实际需求的长度限制。 根据内容的实际需要选择 minLength 和 maxLength，并提前告知商家这些限制。
• 将占位符用作示例。 编写能展示你期望的内容类型、格式和语气的 placeholder 文字，而不是重复该字段的用途。
• 显示剩余空间。 当你限制最大长度时，让商家看到还剩多少字符，以便在不超出限制的情况下完成内容。

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

参阅 Shopify 关于 <s-text-area> 的最佳实践（英文）以获取完整指南。

示例

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

<STextArea> 上的 v-model 绑定到 value property，并监听 input DOM 事件。

<STextArea v-model="value" />

等价于：

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

Props

Prop	类型	说明
autocomplete	"language" | "organization" | "name" | "additional-name" | "address-level1" | "address-level2" | "address-level3" | "address-level4" … (84 more)	关于字段预期内容的提示。设置为 on（默认值）时，表示该字段应支持自动填充，但没有关于预期内容的更多语义信息。设置为 off 时，表示该字段包含敏感信息或永远不会被保存的内容，例如一次性验证码。此外，也可以提供一个值，描述希望在自动填充时填入该字段的具体数据。
defaultValue	string	字段的默认值。
details	any	为字段提供上下文或指引的附加文本。该文本会与字段及其标签一起显示，为用户提供更多信息或说明。它也会提供给屏幕阅读器用户。
disabled	boolean	禁用字段，不允许任何交互。
error	any	向用户提示错误。字段会采用特定的样式处理，以传达必须立即解决的问题。
id	string	元素的唯一标识符。
label	any	用作字段标签的内容。
labelAccessibilityVisibility	"visible" | "exclusive"	更改组件标签的可见性。 - visible：标签对所有用户可见。 - exclusive：标签在视觉上隐藏，但仍保留在无障碍树中。
maxLength	number	指定允许的最大字符数。
minLength	number	指定允许的最小字符数。
name	string	字段的标识符，在最近的外层表单内唯一。
placeholder	string	描述字段预期值的简短提示。
readOnly	boolean	该字段不能由用户编辑。它可以获得焦点，并会被屏幕阅读器朗读。
required	boolean	字段是否需要填写值。此要求会为字段添加语义，但不会自动显示错误。如果希望在字段为空时显示错误，可以使用 error 属性。
rows	number	可见的文本行数。
value	string	字段的当前值。如果省略，字段将为空。

为便于阅读，上面部分类型列已被截断；完整的联合类型见库中生成的 TypeScript 类型（src/lib/generated/types.ts）。

Events

Event	类型
blur	FocusEvent
change	Event
focus	FocusEvent
input	Event

在 <STextArea> 上使用 @blur 形式的监听器来监听这些事件。

Slots

Slot	说明
details
error