LogoLogo
Documentação de Temas
Documentação de Temas
  • 🚀COMECE POR AQUI
    • Temas Tray
    • Entenda o Tema
    • Meu primeiro tema
  • 💻Tray CLI
    • Instalação
    • Comandos
      • Erros Retornados
    • API para integrações Tray CLI
  • 🧱Construindo seu Template
    • Twig
      • O que é o Twig
      • Como ele é utilizado nos temas
      • Possibilidades de uso
      • Documentação para consulta
    • Visão Geral
      • Estrutura do Tema
      • Arquivo de configuração
      • Extensões de arquivos
      • Codificação de Arquivos
      • Avisos e Recomendações
      • Flags
    • Editor do Tema
      • Antigo
        • Como criar um Editor
        • Settings.html
      • Novo
        • Estrutura
          • Seções
          • Ícones
          • Componentes
            • Text
            • Textarea
            • Email
            • Number
            • Color
            • Checkbox
            • Radio
            • Select
            • Toggle
            • Upload
            • Tab
            • Alert
          • Exemplo de utilização
        • Thumb preview do tema
        • Imagens padrões
        • Como desabilitar e reabilitar?
      • Settings.json
    • Desenvolver
      • Atributo Google Analytics 4
      • Como adicionar o botão comprar na listagem dos produtos
      • Como criar um carrossel de produtos
      • Como inserir um vídeo na home da loja
      • Como manipular as variações de produtos
      • Como saber se o usuário está logado
      • Descontinuação do carrinho.php
      • Exibindo as formas de pagamento de um produto
      • Informação de preço com tempo de cache menor
      • Order Bump - Produtos Relacionados
      • Páginas Institucionais
      • Página de recuperação de senha
      • Página Live Shop
      • Recursos extras
      • Personalização das paginas de carrinho e checkout
    • Core Web Vitals
      • Desempenho
        • Lazyload
        • Primeira dobra
        • Fontes
        • Definição largura e altura
        • Sprite formas de pagamentos
      • Boas Práticas
        • Origem cruzada
      • Acessibilidade
        • Atributo Lang
        • Nome discernível
        • Atributo ALT
        • Contraste
        • IDs únicos
        • ARIA Labelled By
        • Tabindex
    • Otimizar e Medir
      • Carregamento na home
      • Layout AMP
      • Utilizando PWA na loja
    • Referências
      • Objetos
        • banner
        • breadcrumb
        • category
        • categories
        • filters
        • filter_options
        • links
        • pages
        • paginate
        • paymentMethods
        • product
        • productTabs
        • products
        • productFeatured
        • seals
        • search
        • settings
        • store
        • tags
        • tray
        • themePath
        • utils
      • Funções
        • asset()
        • Brands()
        • Categories()
        • Image()
        • Products()
        • Translation()
      • Data Attributes
        • Banners
        • Cart
        • Compare
        • Filter
        • Logged User
        • Search (Suggestion)
      • Componentes
        • Adicionar ao carrinho sem sair da página
        • Banner Desconto Progressivo
        • Banner extra com contagem de cliques
        • Banner Régua
        • Banner Rotativo
        • Botão "Voltar para o topo"
        • Botões Quantidade
        • Carrinho Lateral
        • Exibir a segunda imagem ao passar o mouse
        • Filtro Inteligente
        • Link flutuante para Whatsapp
        • Menu de Categorias
        • Menu de Categorias em 3 Níveis
        • Menu de Categorias com ver mais categorias
        • Menu de Categorias com Imagens
        • Menu de Categorias com Imagens - Hover
        • Menu de Categorias com produto
        • Menu de Marcas
        • Modal de Ofertas
        • Notícias com imagem na home
        • Novo Filtro Inteligente
        • Paginação
        • Porcentagem Desconto
        • Popup de Newsletter
        • Star Ranking
        • Selos da Loja
        • Selos do produto
        • Showcase ( List / Grid )
        • Topo Flutuante
        • Tray Login
        • Whatsapp flutuante
    • APIs Disponíveis
      • Busca
      • Carrinho de Compra
      • Categorias
      • Produtos
      • Variações de Produto
  • ✔️Homologação
    • Loja de Temas Tray
    • Requerimentos
      • Exclusividade
      • Identidade única
      • Estrutura necessária
      • Funcionalidades
      • Nova Busca e Filtro inteligente
      • Selos de produtos
      • Google Lighthouse
      • Consistência e funcionalidade
      • Compatibilidade com navegadores
      • Assets
      • Otimização para buscadores (SEO)
      • Acessibilidade
      • Configurações
      • Sistema de cores
      • Imagens responsivas
      • Nomes dos temas
      • Versionamento e notas de lançamento
      • Lojas demonstrativas
      • Documentação e suporte
    • Checklist obrigatório
    • Templates
    • Homologando o tema
    • Atualizando o tema
    • FAQ
  • 📣NOVIDADES
    • Tray CLI
    • Checklist
    • Tema Draft
    • Novo Editor
Powered by GitBook
On this page
  • Variáveis de configuração personalizadas
  • Variáveis de configuração padrões da Loja
  • Atributos disponíveis​

Was this helpful?

  1. Construindo seu Template
  2. Referências
  3. Objetos

settings

PrevioussearchNextstore

Last updated 2 years ago

Was this helpful?

O objeto settings é responsável por refletir algumas configurações da área administrativa e do customizador do tema.

Disponível para uso em todas as páginas. Variáveis personalizadas devem ser inseridas no arquivo settings.json para correto funcionamento.

Variáveis de configuração personalizadas

Para utilizar o objeto settings que recebe como parâmetro as variáveis definidas no arquivo , deve-se utilizar no código HTML da seguinte maneira:

{{ settings.meuparametro }}

