---
url: https://developer.youcan.shop/themes/objects/paginate.md
---
# Paginate

Information about the pages inside a set of [paginate tags](../tags/paginate.md).

## Properties

| Name             | Type                                                   | Description                                             |
| ---------------- | ------------------------------------------------------ | ------------------------------------------------------- |
| `current_page`   | [number](../basics/types#number)                       | Current page, starting at 1                             |
| `current_offset` | [number](../basics/types#number)                       | Number of items before the current page                 |
| `items`          | [number](../basics/types#number)                       | Total number of items in the list                       |
| `page_size`      | [number](../basics/types#number)                       | Number of items per page                                |
| `pages`          | [number](../basics/types#number)                       | Number of pages                                         |
| `page_param`     | [string](../basics/types#string)                       | Query parameter that selects the page: `page`, or `page[<id>]` in the deprecated form |
| `previous`       | part                                                   | Link to the previous page, nil on the first page        |
| `next`           | part                                                   | Link to the next page, nil on the last page             |
| `parts`          | [array](../basics/types#array) of parts                | Links for page navigation, with `…` for skipped pages   |

A part has a `title`, a `url` and `is_link`. `is_link` is false for the current page and for `…`.

## Deprecated form

The [deprecated paginate form](../tags/paginate.md#deprecated-form) sets the `paginate` object and these variables:

| Name            | Type                                                  | Description                         |
| --------------- | ----------------------------------------------------- | ----------------------------------- |
| `previous_page` | [string](../basics/types#string)                      | URL of the previous page            |
| `next_page`     | [string](../basics/types#string)                      | URL of the next page                |
| `current`       | [number](../basics/types#number)                      | Current page                        |
| `total`         | [number](../basics/types#number)                      | Total items                         |
| `last`          | [number](../basics/types#number)                      | Last page                           |
| `has_more`      | [boolean](../basics/types#boolean)                    | Whether there are more pages        |
| `items`         | [array](../basics/types#array) of [products](product) | Items of the current page           |