liquid/_posts/objects/paginate.md

layout, title, nav

layout	title	nav
default	paginate	group Liquid Variables

paginate

The paginate tag's navigation is built using the attributes of the paginate object. You can also use the default_pagination filter for a quicker alternative.

{% block "note-information" %} The paginate object can only be used within paginate tags.
{% endblock %}

The paginate object has the following attributes:

{% table_of_contents %}

{% anchor_link "paginate.current_page", "paginate-current_page" %}

Returns the number of the current page.

{% anchor_link "paginate.current_offset", "paginate-current_offset" %}

Returns the total number of items that are on the pages previous to the current one. For example, if you are paginating by 5 and are on the third page, paginate.current_offset would return 10.

{% anchor_link "paginate.items", "paginate-items" %}

Returns the total number of items to be paginated. For example, if you are paginating a collection of 120 products, paginate.items would return 120.

{% anchor_link "paginate.parts", "paginate-parts" %}

Returns an array of all parts of the pagination. A part is a component used to build the navigation for the pagination.

{% anchor_link "paginate.next", "paginate-next" %}

Returns the part variable for the Next link in the pagination navigation.

Input

{% highlight html %}{% raw %} {% if paginate.next.is_link %} {{ paginate.next.title }} {% endif %} {% endraw %}{% endhighlight %}

Output

{% highlight html %}{% raw %} Next » {% endraw %}{% endhighlight %}

{% anchor_link "paginate.previous", "paginate-previous" %}

Returns the part variable for the Previous link in the pagination navigation.

Input

{% highlight html %}{% raw %} {% if paginate.previous.is_link %} {{ paginate.previous.title }} {% endif %} {% endraw %}{% endhighlight %}

Output

{% highlight html %}{% raw %} « Previous {% endraw %}{% endhighlight %}

{% anchor_link "paginate.page_size", "paginate-page_size" %}

Returns the number of items displayed per page.

{% anchor_link "paginate.pages", "paginate-pages" %}

Returns the number of pages created by the pagination tag.