> For the complete documentation index, see [llms.txt](https://partners.tray.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://partners.tray.com.br/themes/construindo-seu-template/referencias/objetos/settings.md).

# settings

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

{% hint style="info" %}
**Disponível para uso em todas as páginas.** Variáveis personalizadas devem ser inseridas no arquivo *settings.json* para correto funcionamento.
{% endhint %}

## Variáveis de configuração personalizadas <a href="#ir-para-variaveis-definidas-no-customizador" id="ir-para-variaveis-definidas-no-customizador"></a>

Para utilizar o objeto `settings` que recebe como parâmetro as variáveis definidas no arquivo [***settings.json***](/themes/construindo-seu-template/editor-do-tema/settings-json.md), deve-se utilizar no código HTML da seguinte maneira:

```twig
{{ settings.meuparametro }}
```

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

{% code title="Input" %}

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

{% if settings.titulo %}
    O título é {{ settings.titulo }}
{% endif %}
```

{% endcode %}

{% code title="Output" %}

```html
Esta é a cor preta!

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

{% endcode %}

## Variáveis de configuração padrões da Loja <a href="#ir-para-variaveis-definidas-nas-configuracoes-da-loja" id="ir-para-variaveis-definidas-nas-configuracoes-da-loja"></a>

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​ <a href="#atributos-disponiveis" id="atributos-disponiveis"></a>

<table><thead><tr><th width="273.9947408808268">Atributos</th><th>Característica</th></tr></thead><tbody><tr><td><code>{{ settings.show_product_stock }}</code></td><td>Verifica se está configurado na plataforma para "Exibir quantidade do estoque na página do produto". Retorna o valor 1 quando verdadeiro.</td></tr><tr><td><code>{{ settings.purchase_limit_show_quantity }}</code></td><td>Verifica se está configurado para <a href="https://basedeconhecimento.tray.com.br/hc/pt-br/articles/6733635475099-Limita%C3%A7%C3%A3o-de-Compra">Limitação de compras</a> por produto e se nessa limitação foi marcado para ser exibido o campo quantidade. Retorna o valor 1 quando verdadeiro.</td></tr><tr><td><code>{{ settings.show_shipping_simulator }}</code></td><td>Verifica se está configurado para "Exibir simulador de frete na página de produto". Retorna o valor 1 quando verdadeiro.</td></tr><tr><td><code>{{ settings.compare }}</code></td><td>Verifica se está configurado para "Habilitar função para comparar produtos". Retorna o valor 1 quando verdadeiro.</td></tr><tr><td><code>{{ settings.without_stock_sale }}</code></td><td>Verifica se está configurado para  "Permitir venda com estoque igual a 0 (zero) ou negativo". Retorna o valor 1 quando verdadeiro.</td></tr><tr><td><code>{{ settings.show_reference }}</code></td><td>Verifica se está configurado para  "Exibir campo referência nas páginas de produto e carrinho". Retorna o valor 1 quando verdadeiro.</td></tr><tr><td><code>{{ settings.show_release_date }}</code></td><td>Verifica se está configurado para "Exibir campo data de lançamento na página do produto"<strong>.</strong> Retorna o valor 1 quando verdadeiro.</td></tr><tr><td><code>{{ settings.new_release_title }}</code></td><td>Exibe o texto definido no campo "Título para a data de lançamento"<strong>.</strong></td></tr><tr><td><code>{{ settings.customers_waiting }}</code></td><td>Verifica se está configurado para "Habilitar opção avise-me quando chegar". Retorna o valor 1 quando verdadeiro.</td></tr><tr><td><code>{{ settings.international_shipping }}</code></td><td>Verifica qual o <a href="https://basedeconhecimento.tray.com.br/hc/pt-br/articles/6735863039259-Idioma-Moeda-e-Envio-Internacional-Configura%C3%A7%C3%A3o">tipo do envio</a> configurado na plataforma. Retorna 1 se  for "Somente internacional" e 2 caso seja "Nacional e internacional".</td></tr><tr><td><code>{{ settings.hide_warranty }}</code></td><td>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 <strong>não deve ser exibida</strong>.</td></tr><tr><td><code>{{ settings.show_product_warranty }}</code></td><td>Verifica se está configurado para "Exibir campo tempo de garantia na página do produto".  Retorna o valor 1 quando verdadeiro.</td></tr><tr><td><code>{{ settings.show_related_product }}</code></td><td>Verifica se não está configurado para "Completar produtos relacionados com produtos semelhantes usando busca inteligente". Retorna o valor 1 quando verdadeiro.</td></tr><tr><td><code>{{ settings.variant_layout }}</code></td><td>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" <code>1</code> , "Lista fechada das variações" <code>2</code> , "Lista aberta, acima de 10 variações altera para lista fechada" <code>4</code>.</td></tr><tr><td><code>{{ settings.show_variant_price }}</code></td><td>Verifica se está configurado para "Exibir preço das variações no produto". Retorna o valor 1 quando verdadeiro.</td></tr><tr><td><code>{{ settings.payment_method_option }}</code></td><td>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" <code>1</code>,  "Ícones" <code>2</code>.</td></tr><tr><td><code>{{ settings.mandatory_variant }}</code></td><td>Retorna verdadeiro caso seja obrigatório selecionar ao menos uma variação.</td></tr><tr><td><code>{{ settings.show_product_brand }}</code></td><td>Verifica se está configurado para "Exibir campo marca na página do produto e carrinho". Retorna o valor 1 quando verdadeiro.</td></tr><tr><td><code>{{ settings.zoom_width }}</code></td><td>Retorna o valor da largura do zoom definido para as imagens do Produto nas <a href="https://basedeconhecimento.tray.com.br/hc/pt-br/articles/6733511040283-Zoom-Nas-Imagens-dos-Produtos">configurações.</a></td></tr><tr><td><code>{{ settings.zoom_height }}</code></td><td>Retorna o valor da altura do zoom definido para as imagens do Produto nas <a href="https://basedeconhecimento.tray.com.br/hc/pt-br/articles/6733511040283-Zoom-Nas-Imagens-dos-Produtos">configurações.</a></td></tr><tr><td><code>{{ settings.vertical_zoom }}</code></td><td>Retorna o valor da "Distância Vertical da Imagem" definido para o zoom das imagens do Produto nas <a href="https://basedeconhecimento.tray.com.br/hc/pt-br/articles/6733511040283-Zoom-Nas-Imagens-dos-Produtos">configurações.</a></td></tr><tr><td><code>{{ settings.horizontal_zoom }}</code></td><td>Retorna o valor da "Distância Horizontal da Imagem" definido para o zoom das imagens do Produto nas <a href="https://basedeconhecimento.tray.com.br/hc/pt-br/articles/6733511040283-Zoom-Nas-Imagens-dos-Produtos">configurações.</a></td></tr><tr><td><code>{{ settings.zoom_position }}</code></td><td>Retorna o valor definido para "Posição do Zoom" nas <a href="https://basedeconhecimento.tray.com.br/hc/pt-br/articles/6733511040283-Zoom-Nas-Imagens-dos-Produtos">configurações.</a> Valores possíveis: <strong><code>left</code></strong> | <strong><code>rigth</code></strong></td></tr><tr><td><code>{{ settings.default_image_zoom_height }}</code></td><td>Retorna o valor definido para "Altura da Imagem Padrão (sem zoom)" nas <a href="https://basedeconhecimento.tray.com.br/hc/pt-br/articles/6733511040283-Zoom-Nas-Imagens-dos-Produtos">configurações.</a></td></tr><tr><td><code>{{ settings.default_image_zoom_width }}</code></td><td>Retorna o valor definido para "Largura da Imagem Padrão (sem zoom)" nas <a href="https://basedeconhecimento.tray.com.br/hc/pt-br/articles/6733511040283-Zoom-Nas-Imagens-dos-Produtos">configurações.</a></td></tr><tr><td><code>{{ settings.currency }}</code></td><td>Verifica qual a configuração ativa da "Moeda". Valores possíveis: <strong><code>R$</code></strong> | <strong><code>US$</code></strong></td></tr><tr><td><code>{{ settings.history_position }}</code></td><td>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é".</td></tr><tr><td><code>{{ settings.hottags_position }}</code></td><td>Retorna 1 para "Exibir abaixo do rodapé" e 2 para "Exibir acima do Rodapé".</td></tr><tr><td><code>{{ settings.social_position }}</code></td><td>Verifica qual a configuração ativa do "Local de apresentação" das <a href="https://basedeconhecimento.tray.com.br/hc/pt-br/articles/6742808616475-Redes-Sociais-Configura%C3%A7%C3%A3o">Redes sociais.</a> Valores retornados para cada opção: "Exibir Abaixo da foto do produto" <strong><code>0</code></strong>, "Exibir abaixo do botão Comprar" <strong><code>1</code></strong>. </td></tr><tr><td><code>{{ settings.show_description }}</code></td><td>Retorna verdadeiro caso a descrição do produto deve ser exibida.</td></tr><tr><td><code>{{ settings.currency_abbr }}</code></td><td>Verifica qual a Moeda ativa e exibe o código de abreviação dessa moeda. Valores possíveis: <code>BRL</code> | <code>USS</code></td></tr></tbody></table>