---
updatedAt: 2025-11-13T21:15:11.000Z
agentTools:
  projectIndex: https://wakecommerce.readme.io/llms.txt
---

# components.json

O arquivo `components.json` é composto por um array de objetos que especificam detalhes de todos os componentes utilizáveis na construção do site.

Este objeto é composto pelos seguintes atributos:

<Table align={["left","left","left","left"]}>
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>
        Atributo
      </th>

      <th style={{ textAlign: "left" }}>
        Tipo
      </th>

      <th style={{ textAlign: "left" }}>
        Obrigatório
      </th>

      <th style={{ textAlign: "left" }}>
        Descrição
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td style={{ textAlign: "left" }}>
        name
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        Sim
      </td>

      <td style={{ textAlign: "left" }}>
        Nome pelo qual o componente será chamado
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        path
      </td>

      <td style={{ textAlign: "left" }}>
        string
      </td>

      <td style={{ textAlign: "left" }}>
        Sim
      </td>

      <td style={{ textAlign: "left" }}>
        Caminho do arquivo *html* dentro da pasta **Components**
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        params
      </td>

      <td style={{ textAlign: "left" }}>
        array de object
      </td>

      <td style={{ textAlign: "left" }}>
        Não
      </td>

      <td style={{ textAlign: "left" }}>
        Parâmetros passados para uso dentro do componente
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        inheritVariables
      </td>

      <td style={{ textAlign: "left" }}>
        bool
      </td>

      <td style={{ textAlign: "left" }}>
        Não
      </td>

      <td style={{ textAlign: "left" }}>
        Deve herdar as variáveis disponíveis na página ou outro componente que chame este componente. Se não definido, seu valor padrão é *false*
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        availableInAllPages
      </td>

      <td style={{ textAlign: "left" }}>
        bool
      </td>

      <td style={{ textAlign: "left" }}>
        Não
      </td>

      <td style={{ textAlign: "left" }}>
        Deve ser disponível para chamada em todas as páginas. Se não definido, seu valor padrão é *false*
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        availableInAllComponents
      </td>

      <td style={{ textAlign: "left" }}>
        bool
      </td>

      <td style={{ textAlign: "left" }}>
        Não
      </td>

      <td style={{ textAlign: "left" }}>
        Deve ser disponível para chamada em todos os componentes. Se não definido, seu valor padrão é *false*
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        availableInPages
      </td>

      <td style={{ textAlign: "left" }}>
        array de string
      </td>

      <td style={{ textAlign: "left" }}>
        Não
      </td>

      <td style={{ textAlign: "left" }}>
        Nome do tipo de página onde será possível a chamada
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        availableInComponents
      </td>

      <td style={{ textAlign: "left" }}>
        array de string
      </td>

      <td style={{ textAlign: "left" }}>
        Não
      </td>

      <td style={{ textAlign: "left" }}>
        Nomes dos outros componentes onde será possível a chamada
      </td>
    </tr>
  </tbody>
</Table>

> ❗️ Atributo *inheritVariables*
>
> Recomendamos que seja marcado como *true* apenas quando for realmente necessário para uso dentro do componente. Senão prefira passar apenas os dados necessários por parâmetro, evitando excesso de dados descartados e melhor performance

No objeto *params* é definido o nome e a obrigatoriedade dos parâmetros, ambos necessários para o cadastro no componente:

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Atributo
      </th>

      <th>
        Tipo
      </th>

      <th>
        Descrição
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        name
      </td>

      <td>
        string
      </td>

      <td>
        Nome do parâmetro a ser usado dentro do componente
      </td>
    </tr>

    <tr>
      <td>
        required
      </td>

      <td>
        bool
      </td>

      <td>
        Define se o parâmetro é obrigatório para o funcionamento do componente
      </td>
    </tr>
  </tbody>
</Table>

## Exemplo de cadastro de um componente

```json components.json
[
    {
        "name": "banners_carousel",
        "path": "banners_carousel.html",
        "params": [
            {
                "name": "banners",
                "required": true
            },
            {
                "name": "position",
                "required": false
            }
        ],
        "availableInAllPages": true
    }
]
```

Neste exemplo foi cadastrado um componente com o nome *banners\_carousel*, implementado no arquivo *banners\_carousel.html* (localizado na pasta [Components](https://wakecommerce.readme.io/docs/components)), que recebe obrigatoriamente um parâmetro *banners* e opcionalmente um parâmetro *position*. Ele não herda nenhuma variável de quem o chama e é disponível para chamada em todas as páginas, mas não em outros componentes.

## Chamando um componente cadastrado

Na chamada em um arquivo *.html* utilize exatamente os nomes configurados para o componente e para os parâmetros:

```
{{ banners_carousel banners: data...banners position: "Topo" }}
```

Como resultado, esta chamada adiciona o trecho *html* implementado no arquivo do componente.