@justeattakeaway/pie-cookie-banner 1.9.0 → 1.10.0

package/custom-elements.json

@@ -78,7 +78,7 @@
           "type": {
             "text": "DefaultProps"
           },
-          "default": "{ hasPrimaryActionsOnly: false, defaultPreferences: {}, country: Country.GREAT_BRITAIN, language: Language.ENGLISH, cookieStatementLink: '', cookieTechnologiesLink: '', openLinksInSameTab: false, }"
+          "default": "{ hasPrimaryActionsOnly: false, defaultPreferences: {}, country: Country.GREAT_BRITAIN, language: Language.ENGLISH, cookieStatementLink: '', personalizedLabel: '', personalizedDescription: '', cookieTechnologiesLink: '', openLinksInSameTab: false, }"
         },
         {
           "kind": "variable",
@@ -228,6 +228,18 @@
               "privacy": "public",
               "attribute": "cookieStatementLink"
             },
+            {
+              "kind": "field",
+              "name": "personalizedLabel",
+              "privacy": "public",
+              "attribute": "personalizedLabel"
+            },
+            {
+              "kind": "field",
+              "name": "personalizedDescription",
+              "privacy": "public",
+              "attribute": "personalizedDescription"
+            },
             {
               "kind": "field",
               "name": "cookieTechnologiesLink",
@@ -346,6 +358,40 @@
                 }
               ]
             },
+            {
+              "kind": "method",
+              "name": "_renderPreferenceLabel",
+              "privacy": "private",
+              "parameters": [
+                {
+                  "name": "id",
+                  "type": {
+                    "text": "PreferenceIds"
+                  }
+                }
+              ],
+              "description": "Renders a preference label.\nFor the personalised preference, uses the consumer-supplied `personalizedLabel`\nprop when provided as plain text, and falls back to the built-in locale string otherwise."
+            },
+            {
+              "kind": "method",
+              "name": "_renderPreferenceDescription",
+              "privacy": "private",
+              "parameters": [
+                {
+                  "name": "id",
+                  "type": {
+                    "text": "PreferenceIds"
+                  }
+                },
+                {
+                  "name": "description",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ],
+              "description": "Renders a preference description.\nFor the personalised preference, uses the consumer-supplied `personalizedDescription`\nprop when provided (allowing consumers to embed their own privacy policy link using\nplain HTML `<a>` or `<pie-link>` tags), and falls back to the built-in locale string otherwise.\nAll other preferences use the plain locale text with HTML sanitisation."
+            },
             {
               "kind": "method",
               "name": "_displayCookieBanner",
@@ -456,6 +502,14 @@
               "name": "cookieStatementLink",
               "fieldName": "cookieStatementLink"
             },
+            {
+              "name": "personalizedLabel",
+              "fieldName": "personalizedLabel"
+            },
+            {
+              "name": "personalizedDescription",
+              "fieldName": "personalizedDescription"
+            },
             {
               "name": "cookieTechnologiesLink",
               "fieldName": "cookieTechnologiesLink"
@@ -550,7 +604,7 @@
               "default": "'_blank'"
             }
           ],
-          "description": "Sanitises an HTML string to allow only safe <a> tags, and normalises anchor\nattributes to respect the component's link-target behaviour.\n\nUses DOMPurify for the core sanitisation:\n- Strips all non-<a> elements (keeping their text content).\n- Removes unsafe href protocols (javascript:, data:, vbscript:).\n- Removes non-allowlisted attributes (only href, rel, target survive).\n\nA post-sanitisation hook then enforces target/rel:\n- Sets target to linkTarget (overrides any existing target).\n- Ensures rel contains \"noopener noreferrer\" when target=\"_blank\"\n  (prevents reverse-tabnabbing).\n\nIn SSR / non-browser environments (no `window`), all HTML is stripped and\nonly the text content is returned — the client will re-render with the full\nsanitisation pass after hydration."
+          "description": "Sanitises an HTML string to allow only safe <a> and <pie-link> tags, and normalises link\nattributes to respect the component's link-target behaviour.\n\nUses DOMPurify for the core sanitisation:\n- Strips all non-link elements (keeping their text content).\n- Removes unsafe href protocols (javascript:, data:, vbscript:).\n- Removes non-allowlisted attributes (only href, rel, target survive).\n\nA post-sanitisation hook then enforces target/rel:\n- Sets target to linkTarget (overrides any existing target).\n- Ensures rel contains \"noopener noreferrer\" when target=\"_blank\"\n  (prevents reverse-tabnabbing).\n\nIn SSR / non-browser environments (no `window`), all HTML is stripped and\nonly the text content is returned — the client will re-render with the full\nsanitisation pass after hydration."
         },
         {
           "kind": "function",

package/dist/index.d.ts

@@ -58,6 +58,23 @@ export declare interface CookieBannerProps {
      * The URL of the cookie statement page the banner should link to.
      */
     cookieStatementLink: string;
+    /**
+     * An optional override for the personalised preference label rendered in the
+     * "Manage preferences" modal. When provided, this string replaces the locale-defined
+     * label for the personalised preference. Consumers can include plain text.
+     * When omitted or set to an empty string, the built-in locale string is used.
+     */
+    personalizedLabel?: string;
+    /**
+     * An optional override for the personalised preference description rendered in the
+     * "Manage preferences" modal. When provided, this string replaces the locale-defined
+     * description for the personalised preference. Consumers can include plain text,
+     * HTML anchor tags (e.g. `<a href="...">Privacy Policy</a>`), or `<pie-link>` tags
+     * to embed a privacy policy link. The HTML is sanitised, so only the allowed link
+     * attributes are preserved and any others are stripped or normalised. When omitted or
+     * set to an empty string, the built-in locale string is used.
+     */
+    personalizedDescription?: string;
     /**
      * The URL for the cookie technology link.
      */
@@ -150,6 +167,8 @@ export declare class PieCookieBanner extends PieElement implements CookieBannerP
     hasPrimaryActionsOnly: boolean;
     defaultPreferences: Partial<Record<PreferenceIds, boolean>>;
     cookieStatementLink: string;
+    personalizedLabel: string;
+    personalizedDescription: string;
     cookieTechnologiesLink: string;
     country: string;
     language: string;
@@ -174,6 +193,20 @@ export declare class PieCookieBanner extends PieElement implements CookieBannerP
     private _customTagEnhancers;
     private _localiseText;
     private _localiseRichText;
+    /**
+     * Renders a preference label.
+     * For the personalised preference, uses the consumer-supplied `personalizedLabel`
+     * prop when provided as plain text, and falls back to the built-in locale string otherwise.
+     */
+    private _renderPreferenceLabel;
+    /**
+     * Renders a preference description.
+     * For the personalised preference, uses the consumer-supplied `personalizedDescription`
+     * prop when provided (allowing consumers to embed their own privacy policy link using
+     * plain HTML `<a>` or `<pie-link>` tags), and falls back to the built-in locale string otherwise.
+     * All other preferences use the plain locale text with HTML sanitisation.
+     */
+    private _renderPreferenceDescription;
     /**
      * Handles closing the modal and re-displaying the cookie banner
      * and making the cookie banner visible