# paginate

O Objeto `paginate` retorna um helper de paginação de produtos.

{% hint style="warning" %}
**Disponível para uso nas páginas:** catalog | search
{% endhint %}

### Atributos disponíveis​ <a href="#atributos-disponiveis" id="atributos-disponiveis"></a>

| Atributos                         | Características                                                                                                                                                                                        |
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `{{ paginate.params.pageCount }}` | Exibe a quantidade de páginas existentes na seção                                                                                                                                                      |
| `{{ paginate.numbers() }}`        | Retorna vários números para o conjunto de resultados paginados usando um módulo para decidir quantos números mostrar em cada lado da página atual Passando entre parênteses os parâmetros necessários. |
| `{{ paginate.first() }}`          | Gera um link único para a primeira página ou um conjunto das primeiras páginas.                                                                                                                        |
| `{{ paginate.last() }}`           | Gera um link único para a última página ou conjunto das últimas páginas                                                                                                                                |
| `{{ paginate.hasPrev }}`          | Retorna verdadeiro se o conjunto de resultados fornecidos não estiver na primeira página.                                                                                                              |
| `{{ paginate.prev() }}`           | Gera um link "anterior" para um conjunto de páginas.                                                                                                                                                   |
| `{{ paginate.hasNext }}`          | Retorna verdadeiro se o conjunto de resultados fornecidos não estiver na última página                                                                                                                 |
| `{{ paginate.next() }}`           | Gera um link "próximo" para um conjunto de páginas.                                                                                                                                                    |

## Como Usar

Para utilizar um **snippet pronto padrão**, utilize a chamada no código conforme exemplo abaixo. Dessa forma será exibido a paginação sem a necessidade de editar ou criar um arquivo específico para paginação.

{% code title="Input" %}

```twig
{{ element('snippets/pagination') }}
```

{% endcode %}

{% code title="Output" %}

```twig
Resultado 100 Produtos em 3 páginas
```

{% endcode %}

Para uma paginação personalizada do seu jeito utilize como exemplo o **snippet** abaixo:

{% content-ref url="../componentes/paginacao" %}
[paginacao](https://partners.tray.com.br/themes/construindo-seu-template/referencias/componentes/paginacao)
{% endcontent-ref %}

{% hint style="info" %}
Se quiser mais informações, visite a [documentação oficial do Helper Paginator](http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html).
{% endhint %}