safe.JSStr

Declares the given string as a safe JavaScript string.

Introduction #

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>