Install | Containercloud

Integrated platform for collaborative coding, testing & deploying containerized apps

Getting Started on AppsCode with GO

A .Paginator is provided to help building a pager menu. This is only relevant for the templates for the home page and the list pages (sections and taxonomies).

There are two ways to configure and use a .Paginator:

  1. The simplest way is just to call .Paginator.Pages from a template. It will contain the pages for that page .
  2. Select a sub-set of the pages with the available template functions and ordering options, and pass the slice to .Paginate, e.g. {{ range (.Paginate ( first 50 .Data.Pages.ByTitle )).Pages }}.

For a given Node, it’s one of the options above. The .Paginator is static and cannot change once created.

The global page size setting (Paginate) can be overridden by providing a positive integer as the last argument. The examples below will give five items per page:

  • {{ range (.Paginator 5).Pages }}
  • {{ $paginator := .Paginate (where .Data.Pages "Type" "post") 5 }}

It is also possible to use the GroupBy functions in combination with pagination:

{{ range (.Paginate (.Data.Pages.GroupByDate "2006")).PageGroups  }}

Build the navigation

The .Paginator contains enough information to build a paginator interface.

The easiest way to add this to your pages is to include the built-in template (with Bootstrap-compatible styles):

{{ template "_internal/pagination.html" . }}

Note: If you use any filters or ordering functions to create your .Paginator and you want the navigation buttons to be shown before the page listing, you must create the .Paginator before it’s used:

{{ $paginator := .Paginate (where .Data.Pages "Type" "post") }}
{{ template "_internal/pagination.html" . }}
{{ range $paginator.Pages }}
   {{ .Title }}
{{ end }}

Without the where-filter, the above is simpler:

{{ template "_internal/pagination.html" . }}
{{ range .Paginator.Pages }}
   {{ .Title }}
{{ end }}

If you want to build custom navigation, you can do so using the .Paginator object:

  • PageNumber: The current page’s number in the pager sequence
  • URL: The relative URL to the current pager
  • Pages: The pages in the current pager
  • NumberOfElements: The number of elements on this page
  • HasPrev: Whether there are page(s) before the current
  • Prev: The pager for the previous page
  • HasNext: Whether there are page(s) after the current
  • Next: The pager for the next page
  • First: The pager for the first page
  • Last: The pager for the last page
  • Pagers: A list of pagers that can be used to build a pagination menu
  • PageSize: Size of each pager
  • TotalPages: The number of pages in the paginator
  • TotalNumberOfElements: The number of elements on all pages in this paginator

Additional information

The pages are built on the following form (BLANK means no value):

[SECTION/TAXONOMY/BLANK]/index.html
[SECTION/TAXONOMY/BLANK]/page/1/index.html => redirect to  [SECTION/TAXONOMY/BLANK]/index.html
[SECTION/TAXONOMY/BLANK]/page/2/index.html
....

Subscribe to our free technical newsletter!

Join thousands of subscribers and stay up-to-date on AppsCode.