SSearchField <s-search-field>
Một ô nhập văn bản cho truy vấn tìm kiếm. SSearchField là Vue 3 wrapper có type cho web component <s-search-field> của Shopify Polaris.
ts
import { SSearchField } from 'polaris-vue-elements'Best practices
- Dùng để lọc tại chỗ. Nó phù hợp để thu hẹp nội dung của một phần hoặc một danh sách cụ thể. Điều hướng toàn cục hoặc các tìm kiếm phức tạp, nhiều bước cần một mẫu tìm kiếm mạnh mẽ hơn.
- Nói rõ đang tìm kiếm gì. Viết
labelvàplaceholdercụ thể, cho người bán biết tìm kiếm bao gồm nội dung nào và họ có thể tìm theo những thuộc tính nào. - Phản hồi khi người bán gõ. Khi có thể, hãy cập nhật kết quả hoặc nội dung được lọc ngay khi người bán gõ, để họ có thể tinh chỉnh truy vấn và tin rằng tìm kiếm đang hoạt động.
- Tính đến trường hợp xóa tìm kiếm và không có kết quả. Khi trường bị xóa trống, hãy hiển thị lại toàn bộ danh sách. Khi không có gì khớp, hiển thị một thông báo gợi ý hành động khác hoặc một tìm kiếm rộng hơn.
- Chờ đủ dữ liệu nhập. Tránh chạy những tìm kiếm trả về quá nhiều kết quả hoặc kết quả vô nghĩa; bắt đầu sau hai hoặc ba ký tự là đủ để trả về các kết quả hữu ích.
vue
<SSearchField label="Search products" placeholder="Search by title, SKU or vendor" />Xem best practices của Shopify cho <s-search-field> (tiếng Anh) để có hướng dẫn đầy đủ.
Ví dụ
Value: (empty)
vue
<script setup>
import { ref } from 'vue'
import { SSearchField } from 'polaris-vue-elements'
const value = ref('')
</script>
<template>
<SSearchField label="Search products" placeholder="Search" v-model="value" />
<p>Value: {{ value }}</p>
</template>v-model
v-model trên <SSearchField> gắn với property value và lắng nghe DOM event input.
template
<SSearchField v-model="value" />tương đương với:
template
<SSearchField :value="value" @input="value = $event.target.value" />Props
| Prop | Kiểu | Mô tả |
|---|---|---|
autocomplete | "language" | "organization" | "name" | "additional-name" | "address-level1" | "address-level2" | "address-level3" | "address-level4" … (84 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 <SSearchField>.
Slots
| Slot | Mô tả |
|---|---|
details | |
error |