Merge pull request #310 from ocruze/feat/personalise-analytics-localstorage-key

feat: customize localStorage key for analytics consents #302

Author: garronej

src/consentManagement/createConsentManagement.ts

@@ -9,7 +9,7 @@ import { useRerenderOnChange } from "../tools/StatefulObservable/hooks";
 import { createConsentBannerAndConsentManagement } from "./ConsentBannerAndConsentManagement";
 import { isBrowser } from "../tools/isBrowser";
 
-export const localStorageKeyPrefix = "@codegouvfr/react-dsfr finalityConsent";
+export const defaultLocalStorageKeyPrefix = "@codegouvfr/react-dsfr finalityConsent";
 
 export function createConsentManagement<
     FinalityDescription extends Record<
@@ -21,10 +21,16 @@ export function createConsentManagement<
     consentCallback?: ConsentCallback<ExtractFinalityFromFinalityDescription<FinalityDescription>>;
     /** Optional: If you have a dedicated page that provides comprehensive information about your website's GDPR policies. */
     personalDataPolicyLinkProps?: RegisteredLinkProps;
+    localStorageKeyPrefix?: string;
 }) {
     type Finality = ExtractFinalityFromFinalityDescription<FinalityDescription>;
 
-    const { finalityDescription, personalDataPolicyLinkProps, consentCallback } = params;
+    const {
+        finalityDescription,
+        personalDataPolicyLinkProps,
+        consentCallback,
+        localStorageKeyPrefix = defaultLocalStorageKeyPrefix
+    } = params;
 
     const finalities = getFinalitiesFromFinalityDescription({
         "finalityDescription":

stories/ConsentManagement.stories.tsx

@@ -2,7 +2,7 @@ import React from "react";
 import { sectionName } from "./sectionName";
 import { getStoryFactory } from "./getStory";
 import { createConsentManagement } from "../dist/consentManagement";
-import { localStorageKeyPrefix } from "../dist/consentManagement/createConsentManagement";
+import { defaultLocalStorageKeyPrefix } from "../dist/consentManagement/createConsentManagement";
 import { Placeholder } from "../dist/consentManagement/Placeholder";
 import { Footer } from "../dist/Footer";
 import { Button } from "../dist/Button";
@@ -284,7 +284,7 @@ function Story() {
             <Button
                 onClick={() => {
                     Object.keys(localStorage)
-                        .filter(key => key.startsWith(localStorageKeyPrefix))
+                        .filter(key => key.startsWith(defaultLocalStorageKeyPrefix))
                         .forEach(key => localStorage.removeItem(key));
 
                     location.reload();