SEmailField <s-email-field>

Un campo de texto para direcciones de correo electrónico. SEmailField es el wrapper de Vue 3 tipado del web component <s-email-field> de Shopify Polaris.

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

Buenas prácticas

• Usa un label específico. Nombres como "Customer email" u "Order notification email" son más claros que un simple "Email" o "Email address".
• Añade contexto en details. Explica por qué se necesita la dirección o cómo se usa, por ejemplo "Required for digital receipts".
• Muestra el formato en placeholder. Una dirección de ejemplo como "you@example.com" muestra qué escribir; no te limites a repetir la etiqueta.
• Haz que los mensajes de error sean útiles. Indica a los comerciantes cómo corregir la dirección, por ejemplo "Enter a valid email address".

<SEmailField
  label="Order notification email"
  details="We'll send order updates to this address."
  placeholder="you@example.com"
/>

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

Ejemplo

Value: (empty)

<script setup>
import { ref } from 'vue'
import { SEmailField } from 'polaris-vue-elements'

const value = ref('')
</script>

<template>
  <SEmailField label="Email" placeholder="jane@example.com" v-model="value" />
  <p>Value: {{ value }}</p>
</template>

v-model

v-model en <SEmailField> se vincula a la propiedad value y escucha el event DOM input.

<SEmailField v-model="value" />

equivale a:

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

Props

Prop	Tipo	Descripción
autocomplete	"email" | "home email" | "mobile email" | "fax email" | "pager email" | "on" | "off" | "shipping email" … (9 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 <SEmailField>.

Slots

Slot	Descripción
details
error