STextField <s-text-field>

带标签、占位符、校验错误和帮助文本的单行文本输入框。 STextField 是 Shopify Polaris <s-text-field> web component 的带类型 Vue 3 wrapper。

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

最佳实践

• 让预期输入一目了然。 编写 label 和 placeholder，告诉商家应输入什么以及使用什么格式。含糊的措辞会导致猜测、校验错误和挫败感。
• 用前缀或后缀补充上下文。 使用 prefix 和 suffix 显示值的类型及格式，例如商家应输入完整 URL 还是仅输入子域名，应输入完整价格还是仅输入金额。
• 根据实际需求设置约束。 依据真实的业务需求（而不是随意的数字）设置 minLength、maxLength 和校验规则，并告诉商家这些约束是什么。
• 尽早给出具体的反馈。 在商家输入时就告诉他们输入是否有效，而不是只在提交时才提示。输入无效时，用 error 说明问题所在以及如何修正。

<STextField label="Store address" prefix="https://" suffix=".myshopify.com" />

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

示例

Value: (empty)

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

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

<template>
  <STextField label="Your name" placeholder="Jane Doe" v-model="value" />
  <p>Value: {{ value }}</p>
</template>

v-model

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

<STextField v-model="value" />

等价于：

<STextField :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	向用户提示错误。字段会采用特定的样式处理，以传达必须立即解决的问题。
icon	"cart-filled" | "channels-filled" | "home-filled" | "order-filled" | "person-filled" | "product-filled" | "color" | "info" … (597 more)	字段中显示的图标类型。
id	string	元素的唯一标识符。
label	any	用作字段标签的内容。
labelAccessibilityVisibility	"visible" | "exclusive"	更改组件标签的可见性。 - visible：标签对所有用户可见。 - exclusive：标签在视觉上隐藏，但仍保留在无障碍树中。
maxLength	number	指定允许的最大字符数。
minLength	number	指定允许的最小字符数。
name	string	字段的标识符，在最近的外层表单内唯一。
placeholder	string	描述字段预期值的简短提示。
prefix	string	显示在字段可编辑部分之前的值。适合用于显示值中隐含的部分，例如 "https://" 或 "+353"。用户无法编辑它，它也不包含在字段的值中。在用户与输入框交互之前，它可能不会显示。例如，在用户聚焦输入框之前，内联标签可能会占据前缀的位置。
readOnly	boolean	该字段不能由用户编辑。它可以获得焦点，并会被屏幕阅读器朗读。
required	boolean	字段是否需要填写值。此要求会为字段添加语义，但不会自动显示错误。如果希望在字段为空时显示错误，可以使用 error 属性。
suffix	string	显示在字段可编辑部分之后的值。适合用于显示值中隐含的部分，例如 "@shopify.com" 或 "%"。用户无法编辑它，它也不包含在字段的值中。在用户与输入框交互之前，它可能不会显示。例如，在用户聚焦输入框之前，内联标签可能会占据后缀的位置。
value	string	字段的当前值。如果省略，字段将为空。

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

Events

Event	类型
blur	FocusEvent
change	Event
focus	FocusEvent
input	Event

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

Slots

Slot	说明
accessory	显示在文本字段旁边的附加内容，通常是提供相关功能的图标或按钮，例如打开帮助提示框或触发模态框。
details
error