aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/content/en/methods/menu-entry/Weight.md
blob: 7b0c24ae8801fb72a7dadc4ba0cac2396d2d5639 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
---
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 page’s [`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 page’s `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>
```