ConsentManagerProvider

ConsentManagerProvider is the root component for the c15t consent system. It initializes the consent store, detects the user's jurisdiction, resolves translations, and provides consent state to all child components via React context.

Every other c15t component and hook must be rendered inside this provider.

Basic Usage

import { type ReactNode } from 'react';
import {
  ConsentManagerProvider,
  ConsentBanner,
  ConsentDialog,
} from '@c15t/nextjs';

export default function ConsentManager({ children }: { children: ReactNode }) {
  return (
    <ConsentManagerProvider
      options={{
        mode: 'c15t',
        backendURL: '/api/c15t',
        consentCategories: ['necessary', 'measurement', 'marketing'],
      }}
    >
      <ConsentBanner />
      <ConsentDialog />
      {children}
    </ConsentManagerProvider>
  );
}

Options Reference

Property

Types

Loading…

Property

Types

Loading…

Property

Types

Loading…

Mode: c15t vs offline

// Connected mode — persists to c15t backend
<ConsentManagerProvider
  options={{
    mode: 'c15t',
    backendURL: '/api/c15t',
  }}
>

// Offline mode — local cookie storage only
<ConsentManagerProvider
  options={{
    mode: 'offline',
  }}
>

See Client Modes for a detailed comparison.

Legal Links

Configure URLs that appear in the consent banner and dialog:

<ConsentManagerProvider
  options={{
    mode: 'offline',
    legalLinks: {
      privacyPolicy: '/privacy',
      cookiePolicy: '/cookies',
      termsOfService: '/terms',
    },
  }}
>

Overrides

Force a specific jurisdiction, country, or language regardless of detection:

<ConsentManagerProvider
  options={{
    mode: 'c15t',
    backendURL: '/api/c15t',
    overrides: {
      country: 'DE',
      region: 'BY',
      language: 'de',
    },
  }}
>

Props

Property

Types

Loading…

ConsentManagerProvider

Basic Usage

Options Reference

callbacks?Event callbacks for consent actions.Callbacks | undefinedlink

enabled?Whether c15t should be active.boolean | undefined

iab?IAB TCF 2.3 configuration.IABConfig | undefinedlink

legalLinks?Configuration for the legal links.LegalLinks

networkBlocker?Configuration for the network request blocker.NetworkBlockerConfig | undefinedlink

overrides?Forcefully set values like country, region, language for the consent manager. These values will override the values detected from the browser.Overrides | undefined

scripts?Dynamically load scripts based on consent state.{} | undefinedlink

ssrData?SSR-prefetched data for hydration.Promise<SSRInitialData | undefined>link

storageConfig?Storage configuration for consent persistence.StorageConfig | undefined

user?The user's information. Usually your own internal ID for the user from your auth provider.User | undefinedlink

consentCategories?Consent categories to show in the consent banner.{} | undefinedlink

translations?Translation configuration to seed the store with.Partial<TranslationConfig>link

colorScheme?Color scheme preference. With this option, you can force the theme to be light, dark or system. Otherwise, the theme will be detected if you have '.dark' classname in your document."light" | "dark" | "system" | undefinedlink

disableAnimation?Whether to disable animations.boolean | undefined

noStyle?Whether to disable default styles.boolean | undefinedlink

scrollLock?Whether to lock scroll when dialogs are open.boolean | undefined

theme?Visual theme to apply.Theme | undefinedlink

trapFocus?Whether to trap focus within dialogs.boolean | undefined

Mode: c15t vs offline

Legal Links

Overrides

Props

childrenReact children to render within the provider.requiredReactNode

optionsConfiguration options for the consent manager. This includes core, React, store, and translation settings.requiredConsentManagerOptions

callbacks?Event callbacks for consent actions.Callbacks | undefinedlink

enabled?Whether c15t should be active.boolean | undefined

iab?IAB TCF 2.3 configuration.IABConfig | undefinedlink

legalLinks?Configuration for the legal links.LegalLinks

networkBlocker?Configuration for the network request blocker.NetworkBlockerConfig | undefinedlink

overrides?Forcefully set values like country, region, language for the consent manager. These values will override the values detected from the browser.Overrides | undefined

scripts?Dynamically load scripts based on consent state.{} | undefinedlink

ssrData?SSR-prefetched data for hydration.Promise<SSRInitialData | undefined>link

