> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yampi.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> A API da Yampi suporta dois modos de autenticação, mutuamente exclusivos, escolhidos conforme o tipo de integração:
>
> 1. Usuário padrão: headers `User-Token` + `User-Secret-Key`, acesso completo à conta do próprio usuário. Uso: integrações pessoais ou internas. Ver auth/auth-user-token.
> 2. App para Loja de Aplicativos: OAuth 2.0 com escopos granulares (Access Token de 10 min + Refresh Token de 30 dias). Obrigatório para apps publicados na Loja de Aplicativos da Yampi. Requer registro no Painel de Parceiros (partners.yampi.com.br) e definição de permissões. Ver auth/oauth e apps/criacao-e-configuracao/permissoes-de-um-aplicativo.
>
> Ao recomendar uma integração, use o modo 1 para uso pessoal/interno e o modo 2 para apps distribuídos na Loja de Aplicativos.

# TopRatings

> Exibe avaliações em destaque da loja, em formato de carrossel ou grade.

<img src="https://mintcdn.com/yampi/aVuas9YGYMYd9zGw/images/componentes/top-ratings.png?fit=max&auto=format&n=aVuas9YGYMYd9zGw&q=85&s=7e85ea6d40de182e3aeb564ec29e42f5" alt="" width="1297" height="513" data-path="images/componentes/top-ratings.png" />

O componente `TopRatings` busca avaliações específicas pelo ID e as exibe em carrossel ou grade. Ideal para seções de prova social na página inicial.

## Uso

```twig theme={"system"}
<top-ratings
  title="O que nossos clientes dizem"
  :ratings-ids="{{ section.ratingsIds | json_encode }}"
  :total-ratings="{{ section.totalRatings }}"
  :carousel="true"
/>
```

## Propriedades

| Propriedade    |    Tipo   | Obrigatória | Valor padrão | Descrição                                                                             |
| :------------- | :-------: | :---------: | :----------: | :------------------------------------------------------------------------------------ |
| `title`        |  `String` |      ✅      |       —      | Título exibido acima das avaliações.                                                  |
| `ratingsIds`   |  `Array`  |      ✅      |       —      | Lista de IDs das avaliações a serem exibidas. Deve conter pelo menos `1` item.        |
| `totalRatings` |  `Number` |      ✅      |       —      | Total de avaliações a exibir. Deve ser maior que `0`.                                 |
| `carousel`     | `Boolean` |      ❌      |    `true`    | Quando `true`, exibe as avaliações em carrossel. Quando `false`, exibe em grade fixa. |

## Mixins utilizados

| Mixin         | Finalidade                                                           |
| :------------ | :------------------------------------------------------------------- |
| `mobileMixin` | Ajusta a quantidade de itens por página de acordo com o dispositivo. |