{/* This file is NOT rendered directly. Sections are imported by framework pages. */}
> ℹ️ **Info:**
> Must be used within a ConsentManagerProvider. Throws an error if used outside the provider.
## State Properties
| Property | Type | Description | Default | Required |
| :-------------------------- | :----------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------ | :--------: |
| branding | Branding | Whether to show the branding. "consent" is a deprecated alias for "inth". | - | ✅ Required |
| consents | ConsentState | Current consent states for all consent types | - | ✅ Required |
| selectedConsents | ConsentState | Selected consents (Not Saved) - use saveConsents to save | - | ✅ Required |
| consentInfo | ConsentInfo \| null | Information about when and how consent was given | - | ✅ Required |
| activeUI | ActiveUI | Which consent UI component is currently visible. | - | ✅ Required |
| isLoadingConsentInfo | boolean | Whether consent banner information is currently being loaded | - | ✅ Required |
| hasFetchedBanner | boolean | Whether consent banner information has been successfully fetched | - | ✅ Required |
| lastBannerFetchData | any | Last consent banner fetch data for callback replay | - | ✅ Required |
| debug | boolean | Whether debug logging is enabled | - | ✅ Required |
| consentCategories | AllConsentNames\[] | Active consent categories | - | ✅ Required |
| locationInfo | LocationInfo \| null | Subject's location information | - | ✅ Required |
| includeNonDisplayedConsents | boolean | Whether to include non-displayed consents in operations | - | ✅ Required |
| consentTypes | ConsentType\[] | Available consent type configurations | - | ✅ Required |
| iframeBlockerConfig | IframeBlockerConfig | Configuration for the iframe blocker | - | ✅ Required |
| loadedScripts | Record\ | Map of currently loaded script IDs to a boolean loaded-state | - | ✅ Required |
| scriptIdMap | Record\ | Map of anonymized script IDs to their original IDs | - | ✅ Required |
| model | Model | What type of consent model to use for the consent manager.
- 'opt-in' - Requires explicit consent before non-essential cookies or tracking. (GDPR Style)
- 'opt-out' - Allows processing until the user exercises a right to opt out. (CCPA Style)
- 'iab' - IAB TCF 2.3 mode for programmatic advertising compliance. (GDPR jurisdictions only) | - | ✅ Required |
| policyBanner | PolicySurfaceState | Policy-driven UI hints for the consent banner surface. | - | ✅ Required |
| policyDialog | PolicySurfaceState | Policy-driven UI hints for the consent dialog surface. | - | ✅ Required |
| policyCategories | string\[] \| null | Active runtime policy category scope from \`/init\`. | - | ✅ Required |
| policyScopeMode | any | Runtime policy scope mode from \`/init\`.
Controls whether out-of-scope categories are treated as permissive at runtime. | - | ✅ Required |
| initDataSource | InitDataSource \| null | Source that provided the most recent \`/init\` payload used to hydrate runtime state. | - | ✅ Required |
| initDataSourceDetail | string \| null | Optional source detail for diagnostics (for example, cache header values). | - | ✅ Required |
| iab | IABManager \| null | IAB TCF 2.3 state and actions (null when not configured or not in IAB mode). | - | ✅ Required |
| reloadOnConsentRevoked | boolean | Whether to reload the page when consent is revoked. | - | ✅ Required |
| ssrDataUsed | boolean | Whether SSR data was successfully used for initialization. | - | ✅ Required |
| ssrSkippedReason | SSRSkippedReason | Reason SSR data was skipped, if applicable. | - | ✅ Required |
## Action Methods
| Property | Type | Description | Default | Required |
| :---------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------- | :------ | :--------: |
| setTranslationConfig | (config: TranslationConfig) => void | Updates the translation configuration. | - | ✅ Required |
| setOverrides | (overrides: Overrides \| undefined) => Promise\ | Sets the overrides for the consent manager.
Automatically attempts to fetch the consent manager again with the new overrides. | - | ✅ Required |
| setLanguage | (language: string) => Promise\ | Set the language override for the consent manager. This will override the language detected from the browser and re-fetch the consent banner information. | - | ✅ Required |
| identifyUser | (user: User) => Promise\ | Identifies the user by setting the external ID. | - | ✅ Required |
| unstable\_acceptPolicyConsent | (input: UnstablePolicyConsentInput) => Promise\ | Writes a policy-based consent such as terms and conditions. | - | ✅ Required |
| setSelectedConsent | (name: AllConsentNames, value: boolean) => void | Updates the selected consent state for a specific consent type. | - | ✅ Required |
| saveConsents | (type: "necessary" \| "custom" \| "all", options?: \{ uiSource?: string \| undefined; } \| undefined) => Promise\ | Saves the user's consent preferences. | - | ✅ Required |
| setConsent | (name: AllConsentNames, value: boolean) => void | Updates the consent state for a specific consent type & automatically save the consent. | - | ✅ Required |
| resetConsents | () => void | Resets all consent preferences to their default values | - | ✅ Required |
| setActiveUI | (ui: ActiveUI, options?: \{ force?: boolean \| undefined; } \| undefined) => void | Sets the active consent UI component. | - | ✅ Required |
| setConsentCategories | (types: AllConsentNames\[]) => void | Updates the active GDPR consent types. | - | ✅ Required |
| setCallback | (name: keyof Callbacks, callback: Callback\ \| Callback\ \| Callback\ \| Callback\ \| undefined) => void | Sets a callback for a specific consent event. | - | ✅ Required |
| subscribeToConsentChanges | (listener: (payload: OnConsentChangedPayload) => void) => () => void | Subscribes to change-only consent saves. | - | ✅ Required |
| setLocationInfo | (location: LocationInfo \| null) => void | Updates the user's location information. | - | ✅ Required |
| initConsentManager | () => Promise\ | Initializes the consent manager by fetching jurisdiction, location, translations, and branding information. | - | ✅ Required |
| getDisplayedConsents | () => ConsentType\[] | Retrieves the list of consent types that should be displayed | - | ✅ Required |
| hasConsented | () => boolean | Checks if the user has provided any form of consent | - | ✅ Required |
| has | \(condition: HasCondition\) => boolean | Evaluates whether current consent state satisfies the given condition. | - | ✅ Required |
| setScripts | (scripts: Script\[]) => void | Sets multiple script configurations to the store. | - | ✅ Required |
| removeScript | (scriptId: string) => void | Removes a script configuration from the store. | - | ✅ Required |
| updateScripts | () => \{ loaded: string\[]; unloaded: string\[]; } | Updates scripts based on current consent state.
Loads scripts that have consent and aren't loaded yet.
Unloads scripts that no longer have consent. | - | ✅ Required |
| isScriptLoaded | (scriptId: string) => boolean | Checks if a script is currently loaded. | - | ✅ Required |
| getLoadedScriptIds | () => string\[] | Gets all currently loaded script IDs. | - | ✅ Required |
| initializeIframeBlocker | () => void | Initializes the iframe blocker instance. | - | ✅ Required |
| updateIframeConsents | () => void | Updates the active consents used by the iframe blocker. | - | ✅ Required |
| destroyIframeBlocker | () => void | Destroys the iframe blocker instance and cleans up resources. | - | ✅ Required |
| initializeNetworkBlocker | () => void | Initializes the network blocker instance. | - | ✅ Required |
| updateNetworkBlockerConsents | () => void | Updates the consent snapshot used by the network blocker. | - | ✅ Required |
| setNetworkBlocker | (config: NetworkBlockerConfig \| undefined) => void | Updates the network blocker configuration at runtime. | - | ✅ Required |
| destroyNetworkBlocker | () => void | Destroys the network blocker instance and cleans up resources. | - | ✅ Required |
| updateConsentCategories | (newCategories: AllConsentNames\[]) => void | Extends the active GDPR consent categories with any categories used by
configured scripts. | - | ✅ Required |
## Key Types
`ConsentState`
A record mapping consent category names to their boolean values:
```ts
type ConsentState = Record;
// Example: { necessary: true, measurement: true, marketing: false }
```
`ConsentInfo`
Metadata about when and how consent was recorded:
```ts
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:
```ts
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:
```ts
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