SColorField <s-color-field>

Ein Texteingabefeld für einen Farbwert, optional mit Alphakanal. SColorField ist ein typisierter Vue-3-Wrapper für die Shopify Polaris Web Component <s-color-field>.

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

Best Practices

• Benennen, wofür die Farbe ist. Verwenden Sie ein label wie „Button background color“ oder „Heading text color“ statt eines allgemeinen „Color“.
• Beim Bearbeiten die aktuelle Farbe zeigen. Setzen Sie value auf die bestehende Farbe, damit Händler den Ausgangswert ihrer Änderung sehen.

<SColorField label="Button background color" value="#1a1a1a" />

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

Beispiel

Value: #008060

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

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

<template>
  <SColorField label="Brand color" v-model="value" />
  <p>Value: {{ value }}</p>
</template>

v-model

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

<SColorField v-model="value" />

entspricht:

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

Props

Prop	Typ	Beschreibung
alpha	boolean	Ermöglicht dem Nutzer, einen Alphawert auszuwählen.
autocomplete	"on" | "off"	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.
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.

Events

Event	Typ
blur	FocusEvent
change	Event
focus	FocusEvent
input	Event

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

Slots

Slot	Beschreibung
details
error