hugo/docs/content/en/functions/safe/JSStr.md

title	description	categories	keywords	action	toc	aliases
safe.JSStr	Declares the given string as a safe JavaScript string.			aliases related returnType signatures safeJSStr functions/safe/CSS functions/safe/HTML functions/safe/HTMLAttr functions/safe/JS functions/safe/URL template.JSStr safe.JSStr INPUT	true	/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.

Example

Without a safe declaration:

{{ $title := "Lilo & Stitch" }}
<script>
  const a = "Title: " + {{ $title }};
</script>

Hugo renders the above to:

<script>
  const a = "Title: " + "Lilo \u0026 Stitch";
</script>

To declare the string as safe:

{{ $title := "Lilo & Stitch" }}
<script>
  const a = "Title: " + {{ $title | safeJSStr }};
</script>

Hugo renders the above to:

<script>
  const a = "Title: " + "Lilo & Stitch";
</script>