VIA-627 SB & EO Better name and docstring for linksOpenCorrectly().

Author: acerathereinspirative-nhs-nvir

src/app/_components/content/Overview.tsx

@@ -1,14 +1,14 @@
 import { VaccineType } from "@src/models/vaccine";
 import { Overview as StyledOverview } from "@src/services/content-api/types";
-import { fixupHtmlFragment } from "@src/utils/html";
+import { linksOpenCorrectly } from "@src/utils/html";
 import { JSX } from "react";
 
 const Overview = (props: { overview: StyledOverview | undefined; vaccineType: VaccineType }): JSX.Element => {
   const element = props.overview ? (
     props.overview.containsHtml ? (
       <div
         data-testid="overview-text"
-        dangerouslySetInnerHTML={{ __html: fixupHtmlFragment(props.overview.content) || "" }}
+        dangerouslySetInnerHTML={{ __html: linksOpenCorrectly(props.overview.content) || "" }}
       />
     ) : (
       <p data-testid="overview-text">{props.overview.content}</p>

src/services/content-api/parsers/content-styling-service.tsx

@@ -16,7 +16,7 @@ import {
   VaccinePageSection,
   VaccinePageSubsection,
 } from "@src/services/content-api/types";
-import { fixupHtmlFragment } from "@src/utils/html";
+import { linksOpenCorrectly } from "@src/utils/html";
 import sanitiseHtml from "@src/utils/sanitise-html";
 import { InsetText, WarningCallout } from "nhsuk-react-components";
 import React, { JSX } from "react";
@@ -184,7 +184,7 @@ function styleCallout(callout: HeadingWithTypedContent | undefined): StyledPageS
           component: (
             <div
               data-testid="callout-html"
-              dangerouslySetInnerHTML={{ __html: fixupHtmlFragment(callout.content) || "" }}
+              dangerouslySetInnerHTML={{ __html: linksOpenCorrectly(callout.content) || "" }}
             />
           ),
         };

src/utils/html.ts

@@ -1,6 +1,12 @@
 import { load as loadHtml } from "cheerio";
 
-export function fixupHtmlFragment(fragment: string) {
+/**
+ * Update HTML fragment to ensure that anchor tags have the target="_blank"
+ * attribute, so links open in a new window.
+ *  * @param {string} fragment - the original HTML fragment.
+ *  * @returns {string} The HTML fragment with fixed anchor tags.
+ */
+export function linksOpenCorrectly(fragment: string) {
   const $ = loadHtml(fragment, null, false);
   $("a").attr("target", "_blank");
   return $.html();