hugo/docs/content/en/methods/menu-entry/Children.md
Bjørn Erik Pedersen 5fd1e74903
Merge commit '9b0050e9aabe4be65c78ccf292a348f309d50ccd' as 'docs'
```
git subtree add --prefix=docs/ https://github.com/gohugoio/hugoDocs.git master --squash
```

Closes 
2024-01-27 10:48:57 +01:00

1.2 KiB

title description categories keywords action
Children Returns a collection of child menu entries, if any, under the given menu entry.
related returnType signatures
methods/menu-entry/HasChildren
navigation.Menu
MENUENTRY.Children

Use the Children method when rendering a nested menu.

With this site configuration:

{{< code-toggle file=hugo >}} menus.main name = 'Products' pageRef = '/product' weight = 10

menus.main name = 'Product 1' pageRef = '/products/product-1' parent = 'Products' weight = 1

menus.main name = 'Product 2' pageRef = '/products/product-2' parent = 'Products' weight = 2 {{< /code-toggle >}}

And this template:

<ul>
  {{ range .Site.Menus.main }}
    <li>
      <a href="{{ .URL }}">{{ .Name }}</a>
      {{ if .HasChildren }}
        <ul>
          {{ range .Children }}
            <li><a href="{{ .URL }}">{{ .Name }}</a></li>
          {{ end }}
        </ul>
      {{ end }}
    </li>
  {{ end }}
</ul>

Hugo renders this HTML:

<ul>
  <li>
    <a href="/products/">Products</a>
    <ul>
      <li><a href="/products/product-1/">Product 1</a></li>
      <li><a href="/products/product-2/">Product 2</a></li>
    </ul>
  </li>
</ul>