SUrlField <s-url-field>
Một ô nhập văn bản cho địa chỉ web. SUrlField là Vue 3 wrapper có type cho web component <s-url-field> của Shopify Polaris.
ts
import { SUrlField } from 'polaris-vue-elements'Best practices
- Tự xác thực URL. Khả năng xác thực URL có sẵn của trình duyệt rất tối thiểu và khác nhau giữa các trình duyệt, nên hãy tự thêm các kiểm tra về cấu trúc, giao thức được phép và các định dạng mà trường hợp sử dụng của bạn chấp nhận.
- Hiển thị định dạng bạn mong đợi. Cho người bán biết có cần kèm giao thức không, những giao thức nào được phép và bạn muốn loại URL nào. Một URL ví dụ đầy đủ trong
placeholdersẽ làm rõ điều này. - Quyết định cách xử lý khi thiếu giao thức. Người bán thường bỏ quên
https://. Hãy chọn tự thêm cho họ, chấp nhận URL không có nó, hoặc hiển thịerrorgiải thích phần còn thiếu. - Chọn giới hạn độ dài theo nơi URL được dùng. Trình duyệt và server hỗ trợ độ dài tối đa khác nhau, nên hãy đặt
maxLengthdựa trên đích đến của URL thay vì một con số tùy tiện, và nêu giới hạn khi nó quan trọng. - Giải thích URL dùng để làm gì. Dùng
labelvàdetailsđể làm rõ mục đích, vì URL hình ảnh sản phẩm, liên kết hồ sơ mạng xã hội và một tham chiếu bên ngoài mỗi loại cần một thứ khác nhau.
vue
<SUrlField label="Product image URL" placeholder="https://example.com/images/product.jpg" details="Link directly to a JPG or PNG file." />Xem best practices của Shopify cho <s-url-field> (tiếng Anh) để có hướng dẫn đầy đủ.
Ví dụ
Value: (empty)
vue
<script setup>
import { ref } from 'vue'
import { SUrlField } from 'polaris-vue-elements'
const value = ref('')
</script>
<template>
<SUrlField label="Website" placeholder="https://example.com" v-model="value" />
<p>Value: {{ value }}</p>
</template>v-model
v-model trên <SUrlField> gắn với property value và lắng nghe DOM event input.
template
<SUrlField v-model="value" />tương đương với:
template
<SUrlField :value="value" @input="value = $event.target.value" />Props
| Prop | Kiểu | Mô tả |
|---|---|---|
autocomplete | "photo" | "url" | "impp" | "home impp" | "mobile impp" | "fax impp" | "pager impp" | "on" … (15 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 <SUrlField>.
Slots
| Slot | Mô tả |
|---|---|
details | |
error |