SSearchField <s-search-field>

Ein Texteingabefeld für Suchanfragen. SSearchField ist ein typisierter Vue-3-Wrapper für die Shopify Polaris Web Component <s-search-field>.

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

Best Practices

• Zum Filtern vor Ort verwenden. Es eignet sich, um den Inhalt eines bestimmten Abschnitts oder einer Liste einzugrenzen. Globale Navigation oder komplexe, mehrstufige Suchen erfordern ein robusteres Suchmuster.
• Sagen, was durchsucht wird. Schreiben Sie ein konkretes label und einen placeholder, die Händlern sagen, welche Inhalte die Suche abdeckt und nach welchen Attributen sie suchen können.
• Während der Eingabe reagieren. Aktualisieren Sie Ergebnisse oder gefilterte Inhalte nach Möglichkeit schon während der Eingabe, damit Händler ihre Suche verfeinern können und darauf vertrauen, dass sie funktioniert.
• Geleerte und leere Suchen einplanen. Wird das Feld geleert, zeigen Sie wieder die vollständige Liste. Gibt es keine Treffer, zeigen Sie eine Meldung, die eine andere Aktion oder eine breitere Suche vorschlägt.
• Auf genügend Eingabe warten. Vermeiden Sie Suchen, die zu viele oder bedeutungslose Ergebnisse liefern würden; ab zwei oder drei Zeichen gibt es genug, um nützliche Treffer zu liefern.

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

Die vollständigen Richtlinien finden sich in Shopifys Best Practices für <s-search-field> (auf Englisch).

Beispiel

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

v-model auf <SSearchField> bindet die Property value und lauscht auf das DOM-Event input.

<SSearchField v-model="value" />

entspricht:

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

Props

Prop	Typ	Beschreibung
autocomplete	"language" | "organization" | "name" | "additional-name" | "address-level1" | "address-level2" | "address-level3" | "address-level4" … (84 more)	Ein Hinweis auf den vorgesehenen Inhalt des Felds. Bei on (Standard) gibt diese Eigenschaft an, dass das Feld Autofill unterstützen soll, ohne dass weitere semantische Informationen zum vorgesehenen Inhalt vorliegen. Mit off wird angegeben, dass das Feld sensible Informationen oder Inhalte enthält, die nie gespeichert werden, etwa Einmalcodes. Alternativ kann ein Wert angegeben werden, der die konkreten Daten beschreibt, die beim Autofill in dieses Feld eingetragen werden sollen.
defaultValue	string	Der Standardwert des Feldes.
details	any	Zusätzlicher Text, der Kontext oder Hilfestellung zum Feld bietet. Dieser Text wird zusammen mit dem Feld und seinem Label angezeigt, um dem Nutzer weitere Informationen oder Anweisungen zu geben. Er wird auch Screenreader-Nutzern zugänglich gemacht.
disabled	boolean	Deaktiviert das Feld und verhindert jegliche Interaktion.
error	any	Zeigt dem Nutzer einen Fehler an. Das Feld erhält eine besondere Gestaltung, um Probleme zu kennzeichnen, die sofort behoben werden müssen.
id	string	Eine eindeutige Kennung für das Element.
label	any	Inhalt, der als Label des Felds verwendet wird.
labelAccessibilityVisibility	"visible" | "exclusive"	Ändert die Sichtbarkeit des Labels der Komponente. - visible: Das Label ist für alle Nutzer sichtbar. - exclusive: Das Label ist visuell ausgeblendet, bleibt aber im Accessibility Tree.
maxLength	number	Gibt die maximal erlaubte Anzahl an Zeichen an.
minLength	number	Gibt die minimal erlaubte Anzahl an Zeichen an.
name	string	Eine Kennung für das Feld, die innerhalb des nächsten umschließenden Formulars eindeutig ist.
placeholder	string	Ein kurzer Hinweis, der den erwarteten Wert des Felds beschreibt.
readOnly	boolean	Das Feld kann vom Benutzer nicht bearbeitet werden. Es ist fokussierbar und wird von Screenreadern angesagt.
required	boolean	Ob das Feld einen Wert benötigt. Diese Anforderung verleiht dem Feld semantische Bedeutung, führt aber nicht automatisch zur Anzeige eines Fehlers. Wenn ein Fehler angezeigt werden soll, sobald dieses Feld leer ist, verwenden Sie dafür die Eigenschaft error.
value	string	Der aktuelle Wert des Feldes. Wird er weggelassen, ist das Feld leer.

Einige Typspalten oben wurden zur besseren Lesbarkeit gekürzt; die vollständigen Unions finden sich in den generierten TypeScript-Typen der Bibliothek (src/lib/generated/types.ts).

Events

Event	Typ
blur	FocusEvent
change	Event
focus	FocusEvent
input	Event

Auf diese Events lauschen Sie mit Listenern im Stil von @blur auf <SSearchField>.

Slots

Slot	Beschreibung
details
error