SEmailField <s-email-field>

メールアドレス用のテキスト入力。 SEmailField は、Shopify Polaris の <s-email-field> web component 向けの型付き Vue 3 wrapper です。

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

ベストプラクティス

• 具体的な label を使う。 「Customer email」や「Order notification email」のような名前は、単なる「Email」や「Email address」よりもわかりやすくなります。
• details で背景を補足する。 「Required for digital receipts」のように、なぜアドレスが必要なのか、どう使われるのかを説明します。
• placeholder で形式を示す。 「you@example.com」のようなアドレスの例で入力内容を示します。ラベルを繰り返すだけにはしないでください。
• error メッセージは対処方法がわかるようにする。 「Enter a valid email address」のように、アドレスの直し方をマーチャントに伝えます。

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

詳しいガイダンスについては、<s-email-field> に関する Shopify のベストプラクティス（英語）を参照してください。

例

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 プロパティにバインドされ、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	フィールドの現在の値です。省略した場合、フィールドは空になります。

上記の一部の型の列は読みやすさのために省略されています。完全な union はライブラリが生成する TypeScript の型（src/lib/generated/types.ts）で確認できます。

Events

Event	型
blur	FocusEvent
change	Event
focus	FocusEvent
input	Event

これらのイベントは <SEmailField> 上で @blur 形式のリスナーで受け取れます。

Slots

Slot	説明
details
error