---
title: "paginate"
doc_type: static
doc_category: static
doc_version: v20270301
source_url:
html: 'https://developer.shopline.com/docs/sline/object/paginate'
md: 'https://developer.shopline.com/docs/sline/object/paginate.md'
---
# paginate
A set of pagination information, which can be used to build pagination navigation and display data on a page.
## Properties
array of [part](https://developer.shopline.com/docs/sline/object/part.md)]}
>
A list of pagination parts, used to build pagination navigation.
array of any]}
>
A list of data displayed on the current page.
integer]}
>
The total number of items displayed on all pages before the current page.
For example, if 5 items are displayed per page and the current page is page 3, the value of `paginate.current_offset` returns `10`.
integer]}
>
The page number of the current page.
integer]}
>
The total number of items displayed across all pages.
For example, if you paginate a collection of 120 products, the value of `paginate.items` returns `120`.
string]}
>
The URL parameter denoting the pagination.
Default value: `page`
integer]}
>
The number of items displayed per page.
integer]}
>
The total number of pages.
[part](https://developer.shopline.com/docs/sline/object/part.md)]}
>
The pagination part used to navigate to the previous page.
[part](https://developer.shopline.com/docs/sline/object/part.md)]}
>
The pagination part used to navigate to the next page.
## Example
The following example uses the [get_product_pagination](https://developer.shopline.com/docs/sline/filter/get-product-pagination.md) filter to get a set of products from a store. A `paginate` object is returned.
```sline
{{#var paginate = collection | get_product_pagination(5) /}}
{{#for product in paginate.list}}
{{#link_to product.url}}
{{product.title}}
{{/link_to}}
{{/for}}
```