mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-21 20:46:30 -05:00
68 lines
1.4 KiB
Markdown
68 lines
1.4 KiB
Markdown
---
|
|
title: safe.JSStr
|
|
description: Declares the given string as a safe JavaScript string.
|
|
categories: []
|
|
keywords: []
|
|
action:
|
|
aliases: [safeJSStr]
|
|
related:
|
|
- functions/safe/CSS
|
|
- functions/safe/HTML
|
|
- functions/safe/HTMLAttr
|
|
- functions/safe/JS
|
|
- functions/safe/URL
|
|
returnType: template.JSStr
|
|
signatures: [safe.JSStr INPUT]
|
|
toc: true
|
|
aliases: [/functions/safejsstr]
|
|
---
|
|
|
|
## Introduction
|
|
|
|
{{% include "functions/_common/go-html-template-package.md" %}}
|
|
|
|
## Usage
|
|
|
|
Use the `safe.JSStr` function to encapsulate a sequence of characters meant to be embedded between quotes in a JavaScript expression.
|
|
|
|
Use of this type presents a security risk: the encapsulated content should come from a trusted source, as it will be included verbatim in the template output.
|
|
|
|
See the [Go documentation] for details.
|
|
|
|
[Go documentation]: https://pkg.go.dev/html/template#JSStr
|
|
|
|
## Example
|
|
|
|
Without a safe declaration:
|
|
|
|
```go-html-template
|
|
{{ $title := "Lilo & Stitch" }}
|
|
<script>
|
|
const a = "Title: " + {{ $title }};
|
|
</script>
|
|
```
|
|
|
|
Hugo renders the above to:
|
|
|
|
```html
|
|
<script>
|
|
const a = "Title: " + "Lilo \u0026 Stitch";
|
|
</script>
|
|
```
|
|
|
|
To declare the string as safe:
|
|
|
|
```go-html-template
|
|
{{ $title := "Lilo & Stitch" }}
|
|
<script>
|
|
const a = "Title: " + {{ $title | safeJSStr }};
|
|
</script>
|
|
```
|
|
|
|
Hugo renders the above to:
|
|
|
|
```html
|
|
<script>
|
|
const a = "Title: " + "Lilo & Stitch";
|
|
</script>
|
|
```
|