Debian Codegraph @

docs/content/en/methods/site/Dimension.md

raw
1 ---
2 title: Dimension
3 description: Returns the dimension object for the given dimension for the given site.
4 categories: []
5 keywords: []
6 params:
7 functions_and_methods:
8 returnType: page.SiteDimension
9 signatures: [SITE.Dimension DIMENSION]
10 ---
11
12 {{< new-in 0.153.0 />}}
13
14 The `Dimension` method on a `Site` object returns the dimension object for the given [dimension](g).
15
16 The `DIMENSION` argument must be one of `language`, `version`, or `role`.
17
18 Example|Returns|Equivalent to
19 :--|:--|:--
20 `{{ .Site.Dimension "language" }}`|`langs.Language`|`{{ .Site.Language }}`
21 `{{ .Site.Dimension "version" }}`|`version.Version`|`{{ .Site.Version }}`
22 `{{ .Site.Dimension "role" }}`|`roles.Role`|`{{ .Site.Role }}`
23
24 ```go-html-template
25 {{ $languageObject := .Site.Dimension "language" }}
26 {{ $languageObject.IsDefault }} → true
27 {{ $languageObject.Name }} → en
28
29 {{ $versionObject := .Site.Dimension "version" }}
30 {{ $versionObject.IsDefault }} → true
31 {{ $versionObject.Name }} → v1.0.0
32
33 {{ $roleObject := .Site.Dimension "role" }}
34 {{ $roleObject.IsDefault }} → true
35 {{ $roleObject.Name }} → guest
36 ```