SSearchField <s-search-field>

用于输入搜索关键词的文本输入框。 SSearchField 是 Shopify Polaris <s-search-field> web component 的带类型 Vue 3 wrapper。

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

最佳实践

• 用于就地筛选。 它适合缩小某个特定部分或列表中的内容范围。全局导航或复杂的多步骤搜索则需要更完善的搜索模式。
• 说明搜索的内容。 编写具体的 label 和 placeholder，告诉商家搜索涵盖哪些内容，以及可以按哪些属性进行搜索。
• 随商家输入即时响应。 尽可能在商家输入时更新结果或筛选后的内容，让他们可以不断细化查询，并确信搜索正在生效。
• 为清空和无结果的搜索做好规划。 清空字段后，恢复显示完整列表。没有匹配结果时，显示一条消息，建议其他操作或扩大搜索范围。
• 等待足够的输入。 避免执行会返回过多或无意义结果的搜索；在输入两三个字符之后再开始搜索，就足以返回有用的匹配结果。

<SSearchField label="Search products" placeholder="Search by title, SKU or vendor" />

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

示例

Value: (empty)

<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

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

<SSearchField v-model="value" />

等价于：

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

Props

Prop	类型	说明
autocomplete	"language" | "organization" | "name" | "additional-name" | "address-level1" | "address-level2" | "address-level3" | "address-level4" … (84 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

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

Slots

Slot	说明
details
error