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" />

전체 가이드는 <s-search-field>에 대한 Shopify 모범 사례(영어)를 참고하세요.

예시

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 event를 수신합니다.

<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	필드의 현재 값입니다. 생략하면 필드가 비어 있습니다.

위의 일부 타입 열은 읽기 쉽도록 축약되었습니다. 전체 union은 라이브러리에서 생성된 TypeScript 타입(src/lib/generated/types.ts)에 있습니다.

Events

Event	타입
blur	FocusEvent
change	Event
focus	FocusEvent
input	Event

<SSearchField>에서 @blur 형식의 리스너로 이 events를 수신하세요.

Slots

Slot	설명
details
error