SSearchField <s-search-field>

Un campo de texto para consultas de búsqueda. SSearchField es el wrapper de Vue 3 tipado del web component <s-search-field> de Shopify Polaris.

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

Buenas prácticas

• Úsalo para filtrar en el mismo lugar. Es adecuado para acotar el contenido de una sección o lista concreta. La navegación global o las búsquedas complejas de varios pasos requieren un patrón de búsqueda más robusto.
• Indica qué se busca. Escribe un label y un placeholder específicos que digan a los comerciantes qué contenido abarca la búsqueda y por qué atributos pueden buscar.
• Responde mientras los comerciantes escriben. Siempre que puedas, actualiza los resultados o el contenido filtrado mientras los comerciantes escriben, para que puedan afinar su consulta y confiar en que la búsqueda funciona.
• Prevé las búsquedas borradas y sin resultados. Cuando se vacíe el campo, vuelve a mostrar la lista completa. Cuando nada coincida, muestra un mensaje que sugiera otra acción o una búsqueda más amplia.
• Espera a tener suficiente texto. Evita lanzar búsquedas que devolverían demasiados resultados o resultados sin sentido; empezar a partir de dos o tres caracteres basta para devolver coincidencias útiles.

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

Consulta las buenas prácticas de Shopify para <s-search-field> (en inglés) para ver todas las recomendaciones.

Ejemplo

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 en <SSearchField> se vincula a la propiedad value y escucha el event DOM input.

<SSearchField v-model="value" />

equivale a:

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

Props

Prop	Tipo	Descripción
autocomplete	"language" | "organization" | "name" | "additional-name" | "address-level1" | "address-level2" | "address-level3" | "address-level4" … (84 more)	Una indicación sobre el contenido previsto del campo. Cuando se establece en on (el valor predeterminado), esta propiedad indica que el campo debe admitir el autocompletado, pero no tienes más información semántica sobre el contenido previsto. Cuando se establece en off, indicas que este campo contiene información confidencial o contenido que nunca se guarda, como los códigos de un solo uso. Como alternativa, puedes proporcionar un valor que describa los datos concretos que quieres que se introduzcan en este campo durante el autocompletado.
defaultValue	string	El valor predeterminado del campo.
details	any	Texto adicional que aporta contexto u orientación sobre el campo. Este texto se muestra junto con el campo y su etiqueta para ofrecer más información o instrucciones al usuario. También se expone a los usuarios de lectores de pantalla.
disabled	boolean	Desactiva el campo e impide cualquier interacción.
error	any	Indica un error al usuario. El campo recibe un tratamiento estilístico específico para comunicar problemas que deben resolverse de inmediato.
id	string	Un identificador único para el elemento.
label	any	Contenido que se usa como etiqueta del campo.
labelAccessibilityVisibility	"visible" | "exclusive"	Cambia la visibilidad de la etiqueta del componente. - visible: la etiqueta es visible para todos los usuarios. - exclusive: la etiqueta se oculta visualmente, pero permanece en el árbol de accesibilidad.
maxLength	number	Especifica el número máximo de caracteres permitidos.
minLength	number	Especifica el número mínimo de caracteres permitidos.
name	string	Un identificador del campo que es único dentro del formulario contenedor más cercano.
placeholder	string	Una breve indicación que describe el valor esperado del campo.
readOnly	boolean	El usuario no puede editar el campo. Puede recibir el foco y los lectores de pantalla lo anuncian.
required	boolean	Si el campo requiere un valor. Este requisito añade valor semántico al campo, pero no hará que aparezca un error automáticamente. Si quieres mostrar un error cuando este campo esté vacío, puedes hacerlo con la propiedad error.
value	string	El valor actual del campo. Si se omite, el campo estará vacío.

Algunas columnas de tipo de arriba están truncadas para facilitar la lectura; la unión completa está disponible en los tipos de TypeScript generados de la biblioteca (src/lib/generated/types.ts).

Events

Event	Tipo
blur	FocusEvent
change	Event
focus	FocusEvent
input	Event

Escúchalos con listeners del estilo @blur en <SSearchField>.

Slots

Slot	Descripción
details
error