SEmailField <s-email-field>

Một ô nhập văn bản cho địa chỉ email. SEmailField là Vue 3 wrapper có type cho web component <s-email-field> của Shopify Polaris.

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

Best practices

• Dùng label cụ thể. Những tên như "Customer email" hay "Order notification email" rõ ràng hơn một "Email" hay "Email address" đơn thuần.
• Thêm ngữ cảnh trong details. Giải thích vì sao cần địa chỉ email hoặc nó được dùng như thế nào, ví dụ "Required for digital receipts".
• Thể hiện định dạng trong placeholder. Một địa chỉ mẫu như "you@example.com" cho thấy cần nhập gì; đừng chỉ lặp lại nhãn.
• Viết thông báo error giúp khắc phục được. Cho người bán biết cách sửa địa chỉ, ví dụ "Enter a valid email address".

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

Xem best practices của Shopify cho <s-email-field> (tiếng Anh) để có hướng dẫn đầy đủ.

Ví dụ

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

v-model trên <SEmailField> gắn với property value và lắng nghe DOM event input.

<SEmailField v-model="value" />

tương đương với:

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

Props

Prop	Kiểu	Mô tả
autocomplete	"email" | "home email" | "mobile email" | "fax email" | "pager email" | "on" | "off" | "shipping email" … (9 more)	Gợi ý về nội dung dự kiến của trường. Khi đặt thành on (mặc định), thuộc tính này cho biết trường nên hỗ trợ tự động điền, nhưng bạn không có thêm thông tin ngữ nghĩa nào về nội dung dự kiến. Khi đặt thành off, bạn cho biết trường này chứa thông tin nhạy cảm, hoặc nội dung không bao giờ được lưu, như mã dùng một lần. Ngoài ra, bạn có thể cung cấp giá trị mô tả loại dữ liệu cụ thể mà bạn muốn được nhập vào trường này khi tự động điền.
defaultValue	string	Giá trị mặc định của trường.
details	any	Văn bản bổ sung cung cấp ngữ cảnh hoặc hướng dẫn cho trường. Văn bản này được hiển thị cùng với trường và nhãn của nó để cung cấp thêm thông tin hoặc chỉ dẫn cho người dùng. Văn bản này cũng được cung cấp cho người dùng trình đọc màn hình.
disabled	boolean	Vô hiệu hóa trường, không cho phép bất kỳ tương tác nào.
error	any	Báo lỗi cho người dùng. Trường sẽ được áp dụng kiểu hiển thị riêng để thông báo các vấn đề cần được giải quyết ngay.
id	string	Định danh duy nhất của phần tử.
label	any	Nội dung dùng làm nhãn của trường.
labelAccessibilityVisibility	"visible" | "exclusive"	Thay đổi khả năng hiển thị của nhãn của component. - visible: nhãn hiển thị với mọi người dùng. - exclusive: nhãn bị ẩn về mặt thị giác nhưng vẫn nằm trong cây trợ năng (accessibility tree).
maxLength	number	Chỉ định số ký tự tối đa được phép.
minLength	number	Chỉ định số ký tự tối thiểu được phép.
name	string	Định danh cho trường, là duy nhất trong form chứa nó gần nhất.
placeholder	string	Gợi ý ngắn mô tả giá trị mong đợi của trường.
readOnly	boolean	Người dùng không thể chỉnh sửa trường. Trường vẫn có thể nhận focus và sẽ được trình đọc màn hình thông báo.
required	boolean	Trường có bắt buộc phải có giá trị hay không. Yêu cầu này bổ sung giá trị ngữ nghĩa cho trường, nhưng sẽ không tự động hiển thị lỗi. Nếu muốn hiển thị lỗi khi trường này trống, bạn có thể dùng thuộc tính error.
value	string	Giá trị hiện tại của trường. Nếu bỏ qua, trường sẽ trống.

Một số cột kiểu ở trên đã được rút gọn cho dễ đọc; union đầy đủ có trong type TypeScript được generate của thư viện (src/lib/generated/types.ts).

Events

Event	Kiểu
blur	FocusEvent
change	Event
focus	FocusEvent
input	Event

Lắng nghe các event này bằng listener dạng @blur trên <SEmailField>.

Slots

Slot	Mô tả
details
error