storageConfig?Storage configuration for consent persistence.StorageConfig | undefined

user?The user's information. Usually your own internal ID for the user from your auth provider.User | undefinedlink

consentCategories?Consent categories to show in the consent banner.{} | undefinedlink

translations?Translation configuration to seed the store with.Partial<TranslationConfig>link

colorScheme?Color scheme preference. With this option, you can force the theme to be light, dark or system. Otherwise, the theme will be detected if you have '.dark' classname in your document."light" | "dark" | "system" | undefinedlink

disableAnimation?Whether to disable animations.boolean | undefined

noStyle?Whether to disable default styles.boolean | undefinedlink

scrollLock?Whether to lock scroll when dialogs are open.boolean | undefined

theme?Visual theme to apply.Theme | undefinedlink

trapFocus?Whether to trap focus within dialogs.boolean | undefined

childrenReact children to render within the provider.requiredReactNode

optionsConfiguration options for the consent manager. This includes core, React, store, and translation settings.requiredConsentManagerOptions

onBannerFetched?Called when the consent banner is fetched.Callback<OnBannerFetchedPayload> | undef...

onBeforeConsentRevocationReload?Called before the page reloads when consent is revoked.Callback<OnConsentSetPayload> | undefine...

onConsentSet?Called when the consent is set.Callback<OnConsentSetPayload> | undefine...

onError?Called when an error occurs.Callback<OnErrorPayload> | undefined

cmpVersion?CMP version. When omitted, defaults to package version from `~/cmp-defaults` (which uses ~/version).string | number | undefined

customVendors?Custom vendors not registered with IAB. These are displayed separately in the consent UI with a note that they have different privacy practices than IAB vendors.{} | undefined

enabledEnable IAB TCF 2.3 mode. When enabled, c15t will: - Fetch GVL from gvl.consent.io - Initialize __tcfapi CMP API - Generate TC Strings for IAB compliance Note: Only works in 'c15t' client mode (requires backend)requiredboolean

gvl?Pre-loaded Global Vendor List for testing or SSR. When provided, skips network fetch entirely. This is useful for: - Testing (avoids network calls and mocking complexity) - SSR (use server-fetched GVL) - Offline/air-gapped deployments

isServiceSpecific?Whether consent is service-specific (not global).boolean | undefined

publisherCountryCode?Publisher country code (2-letter ISO).string | undefined

vendors?IAB-registered vendor IDs to include (optional). Used to scope the vendor list when fetching GVL or when c15t fallback paths are used (e.g. if GVL fetch fails).{} | undefined

enabled?Whether the network blocker is enabled.boolean | undefined

initialConsents?The consent state snapshot that is currently used for blocking logic.Promise<SSRI

logBlockedRequests?Whether to automatically log blocked requests to the console.boolean | undefined

onRequestBlocked?Callback invoked whenever a request is blocked.((info: BlockedRequestInfo) => void) | u...

rulesDomain rules that determine which requests should be blocked.required{}

country?Country code to forcefully setstring | undefined

gpc?Override the Global Privacy Control (GPC) signal. When `true`, simulates GPC being active (opt-out of marketing/measurement). When `false`, suppresses the real browser GPC signal. When `undefined`, falls back to the browser's `navigator.globalPrivacyControl`.boolean | undefined

language?Language code to forcefully setstring | undefined

region?Region code to forcefully setstring | undefined

crossSubdomain?Enable cross-subdomain cookies by defaultboolean | undefined

defaultDomain?Custom default domain for cookiesstring | undefined

defaultExpiryDays?Default cookie expiration in daysnumber | undefined

storageKey?Custom storage key for localStorage and cookiesstring | undefined

idUsually your own internal ID for the user from your auth providerrequiredstring

identityProvider?The identity provider of the user. Usually the name of the identity provider e.g. 'clerk', 'auth0', 'custom', etc.string | undefined

colors?Color palette for light mode.ColorTokens | undefined

dark?Dark mode color overrides.ColorTokens | undefined

motion?Animation and transition timing.MotionTokens | undefined

radius?Border radius scale for rounded corners.RadiusTokens | undefined

shadows?Box shadow scale for depth and elevation.ShadowTokens | undefined

slots?Component-specific style overrides.ComponentSlots | undefined

spacing?Spacing scale for internal padding and margins.SpacingTokens | undefined