SEmailField <s-email-field>

用于输入电子邮件地址的文本输入框。 SEmailField 是 Shopify Polaris <s-email-field> web component 的带类型 Vue 3 wrapper。

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

最佳实践

• 使用具体的 label。 “客户电子邮件”或“订单通知邮箱”这样的名称比简单的“电子邮件”或“电子邮件地址”更清晰。
• 在 details 中补充背景信息。 说明为什么需要该地址或它将如何使用，例如“用于接收电子收据”。
• 在 placeholder 中展示格式。 像“you@example.com”这样的示例地址可以展示应输入的内容；不要只是重复标签。
• 让 error 消息具有可操作性。 告诉商家如何修正地址，例如“请输入有效的电子邮件地址”。

<SEmailField
  label="Order notification email"
  details="We'll send order updates to this address."
  placeholder="you@example.com"
/>

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

示例

Value: (empty)

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

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

<template>
  <SEmailField label="Email" placeholder="jane@example.com" v-model="value" />
  <p>Value: {{ value }}</p>
</template>

v-model

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

<SEmailField v-model="value" />

等价于：

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

Props

Prop	类型	说明
autocomplete	"email" | "home email" | "mobile email" | "fax email" | "pager email" | "on" | "off" | "shipping email" … (9 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 属性。
value	string	字段的当前值。如果省略，字段将为空。

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

Events

Event	类型
blur	FocusEvent
change	Event
focus	FocusEvent
input	Event

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

Slots

Slot	说明
details
error