> 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/editor-do-tema/novo/estrutura/componentes/toggle.md).

# Toggle

O componente do tipo <mark style="color:blue;">toggle</mark> deve ser utilizado quando o criador do tema disponibiliza ao usuário a possibilidade dele ativar ou desativar determinada função dentro do tema. Abaixo é possível visualizar a aparência deste campo.

<figure><img src="https://799659513-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F30tSHvrN7e0UK3aUSC1K%2Fuploads%2F1W5lcnrnOSgkQiVnvhub%2Ftoggle_off.png?alt=media&amp;token=83e6a744-62f6-45f0-ba6d-9773a24fcb08" alt=""><figcaption><p><strong>Exibição do campo toggle</strong></p></figcaption></figure>

<figure><img src="https://799659513-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F30tSHvrN7e0UK3aUSC1K%2Fuploads%2F2Q9XgwADL1v9i8lxWtRt%2Fimage.png?alt=media&amp;token=53571338-593a-49fd-b17d-b824a2c2d9cf" alt=""><figcaption><p><strong>Exibição do campo toggle ativo</strong></p></figcaption></figure>

**Estrutura padrão do campo:**

{% code overflow="wrap" %}

```json
{
    "label": "Título do campo toogle", 
    "type": "toggle", 
    "description": "Descrição do campo de toogle.",
    "field": "nome_do_campo_toogle"
}
```

{% endcode %}

<table><thead><tr><th width="228">Atributo</th><th>Descrição</th></tr></thead><tbody><tr><td>label</td><td>Título do campo</td></tr><tr><td>type</td><td>Tipo do campo</td></tr><tr><td>description</td><td>Descrição do campo <br>Caso não houver, deixar vazio</td></tr><tr><td>field</td><td>Campo utilizado no tema para exibir o item desejado. <br>Esse nome deve ser exatamente igual ao campo criado no tema</td></tr></tbody></table>

{% hint style="danger" %}
Para funcionar corretamente, o campo deve ter o valor booleano **true** ou **false**. Se o toggle estiver habilitado será **true** e se estiver desabilitado será **false**. Por exemplo: ***`field_name: true`***
{% endhint %}