Dessa forma é possível utilizá-lo para criar condicionais ou atribuir valores para preenchimento de informações. Exemplo:

Input
{% if settings.cor == '#000' %}
    Esta é a cor preta!
{% endif %}

{% if settings.titulo %}
    O título é {{ settings.titulo }}
{% endif %}
Output
Esta é a cor preta!

O título é Seção de destaque!

Variáveis de configuração padrões da Loja

Também é possível com o objeto settings obter o valor de configurações definidas na plataforma para utilizá-las no tema, como apresentado na tabela de atributos abaixo.

Atributos disponíveis​

Atributos
Característica

{{ settings.show_product_stock }}

Verifica se está configurado na plataforma para "Exibir quantidade do estoque na página do produto". Retorna o valor 1 quando verdadeiro.

{{ settings.purchase_limit_show_quantity }}

{{ settings.show_shipping_simulator }}

Verifica se está configurado para "Exibir simulador de frete na página de produto". Retorna o valor 1 quando verdadeiro.

{{ settings.compare }}

Verifica se está configurado para "Habilitar função para comparar produtos". Retorna o valor 1 quando verdadeiro.

{{ settings.without_stock_sale }}

Verifica se está configurado para "Permitir venda com estoque igual a 0 (zero) ou negativo". Retorna o valor 1 quando verdadeiro.

{{ settings.show_reference }}

Verifica se está configurado para "Exibir campo referência nas páginas de produto e carrinho". Retorna o valor 1 quando verdadeiro.

{{ settings.show_release_date }}

Verifica se está configurado para "Exibir campo data de lançamento na página do produto". Retorna o valor 1 quando verdadeiro.

{{ settings.new_release_title }}

Exibe o texto definido no campo "Título para a data de lançamento".

{{ settings.customers_waiting }}

Verifica se está configurado para "Habilitar opção avise-me quando chegar". Retorna o valor 1 quando verdadeiro.

{{ settings.international_shipping }}

{{ settings.hide_warranty }}

Verifica se não está configurado para "Exibir a aba de garantia na página do produto". Retorna o valor 1 verdadeiro quando a aba não deve ser exibida.

{{ settings.show_product_warranty }}

Verifica se está configurado para "Exibir campo tempo de garantia na página do produto". Retorna o valor 1 quando verdadeiro.

{{ settings.show_related_product }}

Verifica se não está configurado para "Completar produtos relacionados com produtos semelhantes usando busca inteligente". Retorna o valor 1 quando verdadeiro.

{{ settings.variant_layout }}

Verifica qual a configuração ativa do "Layout para exibir as variações na página do produto." Valores retornados para cada opção: "Lista aberta das variações" 1 , "Lista fechada das variações" 2 , "Lista aberta, acima de 10 variações altera para lista fechada" 4.

{{ settings.show_variant_price }}

Verifica se está configurado para "Exibir preço das variações no produto". Retorna o valor 1 quando verdadeiro.

{{ settings.payment_method_option }}

Verifica qual a configuração ativa do "Modelo de exibição das formas de pagamento na página do produto (aba formas de pagamento)". Valores retornados para cada opção: "Lista Aberta" 1, "Ícones" 2.

{{ settings.mandatory_variant }}

Retorna verdadeiro caso seja obrigatório selecionar ao menos uma variação.

{{ settings.show_product_brand }}

Verifica se está configurado para "Exibir campo marca na página do produto e carrinho". Retorna o valor 1 quando verdadeiro.

{{ settings.zoom_width }}

{{ settings.zoom_height }}

{{ settings.vertical_zoom }}

{{ settings.horizontal_zoom }}

{{ settings.zoom_position }}

{{ settings.default_image_zoom_height }}

{{ settings.default_image_zoom_width }}

{{ settings.currency }}

Verifica qual a configuração ativa da "Moeda". Valores possíveis: R$ | US$

{{ settings.history_position }}

Define onde será exibido o Histórico de Navegação na página de produto. Retorna 1 para "Exibir acima do Rodapé" e 2 para "Exibir abaixo do rodapé".

{{ settings.hottags_position }}

Retorna 1 para "Exibir abaixo do rodapé" e 2 para "Exibir acima do Rodapé".

{{ settings.social_position }}

{{ settings.show_description }}

Retorna verdadeiro caso a descrição do produto deve ser exibida.

{{ settings.currency_abbr }}

Verifica qual a Moeda ativa e exibe o código de abreviação dessa moeda. Valores possíveis: BRL | USS

Verifica se está configurado para por produto e se nessa limitação foi marcado para ser exibido o campo quantidade. Retorna o valor 1 quando verdadeiro.

Verifica qual o configurado na plataforma. Retorna 1 se for "Somente internacional" e 2 caso seja "Nacional e internacional".

Retorna o valor da largura do zoom definido para as imagens do Produto nas

Retorna o valor da altura do zoom definido para as imagens do Produto nas

Retorna o valor da "Distância Vertical da Imagem" definido para o zoom das imagens do Produto nas

Retorna o valor da "Distância Horizontal da Imagem" definido para o zoom das imagens do Produto nas

Retorna o valor definido para "Posição do Zoom" nas Valores possíveis: left | rigth

Retorna o valor definido para "Altura da Imagem Padrão (sem zoom)" nas

Retorna o valor definido para "Largura da Imagem Padrão (sem zoom)" nas

Verifica qual a configuração ativa do "Local de apresentação" das Valores retornados para cada opção: "Exibir Abaixo da foto do produto" 0, "Exibir abaixo do botão Comprar" 1.

🧱
settings.json
Limitação de compras
tipo do envio
configurações.
configurações.
configurações.
configurações.
configurações.
configurações.
configurações.
Redes sociais.