aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/content/en/methods/pager/TotalPages.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/methods/pager/TotalPages.md')
-rw-r--r--docs/content/en/methods/pager/TotalPages.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/docs/content/en/methods/pager/TotalPages.md b/docs/content/en/methods/pager/TotalPages.md
new file mode 100644
index 000000000..e305beeff
--- /dev/null
+++ b/docs/content/en/methods/pager/TotalPages.md
@@ -0,0 +1,41 @@
+---
+title: TotalPages
+description: Returns the number of pagers in the pager collection.
+categories: []
+keywords: []
+action:
+ related:
+ - methods/pager/PageNumber
+ - methods/page/Paginate
+ returnType: int
+ signatures: [PAGER.TotalPages]
+---
+
+Use the `TotalPages` method to build navigation between pagers.
+
+```go-html-template
+{{ $pages := where site.RegularPages "Type" "posts" }}
+{{ $paginator := .Paginate $pages }}
+
+{{ range $paginator.Pages }}
+ <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
+{{ end }}
+
+{{ with $paginator }}
+ <p>Pager {{ .PageNumber }} of {{ .TotalPages }}</p>
+ <ul>
+ {{ with .First }}
+ <li><a href="{{ .URL }}">First</a></li>
+ {{ end }}
+ {{ with .Prev }}
+ <li><a href="{{ .URL }}">Previous</a></li>
+ {{ end }}
+ {{ with .Next }}
+ <li><a href="{{ .URL }}">Next</a></li>
+ {{ end }}
+ {{ with .Last }}
+ <li><a href="{{ .URL }}">Last</a></li>
+ {{ end }}
+ </ul>
+{{ end }}
+```