Children

Returns a collection of child menu entries, if any, under the given menu entry.

Syntax

MENUENTRY.Children

Returns

navigation.Menu

Use the Children method when rendering a nested menu.

With this site configuration:

menus:
  main:
  - name: Products
    pageRef: /product
    weight: 10
  - name: Product 1
    pageRef: /products/product-1
    parent: Products
    weight: 1
  - name: Product 2
    pageRef: /products/product-2
    parent: Products
    weight: 2

[menus]
  [[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

{
   "menus": {
      "main": [
         {
            "name": "Products",
            "pageRef": "/product",
            "weight": 10
         },
         {
            "name": "Product 1",
            "pageRef": "/products/product-1",
            "parent": "Products",
            "weight": 1
         },
         {
            "name": "Product 2",
            "pageRef": "/products/product-2",
            "parent": "Products",
            "weight": 2
         }
      ]
   }
}

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>

Last updated: January 26, 2024 : Squashed 'docs/' changes from 4dd2d6415..3b1a8579d (7125ad401)

Improve this page