useConsentManager

useConsentManager() is the primary hook for interacting with the consent system. It returns the complete consent store state and all action methods.

import { useConsentManager } from '@c15t/react';

function MyComponent() {
  const {
    consents,
    model,
    has,
    saveConsents,
    // ... all state and actions
  } = useConsentManager();
}

Warning

Must be used within a ConsentManagerProvider. Throws an error if used outside the provider.

State Properties

Warning: ExtractedTypeTable: Could not extract "StoreRuntimeState" from "./packages/core/src/store/type.ts" using base path "/vercel/path0/apps/c15t-docs/.leadtype/c15t". Verify the path/name and that the file is included by your tsconfig.

Property

Types

No properties found matching your criteria.

Loading…

Action Methods

Warning: ExtractedTypeTable: Could not extract "StoreActions" from "./packages/core/src/store/type.ts" using base path "/vercel/path0/apps/c15t-docs/.leadtype/c15t". Verify the path/name and that the file is included by your tsconfig.

Property

Types

No properties found matching your criteria.

Loading…

identifyUser

The identifyUser() method links anonymous consent records to an authenticated user. Call it after a user logs in to associate their consent preferences with their account.

import { useConsentManager } from '@c15t/react';

function LoginForm() {
  const { identifyUser } = useConsentManager();

  async function handleLogin(email: string) {
    // ... your login logic
    const user = await api.login(email);

    // Link consent to the authenticated user
    await identifyUser({
      id: user.id,
      identityProvider: 'your-auth-provider', // e.g. 'clerk', 'auth0'
    });
  }

  return (
    <form onSubmit={(e) => {
      e.preventDefault();
      handleLogin(new FormData(e.currentTarget).get('email') as string);
    }}>
      <input name="email" type="email" placeholder="Email" />
      <button type="submit">Log in</button>
    </form>
  );
}

Info

identifyUser sends the user data to the c15t backend. It works in hosted mode, including the legacy alias mode: 'c15t'. In mode: 'offline', the call is a no-op.

Key Types

ConsentState

A record mapping consent category names to their boolean values:

type ConsentState = Record<AllConsentNames, boolean>;
// Example: { necessary: true, measurement: true, marketing: false }

ConsentInfo

Metadata about when and how consent was recorded:

interface ConsentInfo {
  time: number;                    // Epoch timestamp when consent was recorded
  subjectId?: string;              // Client-generated subject ID (sub_xxx format)
  externalId?: string;             // External user ID linked via identifyUser()
  identityProvider?: string;       // Identity provider (e.g. 'clerk', 'auth0')
}

LocationInfo

Detected geographic location from the c15t backend:

interface LocationInfo {
  countryCode: string;     // ISO 3166-1 alpha-2 (e.g. 'DE')
  regionCode: string;      // Region/state code (e.g. 'BY')
  jurisdiction: string;    // Applicable jurisdiction (e.g. 'GDPR', 'CCPA')
}

Model

The active consent model:

type Model = 'opt-in' | 'opt-out' | 'iab' | null;

'opt-in' — Explicit consent required before tracking (GDPR)
'opt-out' — Tracking allowed by default, user can opt out (CCPA)
'iab' — IAB TCF 2.3 compliance mode
null — No jurisdiction detected yet