mirror of
https://github.com/gohugoio/hugo.git
synced 2024-12-01 18:00:47 -05:00
46 lines
1.9 KiB
Markdown
46 lines
1.9 KiB
Markdown
---
|
|
title: Paginator
|
|
description: Paginates the collection of regular pages received in context.
|
|
categories: []
|
|
keywords: []
|
|
action:
|
|
related:
|
|
- methods/page/Paginate
|
|
returnType: page.Pager
|
|
signatures: [PAGE.Paginator]
|
|
---
|
|
|
|
[Pagination] is the process of splitting a list page into two or more pagers, where each pager contains a subset of the page collection and navigation links to other pagers.
|
|
|
|
The number of elements on each pager is determined by your [site configuration]. The default is `10`.
|
|
|
|
[site configuration]: /getting-started/configuration/#pagination
|
|
|
|
You can invoke pagination on the [home template], [section templates], [taxonomy templates], and [term templates]. Each of these receives a collection of regular pages in [context]. When you invoke the `Paginator` method, it paginates the page collection received in context.
|
|
|
|
[home template]: /templates/types/#home
|
|
[section templates]: /templates/types/#section
|
|
[taxonomy templates]: /templates/types/#taxonomy
|
|
[term templates]: /templates/types/#term
|
|
[context]: /getting-started/glossary/#context
|
|
|
|
{{< code file=layouts/_default/list.html >}}
|
|
{{ range .Paginator.Pages }}
|
|
<h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
|
|
{{ end }}
|
|
{{ template "_internal/pagination.html" . }}
|
|
{{< /code >}}
|
|
|
|
In the example above, the embedded pagination template creates navigation links between pagers.
|
|
|
|
{{% note %}}
|
|
Although simple to invoke, with the `Paginator` method you can neither filter nor sort the page collection. It acts upon the page collection received in context.
|
|
|
|
The [`Paginate`] method is more flexible, and strongly recommended.
|
|
|
|
[`paginate`]: /methods/page/paginate/
|
|
{{% /note %}}
|
|
|
|
{{% note %}}
|
|
Please note that the results of pagination are cached. Once you have invoked either the `Paginator` or `Paginate` method, the paginated collection is immutable. Additional invocations of these methods will have no effect.
|
|
{{% /note %}}
|