SColorField <s-color-field>

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

Example

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 on <SColorField> binds to the value property and listens for the input DOM event.

<SColorField v-model="value" />

is equivalent to:

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

Props

Prop	Type	Description
alpha	boolean	Allow user to select an alpha value.
autocomplete	"on" | "off"	A hint as to the intended content of the field. When set to on (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to off, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.
defaultValue	string	The default value for the field.
details	any	Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users.
disabled	boolean	Disables the field, disallowing any interaction.
error	any	Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.
id	string	A unique identifier for the element.
label	any	Content to use as the field label.
labelAccessibilityVisibility	"visible" | "exclusive"	Changes the visibility of the component's label. - visible: the label is visible to all users. - exclusive: the label is visually hidden but remains in the accessibility tree.
name	string	An identifier for the field that is unique within the nearest containing form.
placeholder	string	A short hint that describes the expected value of the field.
readOnly	boolean	The field cannot be edited by the user. It is focusable will be announced by screen readers.
required	boolean	Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the error property.
value	string	The current value for the field. If omitted, the field will be empty.

Events

Event	Type
blur	CustomEvent
change	CustomEvent
focus	CustomEvent
input	CustomEvent

Listen for these with @blur-style listeners on <SColorField>.

Slots

Slot	Description
details
error