summaryrefslogtreecommitdiffstats
path: root/docs/content/en/methods/menu-entry/Weight.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/methods/menu-entry/Weight.md')
-rw-r--r--docs/content/en/methods/menu-entry/Weight.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/content/en/methods/menu-entry/Weight.md b/docs/content/en/methods/menu-entry/Weight.md
new file mode 100644
index 000000000..7b0c24ae8
--- /dev/null
+++ b/docs/content/en/methods/menu-entry/Weight.md
@@ -0,0 +1,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>
+```