1
0
Fork 0
hugo/docs/content/en/methods/page/IsMenuCurrent.md

1.0 KiB

title description categories keywords action aliases
IsMenuCurrent Reports whether the given Page object matches the Page object associated with the given menu entry in the given menu.
related returnType signatures
methods/page/HasMenuCurrent
bool
PAGE.IsMenuCurrent MENU MENUENTRY
/functions/ismenucurrent
{{ $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.

{{% note %}} When using this method you must either define the menu entry in front matter, or specify a pageRef property when defining the menu entry in your site configuration. {{% /note %}}