mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
2.1 KiB
2.1 KiB
title | linkTitle | description | categories | keywords | menu | function | relatedFunctions | aliases | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
compare.Default | default | Allows setting a default value that can be returned if a first value is not set. |
|
|
|
|
|
default
checks whether a given value is set and returns a default value if it is not. Set in this context means different things depending on the data type:
- non-zero for numeric types and times
- non-zero length for strings, arrays, slices, and maps
- any boolean or struct value
- non-nil for any other types
default
function examples reference the following content page:
{{< code file="content/posts/default-function-example.md" >}}
title: Sane Defaults seo_title: date: 2017-02-18 font: oldparam: The default function helps make your templating DRYer. newparam:
{{< /code >}}
default
can be written in more than one way:
{{ .Params.font | default "Roboto" }}
{{ default "Roboto" .Params.font }}
Both of the above default
function calls return Roboto
.
A default
value, however, does not need to be hard coded like the previous example. The default
value can be a variable or pulled directly from the front matter using dot notation:
{{ $old := .Params.oldparam }}
<p>{{ .Params.newparam | default $old }}</p>
Which would return:
<p>The default function helps make your templating DRYer.</p>
And then using dot notation
<title>{{ .Params.seo_title | default .Title }}</title>
Which would return
<title>Sane Defaults</title>
The following have equivalent return values but are far less terse. This demonstrates the utility of default
:
Using if
:
<title>{{ if .Params.seo_title }}{{ .Params.seo_title }}{{ else }}{{ .Title }}{{ end }}</title>
=> Sane Defaults
Using with
:
<title>{{ with .Params.seo_title }}{{ . }}{{ else }}{{ .Title }}{{ end }}</title>
=> Sane Defaults