colors.json

O arquivo colors.json contém um array de configuração de cores, para serem utilizados nos filtros laterais com nome Cor, ou em atributos com tipo de exibição configurado para 'DIV com cor'.

Este objeto é composto pelos seguintes atributos:

AtributoTipoObrigatórioDescrição
nameStringSimNome da cor
hexArray de stringSimConjunto de códigos hexadecimais de cores para compor a cor final. Colocando mais de uma cor caracteriza como um gradiente.
aliasStringNãoExpressão da cor buscada que dará match para utilizar a cor especificada. É possível utilizar:
- Palavra literal
- * (asterisk) para qualquer quantidade de caracteres digitados no início ou final do termo. Se utilizado sozinho pode funcionar como um valor padrão ao fim do json.
- | (pipe) para representar OU
- Mescla das regras acima

Exemplo:

[
    {
        "name": "branco",
        "hex": [
            "#FFFFFF"
        ],
        "alias": "agua|alabaster|branc*|cristal|crystal|cru|gelo|incolor|leite|marfi*|neblina|nevoa|palid*|pele|perola|platin*|transparent*|white"
    },
    {
        "name": "cinza",
        "hex": [
            "#c0c0c0"
        ],
        "alias" :"aco|alabaster|aluminio|chumbo|cinza|crom*|cza|ferro|fume|gelo|gray|grey|grafit*|marfi*|metal|neblina|nevoa|polido|prata|silver"
    },
    {
        "name": "amarelo",
        "hex": [
            "#ffff00"
        ],
        "alias": "abacaxi|alabaster|amarela|amarelo|ambar|banana|chama|creme|croco|dourad*|fire|gold|loir*|mang*|mostard*|ocre|ouro|pele|pera"
    },
    {
      	"name": "monocromatico,
      	"hex": [
        		"#000000", "#ffffff"
      	]
    },
    {
        "name": "default",
        "hex": [
            "#ffffff"
        ],
        "alias": "*"
    },
}

endpoint /colorhandler

O arquivo colors.json é utilizado na chamada para o endpoint "colorhandler" que retorna uma imagem da cor ou gradiente selecionado.

Parâmetros da query

ParâmetroTipoDescrição
cor | colorstringDefine as cores de retorno na imagem. Se passada mais de uma cor (separado por vírgula), o retorno será um gradiente
borderintDefine em pixels a quantidade de arredondamento das bordas.
rotacaointDefine o ângulo da rotação do gradiente, caso deseje apresentá-lo horizontalmente, por exemplo.
heightintA altura em pixels da imagem renderizada.
widthintA largura em pixels da imagem renderizada
gradientboolSe verdadeiro (padrão), a imagem terá um efeito de gradiente entre as cores fornecidas. Se definido como false, a imagem será renderizada com uma sequência sólida de cores, sem transições suaves.

Exemplo:

{{ store.urls.base }}/colorhandler?cor=amarelo,azul,vermelho&height=200&width=200&border=100

Exemplo cor sólida:

{{ store.urls.base }}/colorhandler?cor=azul,amarelo,verde&width=200&height=200&gradient=false

📘

Prioridade dos termos no arquivo colors.json

Termos mais acima serão priorizados pois serão encontrados primeiro.

O serviço de pesquisa procura inicialmente pelo parâmetro "name" sequencialmente. Caso não haja uma correspondência, é pesquisado então pelo parâmetro "alias", seguindo a mesma ordem de cima para baixo.

Caso não ache uma correspondência, o serviço retorna a cor padrão preto.