Forms

ColorField

Color input with v-model support. Wraps the Polaris <s-color-field> web component.

Usage

<script setup>
const color = ref('')
</script>

<template>
  <ShColorField v-model="color" label="Brand color" alpha />
</template>

Props

PropTypeDefaultDescription
modelValuestringBound value (use with v-model)
labelstringInput label
alphabooleanEnable alpha channel
placeholderstringPlaceholder text
errorstringError message
detailsstringHelp text below the input
autocompletestringAutocomplete attribute
defaultValuestringDefault value (uncontrolled)
labelAccessibilityVisibility'visible' | 'exclusive'Label visibility for assistive tech
readOnlybooleanMakes the field read-only
requiredbooleanMarks the field as required
disabledbooleanDisables the field
idstringElement ID
namestringForm field name

Events

EventPayloadDescription
update:modelValuestringEmitted when value changes (v-model)
inputInputEventNative input event
changeInputEventNative change event
focusInputEventEmitted on focus
blurInputEventEmitted on blur

Slots

SlotDescription
defaultAdditional content

Polaris Element

Renders as <s-color-field>. See Polaris ColorField docs.

© 2026 KiriminAja. Polaris and Shopify are trademarks of Shopify Inc.

KiriminAja not affiliated with Shopify.