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/nextjs';

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

Info

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

State Properties

Property

Types

Loading…

Action Methods

Property

Types

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/nextjs';

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 only works in 'c15t' mode — in 'offline' mode 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

useConsentManager

State Properties

activeUIWhich consent UI component is currently visible.requiredActiveUIlink

brandingWhether to show the brandingrequiredBranding

consentCategoriesActive consent categoriesrequired{}

consentInfoInformation about when and how consent was givenrequiredConsentInfo | null

consentsCurrent consent states for all consent typesrequiredRecord<AllConsentNames, boolean>

consentTypesAvailable consent type configurationsrequired{}

debugWhether debug logging is enabledrequiredboolean

hasFetchedBannerWhether consent banner information has been successfully fetchedrequiredboolean

iabIAB TCF 2.3 state and actions (null when not configured or not in IAB mode).requiredIABManager | nulllink

iframeBlockerConfigConfiguration for the iframe blockerrequiredIframeBlockerConfig

includeNonDisplayedConsentsWhether to include non-displayed consents in operationsrequiredboolean

isLoadingConsentInfoWhether consent banner information is currently being loadedrequiredboolean

lastBannerFetchDataLast consent banner fetch data for callback replayrequiredConsentBannerResponse | null

loadedScriptsMap of currently loaded script IDs to a boolean loaded-staterequiredRecord<string, boolean>

locationInfoSubject's location informationrequiredLocationInfo | null

reloadOnConsentRevokedWhether to reload the page when consent is revoked.requiredbooleanlink

scriptIdMapMap of anonymized script IDs to their original IDsrequiredRecord<string, string>

selectedConsentsSelected consents (Not Saved) - use saveConsents to saverequiredRecord<AllConsentNames, boolean>

ssrDataUsedWhether SSR data was successfully used for initialization.requiredboolean

ssrSkippedReasonReason SSR data was skipped, if applicable.required"no_data" | "fetch_failed" | null

Action Methods

destroyIframeBlockerDestroys the iframe blocker instance and cleans up resources.required() => void

destroyNetworkBlockerDestroys the network blocker instance and cleans up resources.required() => void

getDisplayedConsentsRetrieves the list of consent types that should be displayedrequired() => {}

getLoadedScriptIdsGets all currently loaded script IDs.required() => {}

hasEvaluates whether current consent state satisfies the given condition.required<CategoryType extends AllConsentNames>(c...

hasConsentedChecks if the user has provided any form of consentrequired() => boolean

identifyUserIdentifies the user by setting the external ID.required(user: User) => Promise<void>

initConsentManagerInitializes the consent manager by fetching jurisdiction, location, translations, and branding information.required() => Promise<any>

initializeIframeBlockerInitializes the iframe blocker instance.required() => void

initializeNetworkBlockerInitializes the network blocker instance.required() => void

isScriptLoadedChecks if a script is currently loaded.required(scriptId: string) => boolean

removeScriptRemoves a script configuration from the store.required(scriptId: string) => void

resetConsentsResets all consent preferences to their default valuesrequired() => void

saveConsentsSaves the user's consent preferences.required(type: "necessary" | "all" | "custom", o...

setActiveUISets the active consent UI component.required(ui: ActiveUI, options?: { force?: boole...

setCallbackSets a callback for a specific consent event.required(name: keyof Callbacks, callback: Callba...

setConsentUpdates the consent state for a specific consent type & automatically save the consent.required(name: AllConsentNames, value: boolean) ...

setConsentCategoriesUpdates the active GDPR consent types.required(types: {}) => void

setLanguageSet the language override for the consent manager. This will override the language detected from the browser and re-fetch the consent banner information.required(language: string) => Promise<any>

setLocationInfoUpdates the user's location information.required(location: LocationInfo | null) => void

setNetworkBlockerUpdates the network blocker configuration at runtime.required(config: NetworkBlockerConfig | undefine...

setOverridesSets the overrides for the consent manager. Automatically attempts to fetch the consent manager again with the new overrides.required(overrides: Overrides | undefined) => Pr...

setScriptsSets multiple script configurations to the store.required(scripts: {}) => void

setSelectedConsentUpdates the selected consent state for a specific consent type.required(name: AllConsentNames, value: boolean) ...

setTranslationConfigUpdates the translation configuration.required(config: TranslationConfig) => void

updateConsentCategoriesExtends the active GDPR consent categories with any categories used by configured scripts.required(newCategories: {}) => void

updateIframeConsentsUpdates the active consents used by the iframe blocker.required() => void

updateNetworkBlockerConsentsUpdates the consent snapshot used by the network blocker.required() => void

updateScriptsUpdates scripts based on current consent state. Loads scripts that have consent and aren't loaded yet. Unloads scripts that no longer have consent.required() => { loaded: {}; unloaded: {}; }