summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/IsMenuCurrent.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/IsMenuCurrent.md')
-rw-r--r--docs/content/en/functions/IsMenuCurrent.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/content/en/functions/IsMenuCurrent.md b/docs/content/en/functions/IsMenuCurrent.md
new file mode 100644
index 000000000..c9980b3e8
--- /dev/null
+++ b/docs/content/en/functions/IsMenuCurrent.md
@@ -0,0 +1,33 @@
+---
+title: .IsMenuCurrent
+description: Reports whether the given page object matches the page object associated with the given menu entry in the given menu.
+categories: [functions]
+keywords: []
+menu:
+ docs:
+ parent: functions
+function:
+ aliases: []
+ returnType: bool
+ signatures: [PAGE.IsMenuCurrent MENU MENUENTRY]
+relatedFunctions:
+ - .HasMenuCurrent
+ - .IsMenuCurrent
+---
+
+```go-html-template
+{{ $currentPage := . }}
+{{ range site.Menus.main }}
+ {{ if $currentPage.IsMenuCurrent .Menu . }}
+ <a class="active" aria-current="page" href="{{ .URL }}">{{ .Name }}</a>
+ {{ else if $currentPage.HasMenuCurrent .Menu . }}
+ <a class="ancestor" aria-current="true" href="{{ .URL }}">{{ .Name }}</a>
+ {{ else }}
+ <a href="{{ .URL }}">{{ .Name }}</a>
+ {{ end }}
+{{ end }}
+```
+
+See [menu templates] for a complete example.
+
+[menu templates]: /templates/menu-templates/#example