Skip to content

SColorField <s-color-field> ​

Um campo de texto para inserir um valor de cor, com um canal alfa opcional. SColorField é o wrapper de Vue 3 tipado do web component <s-color-field> do Shopify Polaris.

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

Boas práticas ​

  • Diga para que serve a cor. Use um label como "Cor de fundo do botão" ou "Cor do texto do título" em vez de um genérico "Cor".
  • Mostre a cor atual ao editar. Defina value com a cor existente para que os lojistas vejam o que estão alterando.
vue
<SColorField label="Button background color" value="#1a1a1a" />

Veja as boas práticas da Shopify para <s-color-field> (em inglês) para todas as recomendações.

Exemplo ​

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 ​

v-model em <SColorField> se vincula à propriedade value e escuta o event DOM input.

template
<SColorField v-model="value" />

equivale a:

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

Props ​

PropTipoDescrição
alphabooleanPermite que o usuário selecione um valor alfa.
autocomplete"on" | "off"Uma indicação sobre o conteúdo esperado do campo. Quando definida como on (o padrão), esta propriedade indica que o campo deve oferecer suporte ao preenchimento automático, mas você não tem mais informações semânticas sobre o conteúdo esperado. Quando definida como off, você indica que este campo contém informações confidenciais ou conteúdo que nunca é salvo, como códigos de uso único. Como alternativa, você pode fornecer um valor que descreva os dados específicos que deseja que sejam inseridos neste campo durante o preenchimento automático.
defaultValuestringO valor padrão do campo.
detailsanyTexto adicional que oferece contexto ou orientação sobre o campo. Esse texto é exibido junto com o campo e seu rótulo para oferecer mais informações ou instruções ao usuário. Ele também é exposto aos usuários de leitores de tela.
disabledbooleanDesativa o campo, impedindo qualquer interação.
erroranyIndica um erro ao usuário. O campo recebe um tratamento visual específico para comunicar problemas que precisam ser resolvidos imediatamente.
idstringUm identificador exclusivo para o elemento.
labelanyConteúdo usado como rótulo do campo.
labelAccessibilityVisibility"visible" | "exclusive"Altera a visibilidade do rótulo do componente. - visible: o rótulo fica visível para todos os usuários. - exclusive: o rótulo fica visualmente oculto, mas permanece na árvore de acessibilidade.
namestringUm identificador do campo que é exclusivo dentro do formulário contêiner mais próximo.
placeholderstringUma breve indicação que descreve o valor esperado do campo.
readOnlybooleanO campo não pode ser editado pelo usuário. Ele pode receber foco e é anunciado pelos leitores de tela.
requiredbooleanSe o campo exige um valor. Este requisito adiciona valor semântico ao campo, mas não faz um erro aparecer automaticamente. Se quiser exibir um erro quando este campo estiver vazio, você pode fazer isso com a propriedade error.
valuestringO valor atual do campo. Se omitido, o campo ficará vazio.

Events ​

EventTipo
blurFocusEvent
changeEvent
focusFocusEvent
inputEvent

Escute-os com listeners no estilo @blur em <SColorField>.

Slots ​

SlotDescrição
details
error

Lançado sob a licença MIT. Logo do Vue por Evan You, CC BY-NC-SA 4.0.