@soyio/soyio-widget 2.23.0 → 2.24.0

package/README.md

@@ -191,6 +191,17 @@ The `PrivacyCenterBox` lets you embed the Privacy Center inside your page. You c
       { id: "op_rectification", label: "Rectification" },
     ],
 
+    // Header and copy customization (optional)
+    content: {
+      header: {
+        title: "Privacy preferences",
+        description: "Manage your requests and consent settings.",
+      },
+      rightExamples: {
+        access: 'Example: "I want to know what data you store about me."',
+      },
+    },
+
     // Common options
     consentControl: "checkbox", // Optional: 'switch' (default) | 'checkbox'
     consentMode: "batch", // Optional: 'immediate' (default) | 'batch'
@@ -201,7 +212,11 @@ The `PrivacyCenterBox` lets you embed the Privacy Center inside your page. You c
     onEvent: (event) => console.log(event),
     onReady: () => console.log("PrivacyCenterBox is ready"), // Optional
     isSandbox: true, // Optional
-    appearance: {}, // Optional
+    appearance: {
+      config: {
+        showHeader: true,
+      },
+    }, // Optional
   };
 
   // Wait for DOM to be fully loaded
@@ -224,6 +239,11 @@ The `PrivacyCenterBox` lets you embed the Privacy Center inside your page. You c
   - `allowedExtensions`: Array of allowed file extensions (e.g. `['pdf', 'jpg']`). Default: `['pdf', 'png', 'jpeg', 'jpg']`.
   - `maxFileSize`: Maximum file size in bytes. Default: `5 * 1024 * 1024` (5MB).
 - `redecOperationIds`: Optional array of `{ id, label }` values for the Redec operation select. Required if `redec` right is included in `enabledRights` param.
+- `appearance.config.showHeader`: Optional boolean to show/hide the privacy center header (title and description).
+- `content.header`: Optional object with `title` and `description` overrides for the privacy center header copy.
+- `content.rightExamples`: Optional object to override DSR right examples. Supported keys: `access`, `opposition`, `rectification`, `suppression`, `portability`, `redec_update`, `redec_rectification`, `redec_complementation`, `redec_cancellation`.
+- `header`: Optional legacy alias for `content.header`.
+- `rightExamples`: Optional legacy alias for `content.rightExamples`.
 - `isSandbox`: Whether to use the sandbox environment. Defaults to `false`.
 - `consentControl`: Optional, controls the visual interaction for consent toggles. Values: `'switch'` (default) or `'checkbox'`.
 - `consentMode`: Optional, controls how consent changes are committed. Values: `'immediate'` (default) or `'batch'` (save multiple changes at once).

package/dist/index.d.ts

@@ -186,6 +186,8 @@ declare type CSSProperties = {
 
 declare type DataSubject = 'anonymous_user' | 'citizen_voter' | 'commuter' | 'consultant' | 'customer' | 'employee' | 'job_applicant' | 'next_of_kin' | 'passenger' | 'patient' | 'prospect' | 'shareholder' | 'supplier_vendor' | 'trainee' | 'visitor';
 
+declare type DataSubjectRequestKind = 'access' | 'opposition' | 'rectification' | 'suppression' | 'portability' | 'redec_update' | 'redec_rectification' | 'redec_complementation' | 'redec_cancellation';
+
 export declare class DisclosureRequestBox extends BaseIframeBox<DisclosureRequestBoxEvent, DisclosureRequestBoxConfig> {
     readonly defaultIframePrefix = "disclosure-request-box";
     private passkeyPopupWindow;
@@ -337,6 +339,9 @@ declare type PrivacyCenterConfig = BaseConfig & {
     groupConsentsByScope?: boolean;
     showBatchConsentConfirmation?: boolean;
     redecOperationIds?: RedecOperationId[];
+    content?: PrivacyCenterContentConfig;
+    header?: PrivacyCenterHeaderCopyConfig;
+    rightExamples?: PrivacyCenterContentConfig['rightExamples'];
 } & ({
     companyId: `com_${string}`;
     sessionToken?: never;
@@ -345,6 +350,16 @@ declare type PrivacyCenterConfig = BaseConfig & {
     companyId?: never;
 });
 
+declare type PrivacyCenterContentConfig = {
+    header?: PrivacyCenterHeaderCopyConfig;
+    rightExamples?: Partial<Record<DataSubjectRequestKind, string>>;
+};
+
+declare type PrivacyCenterHeaderCopyConfig = {
+    title?: string;
+    description?: string;
+};
+
 declare type PrivacyCenterRight = 'arsop' | 'redec';
 
 declare type PrivacyManagerFeature = 'DataSubjectRequest' | 'ConsentManagement' | 'RequestTracking';
@@ -389,6 +404,7 @@ declare interface SoyioAppearanceConfig {
      * @default 'switch'
      */
     consentControl?: 'switch' | 'checkbox';
+    showHeader?: boolean;
     /**
      * Icon name to use for hint/help tooltips on input labels.
      * Available icons: 'Question' (default), 'Info', 'QuestionMark', etc.