use-consentmanager-net-status v1.0.5

useConsentmanagerNetStatus

Hook to get the current status of the ConsentManager.net CMP on the page

Install

npm install --save use-consentmanager-net-status

Usage

import * as React from "react";

import useConsentmanagerNetStatus from "use-consentmanager-net-status";

const GoogleAnalyticsScript = () => {
  const { isConsentGivenFor } = useConsentmanagerNetStatus();
  return <div>{isConsentGivenFor("Google Analytics") && <script ... />}</div>;
};

useConsentmanagerNetStatus returns an object with two properties:

• isConsentGivenFor(vendorName): Function that takes a vandor name and returns the consent status for that vendor.
• consentStatus: An object of all the vendor names and their consent status (e.g. {"Google Analytics": true}).

It is recommended to use the isConsentGivenFor function to check if the user has given consent for a vendor instead of using the consentStatus object as the function will handle edge-cases like non-existent vendors or if GDPR doesn't apply.

The hook automatically adds an event listener to the Consent Manager so your component will re-render when the user's consent status changes. The hook also handles the case where the Consent Manager is not available yet and will automatically retry adding its event listener until it finds the API - this way you won't have to make sure ConsentManager.net is fully loaded yet before using the hook.

It is compatible with SSR and contains TypeScript definitions. The hook does not load the ConsentManager.net script - you should add the <script> tag provided by them somewhere in your code, the hook only gives you access to its status.

License

MIT © vantezzen

This hook is created using create-react-hook.