hugo/docs/content/en/methods/menu-entry/Weight.md
2023-12-04 15:24:01 +01:00

31 lines
963 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: Weight
description: Returns the `weight` property of the given menu entry.
categories: []
keywords: []
action:
related: []
returnType: int
signatures: [MENUENTRY.Weight]
---
If you define the menu entry [automatically], the `Weight` method returns the pages [`Weight`].
If you define the menu entry [in front matter] or [in site configuration], the `Weight` method returns the `weight` property, falling back to the pages `Weight`.
[`Weight`]: /methods/page/weight
[automatically]: /content-management/menus/#define-automatically
[in front matter]: /content-management/menus/#define-in-front-matter
[in site configuration]: /content-management/menus/#define-in-site-configuration
In this contrived example, we limit the number of menu entries based on weight:
```go-html-template
<ul>
{{ range .Site.Menus.main }}
{{ if le .Weight 42 }}
<li><a href="{{ .URL }}">{{ .Name }}</a></li>
{{ end }}
{{ end }}
</ul>
```