Pular para o conteúdo principal
O schema define as opções de personalização que aparecem no painel. Assim o dono da loja ajusta cores, textos e imagens sem editar código. O arquivo é config/settings_schema.json.
Os temas Vega, Orion, Altair e Lyra (e os forks deles) usam, no painel, o schema mantido pela AllBay para aquele tema. Rigel, Sirius e Antares usam o próprio config/settings_schema.json.

Estrutura

  • Cada grupo tem title (ou name) e fields (ou settings).
  • Cada campo tem key (ou id), label, type, e opcionalmente description e default.
  • Limites: 50 grupos, 200 campos, 100 opções por select.

Chaves dos campos

A key precisa começar com letra e usar só letras, números e _ (até 64 caracteres).
Hífen não é permitido. Um campo com "key": "primary-color" é ignorado. Use primary_color.

Acessando os valores

Os valores ficam no global config (e em settings), com a mesma chave do campo:
Um campo sem valor usa o default — desde que o tema tenha o próprio config/settings_schema.json. Sem esse arquivo, os valores chegam como foram salvos; use | default: no Liquid. Imagens já chegam como URL pronta (ver Imagens).

Tipos de campo

textarea hoje não aceita quebras de linha. Para textos com parágrafos, use wysiwyg.

array

Cada item tem até 20 campos, dos tipos text, checkbox, number, select, color, url, image e products. max_items: padrão 50, máximo 200.
Um campo image dentro de um item de array hoje não pode ser exibido no tema. Use campos image/images no primeiro nível do schema.

Exemplo com vários campos

Validação

O servidor valida cada valor pelo tipo: color só aceita #RRGGBB, select só aceita as options, number respeita min/max, url não aceita javascript:. Valores inválidos ou chaves que não existem no schema são recusados, com a lista de erros.