consentik-cmp

React component and hook for integrating the Consentik cookie consent banner.

Ships with TypeScript declarations.

Getting Started

Before using this package, you need a Consentik account with a configured site.

1. Register an account

Go to https://cmp.consentik.com/admin/register and create your account.

2. Create a site

After logging in, create a new site in the Consentik dashboard. Enter your website domain and configure your consent preferences.

3. Get your Site ID and Instance ID

Once your site is created, you can find your Site ID and Instance ID in the site settings. You will need these values to configure the component.

Installation

npm install consentik-cmp
# or
pnpm add consentik-cmp
# or
yarn add consentik-cmp

Usage

Component

import { ConsentikCMP } from 'consentik-cmp';

function App() {
  return (
    <>
      <ConsentikCMP
        config={{
          instanceId: 'your-instance-id',
          siteId: 'your-site-id'
        }}
      />
      {/* rest of your app */}
    </>
  );
}

Hook

import { useConsentik } from 'consentik-cmp';

function App() {
  useConsentik({
    instanceId: 'your-instance-id',
    siteId: 'your-site-id'
  });

  return <div>{/* your app */}</div>;
}

Config Options

| Option | Type | Required | Description | |--------|------|----------|-------------| | instanceId | string | Yes | Your Consentik instance ID | | siteId | string | Yes | Your Consentik site ID | | timestamp | number | No | Cache bust value. Defaults to new Date().getMinutes() |

Framework Compatibility

Works with any React-based framework:

• React (CRA, Vite)
• Next.js (App Router & Pages Router)
• Remix
• Gatsby

The script is injected client-side via useEffect, so it is SSR-safe.

License

MIT