hugo/docs/content/en/functions/trim.md
2023-05-22 16:47:07 +02:00

36 lines
1 KiB
Markdown

---
title: trim
description: Returns a slice of a passed string with all leading and trailing characters from cutset removed.
categories: [functions]
menu:
docs:
parent: functions
keywords: [strings]
signature:
- "trim INPUT CUTSET"
- "strings.Trim INPUT CUTSET"
relatedfuncs: []
---
```go-html-template
{{ trim "++Batman--" "+-" }} → "Batman"
```
`trim` *requires* the second argument, which tells the function specifically what to remove from the first argument. There is no default value for the second argument, so **the following usage will not work**:
```go-html-template
{{ trim .Inner }}
```
Instead, the following example tells `trim` to remove extra new lines from the content contained in the [shortcode `.Inner` variable][shortcodevars]:
```go-html-template
{{ trim .Inner "\n" }}
```
{{% note %}}
Go templates also provide a simple [method for trimming whitespace](/templates/introduction/#whitespace) from either side of a Go tag by including a hyphen (`-`).
{{% /note %}}
[shortcodevars]: /variables/shortcodes/