Opt-out

When opt-out is enabled, the SDK stops sending all events.

The React SDK is built on top of the JavaScript SDK. The opt-out API is the same as the JavaScript SDK.

Configuration at Initialization

React

import { createInstance, HackleProvider } from "@hackler/react-sdk";

const config = {
    optOutTracking: true
};

const hackleClient = createInstance("YOUR_BROWSER_SDK_KEY", config);

ReactDOM.render(
  <HackleProvider hackleClient={hackleClient}>
    <YourApp />
  </HackleProvider>,
  document.getElementById('root')
);

Next.js

import { createInstance, HackleProvider } from "@hackler/react-sdk";

const config = {
    optOutTracking: true
};

const hackleClient = createInstance("YOUR_BROWSER_SDK_KEY", config);

function MyApp({ Component, pageProps }) {
  return (
    <HackleProvider hackleClient={hackleClient} supportSSR>
      <Component {...pageProps} />
    </HackleProvider>
  )
}

export default MyApp

Runtime Opt-out Control

hackleClient.setOptOutTracking(true);
hackleClient.setOptOutTracking(false);
const isOptOut = hackleClient.isOptOutTracking();

Persistence Management

The value resets to the value configured in Config on page refresh or revisit.

function saveOptOutState(optOut) {
    localStorage.setItem("hackle_opt_out", JSON.stringify(optOut));
    hackleClient.setOptOutTracking(optOut);
}

function getOptOutConfig() {
    const optOut = JSON.parse(localStorage.getItem("hackle_opt_out") || "false");
    return {
        optOutTracking: optOut
    };
}

const config = getOptOutConfig();
const hackleClient = Hackle.createInstance("YOUR_BROWSER_SDK_KEY", config);