2019-10-21 04:22:28 -04:00
---
2023-10-20 03:42:39 -04:00
title: compare.Default
linkTitle: default
2019-10-21 04:22:28 -04:00
description: Allows setting a default value that can be returned if a first value is not set.
categories: [functions]
2023-10-20 03:42:39 -04:00
keywords: []
2019-10-21 04:22:28 -04:00
menu:
docs:
2023-05-22 10:43:12 -04:00
parent: functions
2023-10-20 03:42:39 -04:00
function:
aliases: [default]
returnType: any
signatures: [compare.Default DEFAULT INPUT]
relatedFunctions:
- compare.Conditional
- compare.Default
aliases: [/functions/default]
2019-10-21 04:22:28 -04:00
---
`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:
2023-05-22 10:43:12 -04:00
```go-html-template
{{ .Params.font | default "Roboto" }}
{{ default "Roboto" .Params.font }}
2019-10-21 04:22:28 -04:00
```
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:
2023-05-22 10:43:12 -04:00
```go-html-template
{{ $old := .Params.oldparam }}
2019-10-21 04:22:28 -04:00
< p > {{ .Params.newparam | default $old }}< / p >
2023-05-22 10:43:12 -04:00
```
2019-10-21 04:22:28 -04:00
Which would return:
2023-05-22 10:43:12 -04:00
```html
2019-10-21 04:22:28 -04:00
< p > The default function helps make your templating DRYer.< / p >
```
And then using dot notation
2023-05-22 10:43:12 -04:00
```go-html-template
2019-10-21 04:22:28 -04:00
< title > {{ .Params.seo_title | default .Title }}< / title >
2023-05-22 10:43:12 -04:00
```
2019-10-21 04:22:28 -04:00
Which would return
2023-05-22 10:43:12 -04:00
```html
2019-10-21 04:22:28 -04:00
< title > Sane Defaults< / title >
2023-05-22 10:43:12 -04:00
```
2019-10-21 04:22:28 -04:00
The following have equivalent return values but are far less terse. This demonstrates the utility of `default` :
Using `if` :
2023-05-22 10:43:12 -04:00
```go-html-template
< title > {{ if .Params.seo_title }}{{ .Params.seo_title }}{{ else }}{{ .Title }}{{ end }}< / title >
2019-10-21 04:22:28 -04:00
=> Sane Defaults
2023-05-22 10:43:12 -04:00
```
2019-10-21 04:22:28 -04:00
Using `with` :
2023-05-22 10:43:12 -04:00
```go-html-template
< title > {{ with .Params.seo_title }}{{ . }}{{ else }}{{ .Title }}{{ end }}< / title >
2019-10-21 04:22:28 -04:00
=> Sane Defaults
2023-05-22 10:43:12 -04:00
```