@justeattakeaway/pie-cookie-banner 1.9.1 → 1.10.0

package/README.md

@@ -40,7 +40,9 @@ Ideally, you should install the component using the **`@justeattakeaway/pie-webc
 | `country`               | 2 character country code                                                | Used to load the localisation data for the component strings. If not provided, the default country of `'gb'` will be used. Note this value is case-insensitive.                                                                   | `"gb"`      |
 | `language`              | 2 character language code                                               | Used to load the localisation data for the component strings. If not provided, the default language of the country will be used. Note this value is case-insensitive.                                                              | `"en"`      |
 | `cookieStatementLink`   | —                                                                       | The URL of the cookie statement page the banner should link to.                                                                                                                              | `""`        |
-| `cookieTechnologiesLink`| —                                                                       | The URL for the cookie technology link.                                                                                                                                                                                             | `""`        |
+| `personalizedLabel`     | —                                                                       | An optional override for the personalised preference label in the "Manage preferences" modal. Supports plain text. When omitted or empty, the built-in locale string is used.                                                    | `""`        |
+| `personalizedDescription` | —                                                                      | An optional override for the personalised preference description in the "Manage preferences" modal. Supports plain text or HTML `<a>` or `<pie-link>` tags (e.g. `<a href="...">Privacy Policy</a>`). The HTML is sanitised, so only the allowed link attributes are preserved and any others are stripped or normalised. When omitted or empty, the built-in locale string is used. | `""`        |
+| `cookieTechnologiesLink` | —                                                                       | The URL for the cookie technology link.                                                                                                                                                                                             | `""`        |
 | `defaultPreferences`    | `all`, `necessary`, `functional`, `analytical`, `personalized`          | Allows default preferences to be passed in by the consumer, for example `{ 'functional': true, 'personalized': true, 'analytical': true }`.                                                  | `{}`        |
 | `openLinksInSameTab`    | `true`, `false`                                                         | When true, external links (Cookie Statement, Cookie Technologies) will open in the same tab (`target="_self"`). When false, links open in a new browser tab (`target="_blank"`).                                                   | `false`     |
 

package/cdn_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