IsMenuCurrent

Reports whether the given Page object matches the Page object associated with the given menu entry in the given menu.

Syntax

PAGE.IsMenuCurrent MENU MENUENTRY

Returns

bool

{{ $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.

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.

Last updated: February 17, 2025 : all: Change shortcode usage and design to prevent invalid HTML (0fca8ef25)

Improve this page