mirror of
https://github.com/gohugoio/hugo.git
synced 2024-12-18 17:36:52 -05:00
49 lines
1.3 KiB
Markdown
49 lines
1.3 KiB
Markdown
|
---
|
||
|
title: compare.Default
|
||
|
description: Returns the second argument if set, else the first argument.
|
||
|
keywords: []
|
||
|
action:
|
||
|
aliases: [default]
|
||
|
related:
|
||
|
- functions/compare/Conditional
|
||
|
- functions/go-template/Or
|
||
|
returnType: any
|
||
|
signatures: [compare.Default DEFAULT INPUT]
|
||
|
aliases: [/functions/default]
|
||
|
---
|
||
|
|
||
|
The `default` function returns the second argument if set, else the first argument.
|
||
|
|
||
|
{{% note %}}
|
||
|
When the second argument is the boolean `false` value, the `default` function returns `false`. All _other_ falsy values are considered unset.
|
||
|
|
||
|
{{% include "functions/go-template/_common/truthy-falsy.md" %}}
|
||
|
|
||
|
To set a default value based on truthiness, use the [`or`] operator instead.
|
||
|
|
||
|
[`or`]: /functions/go-template/or
|
||
|
{{% /note %}}
|
||
|
|
||
|
The `default` function returns the second argument if set:
|
||
|
|
||
|
```go-html-template
|
||
|
{{ default 42 1 }} → 1
|
||
|
{{ default 42 "foo" }} → foo
|
||
|
{{ default 42 (dict "k" "v") }} → map[k:v]
|
||
|
{{ default 42 (slice "a" "b") }} → [a b]
|
||
|
{{ default 42 true }} → true
|
||
|
|
||
|
<!-- As noted above, the boolean "false" is considered set -->
|
||
|
{{ default 42 false }} → false
|
||
|
```
|
||
|
|
||
|
The `default` function returns the first argument if the second argument is not set:
|
||
|
|
||
|
```go-html-template
|
||
|
{{ default 42 0 }} → 42
|
||
|
{{ default 42 "" }} → 42
|
||
|
{{ default 42 dict }} → 42
|
||
|
{{ default 42 slice }} → 42
|
||
|
{{ default 42 <nil> }} → 42
|
||
|
```
|