SColorField `<s-color-field>`

色の値を入力するテキスト入力。アルファチャンネルにも対応できます。 SColorField は、Shopify Polaris の <s-color-field> web component 向けの型付き Vue 3 wrapper です。

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

ベストプラクティス

色の用途を明示する。 汎用的な「Color」ではなく、「Button background color」や「Heading text color」のような label を使います。
編集時は現在の色を表示する。 value に既存の色を設定し、マーチャントが何から変更するのかを確認できるようにします。

vue

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

詳しいガイダンスについては、<s-color-field> に関する Shopify のベストプラクティス（英語）を参照してください。

例

Value: #008060

vue

<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

<SColorField> の v-model は value プロパティにバインドされ、input DOM イベントを監視します。

template

<SColorField v-model="value" />

これは次と同等です：

template

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

Props

Prop	型	説明
`alpha`	`boolean`	ユーザーがアルファ値を選択できるようにします。
`autocomplete`	`"on" \| "off"`	フィールドに入力される内容のヒントです。`on`（デフォルト）に設定すると、フィールドがオートフィルをサポートすべきであることを示しますが、想定される内容についてそれ以上の意味的な情報はありません。`off` に設定すると、このフィールドに機密情報、またはワンタイムコードのように保存されることのない内容が含まれることを示します。あるいは、オートフィル時にこのフィールドに入力してほしい具体的なデータを表す値を指定することもできます。
`defaultValue`	`string`	フィールドのデフォルト値です。
`details`	`any`	フィールドのコンテキストやガイダンスを提供する追加のテキストです。このテキストはフィールドとそのラベルとともに表示され、ユーザーに詳しい情報や手順を伝えます。スクリーンリーダーのユーザーにも公開されます。
`disabled`	`boolean`	フィールドを無効にし、あらゆる操作を受け付けないようにします。
`error`	`any`	ユーザーにエラーを示します。すぐに解決する必要がある問題を伝えるため、フィールドに特定のスタイルが適用されます。
`id`	`string`	要素の一意な識別子です。
`label`	`any`	フィールドのラベルとして使用するコンテンツです。
`labelAccessibilityVisibility`	`"visible" \| "exclusive"`	コンポーネントのラベルの表示状態を変更します。 - `visible`: ラベルはすべてのユーザーに表示されます。 - `exclusive`: ラベルは視覚的に非表示になりますが、アクセシビリティツリーには残ります。
`name`	`string`	最も近い親のフォーム内で一意となる、フィールドの識別子です。
`placeholder`	`string`	フィールドに期待される値を説明する短いヒントです。
`readOnly`	`boolean`	ユーザーはフィールドを編集できません。フォーカスは可能で、スクリーンリーダーによって読み上げられます。
`required`	`boolean`	フィールドに値が必要かどうか。この要件はフィールドにセマンティックな意味を加えますが、エラーが自動的に表示されるわけではありません。このフィールドが空のときにエラーを表示したい場合は、`error` プロパティを使用してください。
`value`	`string`	フィールドの現在の値です。省略した場合、フィールドは空になります。

Events

Event	型
`blur`	`FocusEvent`
`change`	`Event`
`focus`	`FocusEvent`
`input`	`Event`

これらのイベントは <SColorField> 上で @blur 形式のリスナーで受け取れます。

Slots

Slot	説明
`details`
`error`

SColorField <s-color-field> ​

ベストプラクティス ​

例 ​

v-model ​

Props ​

Events ​

Slots ​