summaryrefslogtreecommitdiffstats
path: root/docs/content/en/methods/pager/PageGroups.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/methods/pager/PageGroups.md')
-rw-r--r--docs/content/en/methods/pager/PageGroups.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/content/en/methods/pager/PageGroups.md b/docs/content/en/methods/pager/PageGroups.md
new file mode 100644
index 000000000..9dee18c0d
--- /dev/null
+++ b/docs/content/en/methods/pager/PageGroups.md
@@ -0,0 +1,29 @@
+---
+title: PageGroups
+description: Returns the page groups in the current pager.
+categories: []
+keywords: []
+action:
+ related:
+ - methods/page/Paginate
+ returnType: page.PagesGroup
+ signatures: [PAGER.PageGroups]
+---
+
+Use the `PageGroups` method with any of the [grouping methods].
+
+[grouping methods]: /quick-reference/page-collections/#group
+
+```go-html-template
+{{ $pages := where site.RegularPages "Type" "posts" }}
+{{ $paginator := .Paginate ($pages.GroupByDate "Jan 2006") }}
+
+{{ range $paginator.PageGroups }}
+ <h2>{{ .Key }}</h2>
+ {{ range .Pages }}
+ <h3><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h3>
+ {{ end }}
+{{ end }}
+
+{{ template "_internal/pagination.html" . }}
+```