@c15t/react 3.0.0-alpha.3 → 3.0.0-alpha.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +92 -72
- package/README.md +21 -17
- package/SKILL.md +34 -0
- package/dist/component-hooks/use-headless-consent-ui.js +1 -1
- package/dist/component-hooks/use-headless-iab-consent-ui.js +1 -1
- package/dist/components/consent-gate/atoms.js +1 -1
- package/dist/components/consent-gate/consent-gate.js +1 -1
- package/dist/components/iab-panel/atoms/card.js +1 -1
- package/dist/components/iab-panel/atoms/feature-item.js +2 -0
- package/dist/components/iab-panel/atoms/header.js +1 -1
- package/dist/components/iab-panel/iab-panel.js +1 -1
- package/dist/components/iab-panel/index.js +1 -1
- package/dist/components/iab-prompt/atoms/overlay.js +1 -1
- package/dist/components/iab-prompt/atoms/root.js +1 -1
- package/dist/components/panel/atoms/card.js +1 -1
- package/dist/components/panel/atoms/root.js +1 -1
- package/dist/components/panel-trigger/atoms/button.js +1 -1
- package/dist/components/panel-trigger/atoms/toolbar.js +1 -1
- package/dist/components/preferences/atoms/accordion.js +1 -1
- package/dist/components/prompt/atoms/overlay.js +1 -1
- package/dist/components/prompt/atoms/root.js +1 -1
- package/dist/components/prompt/components.js +1 -1
- package/dist/components/shared/libs/compose-refs.js +1 -0
- package/dist/components/shared/libs/slot.js +1 -1
- package/dist/components/shared/primitives/button.js +1 -1
- package/dist/components/shared/ui/dialog/dialog.js +1 -1
- package/dist/components/shared/ui/icon.js +1 -1
- package/dist/context/consent-tracking-context.js +1 -1
- package/dist/devtools.js +1 -1
- package/dist/draft-context.js +2 -0
- package/dist/draft.js +1 -1
- package/dist/external-iab-context.js +1 -1
- package/dist/gpp.js +2 -0
- package/dist/hooks/use-color-scheme.js +1 -1
- package/dist/hooks/use-focus-trap.js +1 -1
- package/dist/hooks.js +1 -1
- package/dist/iab/styles.tw3.css +4 -4
- package/dist/index-parts/consent-banner.js +1 -0
- package/dist/index-parts/consent-dialog-link.js +1 -0
- package/dist/index-parts/consent-dialog-trigger.js +1 -0
- package/dist/index-parts/consent-dialog.js +1 -0
- package/dist/index-parts/consent-gate.js +1 -0
- package/dist/index-parts/core.js +1 -0
- package/dist/index-parts/draft.js +1 -0
- package/dist/index-parts/hooks.js +1 -0
- package/dist/index-parts/module-hooks.js +1 -0
- package/dist/index-parts/provider.js +1 -0
- package/dist/index-parts/theme.js +1 -0
- package/dist/index-parts/translations.js +1 -0
- package/dist/index.js +1 -1
- package/dist/kernel-selector.js +1 -1
- package/dist/module-hooks/iframe-blocker.js +1 -1
- package/dist/postcss-tailwind3.js +1 -0
- package/dist/provider.js +1 -1
- package/dist/server/fetch-ssr-data.js +1 -1
- package/dist/server/headers.js +1 -1
- package/dist/server/normalize-url.js +1 -1
- package/dist/styles.tw3.css +16 -16
- package/dist/transports/offline.js +1 -1
- package/dist/utils/merge-slot-props.js +1 -1
- package/dist/utils/theme-utils.js +1 -1
- package/dist/version.js +1 -1
- package/dist-types/component-hooks/use-headless-consent-ui.d.ts +1 -1
- package/dist-types/components/iab-panel/atoms/feature-item.d.ts +28 -0
- package/dist-types/components/iab-panel/iab-panel.d.ts +2 -2
- package/dist-types/components/iab-panel/index.d.ts +5 -2
- package/dist-types/components/iab-panel/use-iab-translations.d.ts +4 -0
- package/dist-types/components/iab-prompt/iab-prompt.d.ts +2 -2
- package/dist-types/components/iab-prompt/index.d.ts +2 -2
- package/dist-types/components/panel/atoms/card.d.ts +1 -0
- package/dist-types/components/prompt/components.d.ts +6 -0
- package/dist-types/components/shared/libs/compose-refs.d.ts +20 -0
- package/dist-types/components/shared/ui/icon.d.ts +2 -1
- package/dist-types/context/consent-tracking-context.d.ts +10 -0
- package/dist-types/context/theme-context.d.ts +2 -2
- package/dist-types/context.d.ts +6 -0
- package/dist-types/devtools.d.ts +13 -2
- package/dist-types/draft-context.d.ts +31 -0
- package/dist-types/draft.d.ts +13 -30
- package/dist-types/gpp.d.ts +27 -0
- package/dist-types/hooks/use-focus-trap.d.ts +3 -1
- package/dist-types/hooks.d.ts +57 -13
- package/dist-types/iab.d.ts +1 -1
- package/dist-types/index-parts/consent-banner.d.ts +7 -0
- package/dist-types/index-parts/consent-dialog-link.d.ts +7 -0
- package/dist-types/index-parts/consent-dialog-trigger.d.ts +7 -0
- package/dist-types/index-parts/consent-dialog.d.ts +7 -0
- package/dist-types/index-parts/consent-gate.d.ts +7 -0
- package/dist-types/index-parts/core.d.ts +8 -0
- package/dist-types/index-parts/draft.d.ts +7 -0
- package/dist-types/index-parts/hooks.d.ts +7 -0
- package/dist-types/index-parts/module-hooks.d.ts +7 -0
- package/dist-types/index-parts/provider.d.ts +7 -0
- package/dist-types/index-parts/theme.d.ts +8 -0
- package/dist-types/index-parts/translations.d.ts +7 -0
- package/dist-types/index.d.ts +14 -15
- package/dist-types/kernel-selector.d.ts +0 -8
- package/dist-types/module-hooks/iframe-blocker.d.ts +12 -7
- package/dist-types/postcss-tailwind3.d.ts +21 -0
- package/dist-types/provider.d.ts +57 -17
- package/dist-types/server/headers.d.ts +14 -4
- package/dist-types/server/normalize-url.d.ts +14 -7
- package/dist-types/server/types.d.ts +12 -1
- package/dist-types/transports/offline.d.ts +7 -16
- package/dist-types/ui-config-context.d.ts +7 -1
- package/dist-types/utils/merge-slot-props.d.ts +15 -1
- package/dist-types/utils/theme-utils.d.ts +17 -2
- package/dist-types/version.d.ts +1 -1
- package/docs/README.md +92 -72
- package/docs/assets/v3/bottom-bar.png +0 -0
- package/docs/assets/v3/brand-card.png +0 -0
- package/docs/assets/v3/brand-preferences.png +0 -0
- package/docs/assets/v3/choice-wall.png +0 -0
- package/docs/assets/v3/headless-bar-html.png +0 -0
- package/docs/assets/v3/headless-bar-mobile.png +0 -0
- package/docs/assets/v3/headless-bar.png +0 -0
- package/docs/assets/v3/slim-bar.png +0 -0
- package/docs/concepts/choose-your-setup.md +87 -0
- package/docs/{frameworks/react/concepts → concepts}/consent-categories.md +22 -7
- package/docs/{guides → concepts}/consent-state.md +89 -105
- package/docs/{guides → concepts}/data-fetching.md +31 -27
- package/docs/concepts/how-consent-works.md +123 -0
- package/docs/{frameworks/react/concepts/policy-presets.md → concepts/policies.md} +7 -59
- package/docs/customization/class-names.md +202 -0
- package/docs/customization/dark-mode.md +157 -0
- package/docs/customization/motion.md +119 -0
- package/docs/customization/overview.md +67 -34
- package/docs/customization/recipes.md +839 -49
- package/docs/customization/slots.md +216 -35
- package/docs/customization/stylesheets.md +147 -0
- package/docs/customization/tailwind.md +842 -0
- package/docs/customization/tokens.md +163 -96
- package/docs/customization/translations.md +60 -3
- package/docs/frameworks/react/callbacks.md +118 -0
- package/docs/frameworks/react/clear-on-revocation.md +106 -0
- package/docs/frameworks/react/components/consent-banner.md +42 -28
- package/docs/frameworks/react/components/consent-dialog-link.md +13 -11
- package/docs/frameworks/react/components/consent-dialog-trigger.md +81 -76
- package/docs/frameworks/react/components/consent-dialog.md +56 -50
- package/docs/frameworks/react/components/consent-gate.md +37 -20
- package/docs/frameworks/react/components/consent-provider.md +130 -0
- package/docs/frameworks/react/components/consent-widget.md +23 -20
- package/docs/frameworks/react/components/dev-tools.md +53 -85
- package/docs/frameworks/react/components.md +105 -0
- package/docs/frameworks/react/compose.md +354 -0
- package/docs/frameworks/react/content-security-policy.md +126 -0
- package/docs/frameworks/react/customize.md +250 -0
- package/docs/frameworks/react/embeds.md +89 -0
- package/docs/frameworks/react/gpp.md +163 -0
- package/docs/frameworks/react/{hooks/overview.md → hooks.md} +21 -16
- package/docs/frameworks/react/{iab/overview.md → iab.md} +80 -31
- package/docs/frameworks/react/network-blocker.md +35 -41
- package/docs/frameworks/react/quickstart.md +139 -101
- package/docs/frameworks/react/rendering.md +128 -0
- package/docs/frameworks/react/scripts.md +115 -0
- package/docs/frameworks/react/translations.md +155 -0
- package/docs/frameworks/react/troubleshooting.md +92 -47
- package/docs/frameworks/react/vendor-consent.md +170 -0
- package/docs/guides/banner-experiments.md +654 -0
- package/docs/guides/troubleshooting.md +120 -47
- package/docs/guides/verify-consent.md +81 -49
- package/docs/integrations/adobe-analytics.md +167 -159
- package/docs/integrations/ahrefs-analytics.md +152 -154
- package/docs/integrations/amplitude.md +162 -156
- package/docs/integrations/building-integrations.md +136 -37
- package/docs/integrations/clearbit.md +154 -154
- package/docs/integrations/cloudflare-web-analytics.md +156 -156
- package/docs/integrations/cloudflare-zaraz.md +209 -261
- package/docs/integrations/crisp.md +164 -158
- package/docs/integrations/databuddy.md +157 -173
- package/docs/integrations/fathom-analytics.md +158 -156
- package/docs/integrations/front-chat.md +167 -167
- package/docs/integrations/google-maps.md +118 -83
- package/docs/integrations/google-tag-manager.md +178 -163
- package/docs/integrations/google-tag.md +163 -160
- package/docs/integrations/heap.md +163 -155
- package/docs/integrations/hightouch.md +161 -157
- package/docs/integrations/hotjar.md +159 -155
- package/docs/integrations/intercom.md +183 -153
- package/docs/integrations/klaviyo.md +486 -0
- package/docs/integrations/linkedin-insights.md +174 -150
- package/docs/integrations/logrocket.md +160 -156
- package/docs/integrations/matomo-analytics.md +188 -178
- package/docs/integrations/meta-pixel.md +188 -150
- package/docs/integrations/microsoft-clarity.md +163 -155
- package/docs/integrations/microsoft-uet.md +148 -154
- package/docs/integrations/mixpanel-analytics.md +155 -160
- package/docs/integrations/one-dollar-stats.md +166 -165
- package/docs/integrations/openai-pixel.md +204 -301
- package/docs/integrations/overview.md +137 -80
- package/docs/integrations/pinterest-tag.md +191 -183
- package/docs/integrations/pirsch.md +169 -159
- package/docs/integrations/plausible-analytics.md +172 -158
- package/docs/integrations/posthog.md +313 -240
- package/docs/integrations/promptwatch.md +154 -154
- package/docs/integrations/reddit-pixel.md +185 -157
- package/docs/integrations/rudderstack.md +201 -186
- package/docs/integrations/rybbit-analytics.md +171 -160
- package/docs/integrations/segment.md +182 -154
- package/docs/integrations/snapchat-pixel.md +186 -156
- package/docs/integrations/tiktok-pixel.md +171 -150
- package/docs/integrations/umami-analytics.md +163 -158
- package/docs/integrations/vercel-analytics.md +166 -157
- package/docs/integrations/x-pixel.md +176 -150
- package/docs/integrations/youtube.md +121 -86
- package/docs/upgrade-v3.md +496 -467
- package/package.json +20 -9
- package/dist/ui-save.js +0 -1
- package/dist-types/ui-save.d.ts +0 -25
- package/docs/assets/v3/brand-bar.png +0 -0
- package/docs/assets/v3/mobile-card.png +0 -0
- package/docs/assets/v3/preferences.png +0 -0
- package/docs/frameworks/react/components/consent-manager-provider.md +0 -95
- package/docs/frameworks/react/script-loader.md +0 -69
- package/docs/frameworks/react/styling/overview.md +0 -266
- package/docs/guides/deployment-modes.md +0 -75
- package/docs/guides/shared-consent-controls.md +0 -158
- package/docs/integrations/clear-on-revocation.md +0 -167
- package/docs/integrations/granular-consent.md +0 -210
package/dist-types/provider.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
import type { AllConsentNames, ClearOnRevocationConfig, ConsentPresentation,
|
|
1
|
+
import type { AllConsentNames, Callbacks, ClearOnRevocationConfig, ConsentExperiment, ConsentPresentation, ExperimentState, I18nConfig, KernelConfig, KernelOverrides, KernelUser, LegalLinks, ProviderTransportFactory, StorageConfig, User, Vendor } from '@c15t/core';
|
|
2
2
|
import type { Script } from '@c15t/core/modules/script-loader';
|
|
3
|
-
import type { ConsentControlOptions
|
|
3
|
+
import type { ConsentControlOptions } from '@c15t/core/runtime';
|
|
4
|
+
import type { ConsentRuntime, ResolveStreamedInit } from '@c15t/core/runtime/provider';
|
|
4
5
|
import type { ReactNode } from 'react';
|
|
5
6
|
import type { DialogPreload } from './chunk-warming.js';
|
|
6
7
|
import type { UseNetworkBlockerOptions, UsePersistenceOptions, UseScriptLoaderOptions } from './module-hooks.js';
|
|
@@ -8,12 +9,23 @@ import type { UseIframeBlockerOptions } from './module-hooks/iframe-blocker.js';
|
|
|
8
9
|
import type { ReactUIOptions } from './types/manager.js';
|
|
9
10
|
import type { ReactComponentSlots } from './types/slots.js';
|
|
10
11
|
/** Events emitted by the mounted provider without snapshot-derived consent aliases. */
|
|
11
|
-
export type ConsentProviderCallbacks = Pick<Callbacks, 'onChoiceRecorded' | 'onPermissionsChanged' | 'onError' | 'onBeforeConsentRevocationReload'>;
|
|
12
|
-
/**
|
|
13
|
-
|
|
12
|
+
export type ConsentProviderCallbacks = Pick<Callbacks, 'onChoiceRecorded' | 'onPermissionsChanged' | 'onSurfaceShown' | 'onError' | 'onBeforeConsentRevocationReload'>;
|
|
13
|
+
/**
|
|
14
|
+
* Prepared policy and records; legacy consent projections are not provider
|
|
15
|
+
* inputs. An `experiment` a server helper resolved runs instead of
|
|
16
|
+
* `options.experiment`.
|
|
17
|
+
*/
|
|
18
|
+
export type ConsentProviderPrefetch = Omit<KernelConfig, 'initialDraft' | 'transport'> & ExperimentState;
|
|
14
19
|
export interface ConsentProviderOptions extends ConsentControlOptions, Pick<ReactUIOptions, 'colorScheme' | 'disableAnimation' | 'noStyle' | 'scrollLock' | 'theme' | 'trapFocus'> {
|
|
15
20
|
enabled?: boolean;
|
|
16
21
|
presentation?: ConsentPresentation;
|
|
22
|
+
/**
|
|
23
|
+
* A/B experiment on prompt/preferences presentation. The assigned arm is
|
|
24
|
+
* merged over `presentation`, exposed through `useExperiment()`, and
|
|
25
|
+
* recorded with every impression and choice. Initial-only: remount the
|
|
26
|
+
* provider to change the experiment.
|
|
27
|
+
*/
|
|
28
|
+
experiment?: ConsentExperiment;
|
|
17
29
|
/**
|
|
18
30
|
* Content Security Policy nonce applied to DOM nodes c15t injects.
|
|
19
31
|
*
|
|
@@ -45,6 +57,12 @@ export interface ConsentProviderOptions extends ConsentControlOptions, Pick<Reac
|
|
|
45
57
|
* ```
|
|
46
58
|
*/
|
|
47
59
|
mode: ProviderTransportFactory;
|
|
60
|
+
/**
|
|
61
|
+
* Where the visitor's choice is stored. Read once, like `persistence`:
|
|
62
|
+
* the stored records and the data clearing that protects them stay at
|
|
63
|
+
* the location the provider mounted with. Outside production, a change
|
|
64
|
+
* logs a warning; remount the provider to move storage.
|
|
65
|
+
*/
|
|
48
66
|
storageConfig?: StorageConfig;
|
|
49
67
|
user?: User | KernelUser;
|
|
50
68
|
overrides?: KernelOverrides;
|
|
@@ -112,6 +130,10 @@ export interface ConsentProviderOptions extends ConsentControlOptions, Pick<Reac
|
|
|
112
130
|
* is paused.
|
|
113
131
|
*/
|
|
114
132
|
iframeBlocker?: UseIframeBlockerOptions | false;
|
|
133
|
+
/**
|
|
134
|
+
* Store the visitor's choice in a cookie and localStorage. On by default.
|
|
135
|
+
* Read once, when the provider mounts; see `storageConfig`.
|
|
136
|
+
*/
|
|
115
137
|
persistence?: boolean | UsePersistenceOptions;
|
|
116
138
|
i18n?: Partial<I18nConfig>;
|
|
117
139
|
/** Categories to offer alongside discovered integration categories, within policy scope. */
|
|
@@ -139,6 +161,16 @@ export interface ConsentProviderOptions extends ConsentControlOptions, Pick<Reac
|
|
|
139
161
|
* @internal
|
|
140
162
|
*/
|
|
141
163
|
__debugPkg?: string;
|
|
164
|
+
/**
|
|
165
|
+
* The code that applies a `prefetch` promise, from
|
|
166
|
+
* `@c15t/core/runtime/streamed-init`. Without it the provider loads that
|
|
167
|
+
* code once `prefetch` is a promise, so an app that never streams one
|
|
168
|
+
* doesn't download it. A framework root whose state is usually streamed
|
|
169
|
+
* (`ConsentRoot`) passes it, so the state applies as soon as it arrives
|
|
170
|
+
* instead of after one more request. Read once, at mount.
|
|
171
|
+
* @internal
|
|
172
|
+
*/
|
|
173
|
+
__resolveStreamedInit?: ResolveStreamedInit;
|
|
142
174
|
}
|
|
143
175
|
/**
|
|
144
176
|
* Options accepted when an external runtime supplies the kernel.
|
|
@@ -147,13 +179,19 @@ export interface ConsentProviderOptions extends ConsentControlOptions, Pick<Reac
|
|
|
147
179
|
* Everything the component tree still owns — theme, slots, legal links —
|
|
148
180
|
* is unchanged.
|
|
149
181
|
*/
|
|
150
|
-
export type ExternalRuntimeProviderOptions = Omit<ConsentProviderOptions, 'mode' | 'vendors'> & {
|
|
182
|
+
export type ExternalRuntimeProviderOptions = Omit<ConsentProviderOptions, 'callbacks' | 'mode' | 'vendors'> & {
|
|
151
183
|
mode?: ConsentProviderOptions['mode'];
|
|
152
184
|
/**
|
|
153
185
|
* Not accepted here: the runtime owner declares vendors through
|
|
154
186
|
* `createConsentRuntime({ vendors })`, and the kernel carries them.
|
|
155
187
|
*/
|
|
156
188
|
vendors?: never;
|
|
189
|
+
/**
|
|
190
|
+
* Not accepted here: the runtime owner passes callbacks to
|
|
191
|
+
* `createConsentRuntime({ callbacks })`, and the runtime runs them.
|
|
192
|
+
* Passing them anyway logs a warning in development.
|
|
193
|
+
*/
|
|
194
|
+
callbacks?: never;
|
|
157
195
|
};
|
|
158
196
|
/** The provider builds and owns its own kernel. */
|
|
159
197
|
export interface OwnedRuntimeProviderProps {
|
|
@@ -170,19 +208,21 @@ export type ConsentProviderProps = OwnedRuntimeProviderProps | ExternalRuntimePr
|
|
|
170
208
|
/**
|
|
171
209
|
* v3 ConsentProvider.
|
|
172
210
|
*
|
|
173
|
-
*
|
|
174
|
-
*
|
|
175
|
-
*
|
|
176
|
-
*
|
|
177
|
-
*
|
|
178
|
-
*
|
|
211
|
+
* Builds one consent runtime (`createConsentProviderRuntime`) per mounted
|
|
212
|
+
* provider and renders its kernel: the kernel goes into context, and
|
|
213
|
+
* selector hooks subscribe to it through `useSyncExternalStore`. New
|
|
214
|
+
* options reach the runtime through `update()`, which applies only what
|
|
215
|
+
* changed; `mode`, `i18n`, `experiment`, `prefetch`, `persistence`,
|
|
216
|
+
* `storageConfig` and `clearOnRevocation` are read once. While `enabled` is
|
|
217
|
+
* `false` the runtime renders a separate permissive kernel, so toggling it
|
|
218
|
+
* keeps the visitor's records.
|
|
179
219
|
*
|
|
180
220
|
* Pass `runtime` to render a runtime someone else created. The provider
|
|
181
|
-
* then borrows its kernel and
|
|
182
|
-
*
|
|
183
|
-
*
|
|
184
|
-
*
|
|
185
|
-
*
|
|
221
|
+
* then borrows its kernel and starts nothing — no second `init()`, no
|
|
222
|
+
* second persistence handle, no second `window.c15t` — and does not
|
|
223
|
+
* dispose it on unmount. Handing it a different runtime switches the tree
|
|
224
|
+
* to that runtime's kernel; switching between a borrowed runtime and a
|
|
225
|
+
* provider-built one still needs a remount.
|
|
186
226
|
*
|
|
187
227
|
* @example
|
|
188
228
|
* ```tsx
|
|
@@ -1,5 +1,10 @@
|
|
|
1
|
-
declare const FORWARDED_HEADERS: readonly ["x-c15t-country", "cf-ipcountry", "x-vercel-ip-country", "x-amz-cf-ipcountry", "x-country-code", "x-country", "x-c15t-region", "cf-region-code", "x-vercel-ip-country-region", "x-region-code", "accept-language", "x-c15t-gpc", "sec-gpc", "x-c15t-version", "user-agent", "x-forwarded-
|
|
2
|
-
|
|
1
|
+
declare const FORWARDED_HEADERS: readonly ["x-c15t-country", "cf-ipcountry", "x-vercel-ip-country", "x-amz-cf-ipcountry", "x-country-code", "x-country", "x-c15t-region", "cf-region-code", "x-vercel-ip-country-region", "x-region-code", "accept-language", "x-c15t-gpc", "sec-gpc", "x-c15t-version", "user-agent", "x-forwarded-for", "purpose", "sec-purpose", "next-router-prefetch", "x-middleware-prefetch"];
|
|
2
|
+
/**
|
|
3
|
+
* Forwarding headers a client can set to name a host or scheme. Passed to
|
|
4
|
+
* the backend only when the app trusts them.
|
|
5
|
+
*/
|
|
6
|
+
export declare const CLIENT_FORWARDING_HEADERS: readonly ['forwarded', 'x-forwarded-host', 'x-forwarded-proto'];
|
|
7
|
+
type ForwardedHeader = (typeof FORWARDED_HEADERS)[number] | (typeof CLIENT_FORWARDING_HEADERS)[number];
|
|
3
8
|
type RelevantHeaders = Partial<Record<ForwardedHeader, string>>;
|
|
4
9
|
/**
|
|
5
10
|
* Extracts relevant headers for consent management from the request headers.
|
|
@@ -12,10 +17,13 @@ type RelevantHeaders = Partial<Record<ForwardedHeader, string>>;
|
|
|
12
17
|
* The extracted headers include:
|
|
13
18
|
* - Country headers (cf-ipcountry, x-vercel-ip-country, etc.)
|
|
14
19
|
* - Region headers (x-vercel-ip-country-region, x-region-code)
|
|
15
|
-
* - Standard headers (accept-language, user-agent, x-forwarded
|
|
20
|
+
* - Standard headers (accept-language, user-agent, x-forwarded-for)
|
|
16
21
|
* - Prefetch headers (purpose, sec-purpose, next-router-prefetch, x-middleware-prefetch)
|
|
17
22
|
*
|
|
18
23
|
* @param headersList - The Headers object from the incoming request
|
|
24
|
+
* @param options - `trustForwardedHeaders` also copies `forwarded`,
|
|
25
|
+
* `x-forwarded-host` and `x-forwarded-proto`, which any client can send.
|
|
26
|
+
* Leave it off unless a proxy you control sets them and drops incoming ones.
|
|
19
27
|
* @returns An object containing the relevant headers for consent management
|
|
20
28
|
*
|
|
21
29
|
* @example
|
|
@@ -28,5 +36,7 @@ type RelevantHeaders = Partial<Record<ForwardedHeader, string>>;
|
|
|
28
36
|
*
|
|
29
37
|
* @public
|
|
30
38
|
*/
|
|
31
|
-
export declare const extractRelevantHeaders: (headersList: Headers
|
|
39
|
+
export declare const extractRelevantHeaders: (headersList: Headers, options?: {
|
|
40
|
+
trustForwardedHeaders?: boolean;
|
|
41
|
+
}) => RelevantHeaders;
|
|
32
42
|
export {};
|
|
@@ -21,16 +21,21 @@ export declare const validateBackendURL: (backendURL: string) => {
|
|
|
21
21
|
normalizedURL: string;
|
|
22
22
|
};
|
|
23
23
|
/**
|
|
24
|
-
* Normalizes a backend URL, resolving relative URLs
|
|
24
|
+
* Normalizes a backend URL, resolving relative URLs against the request.
|
|
25
25
|
*
|
|
26
26
|
* @remarks
|
|
27
27
|
* For absolute URLs, returns the URL as-is (with trailing slash trimmed).
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
28
|
+
* A relative URL resolves against the `host` header: over `https` for a
|
|
29
|
+
* domain name, and over `http` for `localhost`, an IP address or a
|
|
30
|
+
* single-label host. `x-forwarded-host`, `x-forwarded-proto` and `forwarded`
|
|
31
|
+
* are read only when `trustForwardedHeaders` is set, because any client can
|
|
32
|
+
* send them; the `referer` header is never used.
|
|
31
33
|
*
|
|
32
34
|
* @param backendURL - The backend URL (absolute or relative)
|
|
33
35
|
* @param headersList - The Headers object from the incoming request
|
|
36
|
+
* @param options - `trustForwardedHeaders`: resolve against the request's
|
|
37
|
+
* forwarding headers. Set it only behind a proxy that sets them and drops
|
|
38
|
+
* incoming ones.
|
|
34
39
|
* @returns The normalized absolute URL, or null if it cannot be determined
|
|
35
40
|
*
|
|
36
41
|
* @example
|
|
@@ -41,11 +46,13 @@ export declare const validateBackendURL: (backendURL: string) => {
|
|
|
41
46
|
* normalizeBackendURL('https://api.example.com/', headers);
|
|
42
47
|
* // Returns: 'https://api.example.com'
|
|
43
48
|
*
|
|
44
|
-
* // Relative URL - resolved from
|
|
49
|
+
* // Relative URL - resolved from the host header
|
|
45
50
|
* normalizeBackendURL('/api/consent', headers);
|
|
46
|
-
* // Returns: 'https://example.com/api/consent' (
|
|
51
|
+
* // Returns: 'https://example.com/api/consent' (for `host: example.com`)
|
|
47
52
|
* ```
|
|
48
53
|
*
|
|
49
54
|
* @public
|
|
50
55
|
*/
|
|
51
|
-
export declare const normalizeBackendURL: (backendURL: string, headersList: Headers
|
|
56
|
+
export declare const normalizeBackendURL: (backendURL: string, headersList: Headers, options?: {
|
|
57
|
+
trustForwardedHeaders?: boolean;
|
|
58
|
+
}) => string | null;
|
|
@@ -12,9 +12,20 @@ import type { Overrides, SSRInitialData } from '@c15t/core';
|
|
|
12
12
|
export interface FetchSSRDataOptionsBase {
|
|
13
13
|
/**
|
|
14
14
|
* The backend URL to fetch consent data from.
|
|
15
|
-
* Can be absolute (https://...) or relative (/api/consent).
|
|
15
|
+
* Can be absolute (https://...) or relative (/api/consent). A relative
|
|
16
|
+
* URL resolves against the request's `host` header.
|
|
16
17
|
*/
|
|
17
18
|
backendURL: string;
|
|
19
|
+
/**
|
|
20
|
+
* Resolve a relative `backendURL` against the request's `forwarded`,
|
|
21
|
+
* `x-forwarded-host` and `x-forwarded-proto` headers instead of `host`.
|
|
22
|
+
* Any client can send those headers, so set this only behind a proxy
|
|
23
|
+
* that sets them and drops incoming ones. Also forwards those three
|
|
24
|
+
* headers to the backend, which is skipped otherwise.
|
|
25
|
+
*
|
|
26
|
+
* @default false
|
|
27
|
+
*/
|
|
28
|
+
trustForwardedHeaders?: boolean;
|
|
18
29
|
/**
|
|
19
30
|
* Optional overrides for geo-location.
|
|
20
31
|
*/
|
|
@@ -1,18 +1,9 @@
|
|
|
1
|
-
import type { ProviderTransportFactory } from '@c15t/core';
|
|
2
|
-
import type { PolicyRule } from '@c15t/schema/types';
|
|
3
|
-
/** Policy rules evaluated locally when initialization runs. */
|
|
4
|
-
export interface OfflineModeOptions {
|
|
5
|
-
/**
|
|
6
|
-
* Rules to resolve locally. Omit them to use `recommendedPolicyRules()`:
|
|
7
|
-
* strict opt-in for Europe, the UK, Quebec and unknown locations, opt-out
|
|
8
|
-
* for the US states with a privacy law, and `none` everywhere else.
|
|
9
|
-
* Passing rules replaces that pack entirely.
|
|
10
|
-
*/
|
|
11
|
-
policyRules?: PolicyRule[];
|
|
12
|
-
}
|
|
13
1
|
/**
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
2
|
+
* Offline mode for the React provider: core's `offline()`, which resolves
|
|
3
|
+
* policy rules locally and switches copy when `overrides.language` or
|
|
4
|
+
* `useSetLanguage()` names a language the bundle or `i18n.messages` has.
|
|
5
|
+
* The language a server prefetch detected from `Accept-Language` keeps the
|
|
6
|
+
* startup copy.
|
|
17
7
|
*/
|
|
18
|
-
export
|
|
8
|
+
export { offline } from '@c15t/core';
|
|
9
|
+
export type { OfflineModeOptions } from '@c15t/core';
|
|
@@ -1,9 +1,15 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { ConsentExperiment, ConsentPresentation, LegalLinks } from '@c15t/core';
|
|
2
2
|
import type { DialogPreload } from './chunk-warming.js';
|
|
3
3
|
import type { ReactComponentSlots } from './types/slots.js';
|
|
4
|
+
import type { Theme } from './types/theme/index.js';
|
|
4
5
|
export interface V3UIConfigValue {
|
|
5
6
|
components?: ReactComponentSlots;
|
|
7
|
+
/** The host's base presentation, before any experiment arm is applied. */
|
|
6
8
|
presentation?: ConsentPresentation;
|
|
9
|
+
/** The configured experiment; the assigned arm lives on the snapshot. */
|
|
10
|
+
experiment?: ConsentExperiment;
|
|
11
|
+
/** The host's base theme, before any experiment arm is applied. */
|
|
12
|
+
theme?: Theme;
|
|
7
13
|
legalLinks?: LegalLinks;
|
|
8
14
|
preloadDialog?: DialogPreload;
|
|
9
15
|
}
|
|
@@ -10,5 +10,19 @@ export declare const getSlotProps: (components: ReactComponentSlots | undefined,
|
|
|
10
10
|
export type MergedSlotProps = Omit<ReactSlotProps, 'style'> & {
|
|
11
11
|
style?: CSSPropertiesWithVars;
|
|
12
12
|
};
|
|
13
|
-
|
|
13
|
+
/**
|
|
14
|
+
* A `components` part, plus the `noStyle` flag a `theme.slots` entry puts
|
|
15
|
+
* on it through `applyThemeSlots`.
|
|
16
|
+
*/
|
|
17
|
+
type SlotPropsInput = ReactSlotProps & {
|
|
18
|
+
noStyle?: boolean;
|
|
19
|
+
};
|
|
20
|
+
/**
|
|
21
|
+
* Merge a `components` part with a component's own props.
|
|
22
|
+
*
|
|
23
|
+
* The stock `baseClassName` is dropped when the component's `noStyle` or
|
|
24
|
+
* the part's `noStyle` is set; the part's and the component's classes
|
|
25
|
+
* stay, as `resolveStyles` keeps theme slot classes under `noStyle`.
|
|
26
|
+
*/
|
|
27
|
+
export declare const mergeSlotProps: (slotProps: SlotPropsInput | undefined, { baseClassName, className, noStyle, style, ...ownProps }: MergeSlotPropsInput) => MergedSlotProps;
|
|
14
28
|
export {};
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
* Handles token-to-CSS variable conversion and dark mode overrides.
|
|
4
4
|
*/
|
|
5
5
|
import type { ThemeCSSVariables } from '@c15t/ui/theme';
|
|
6
|
+
import { generateThemeCSS as baseGenerateThemeCSS } from '@c15t/ui/theme';
|
|
6
7
|
import type { Theme } from '../types/theme/style-types.js';
|
|
7
8
|
/**
|
|
8
9
|
* Default design tokens for the v2 theme system.
|
|
@@ -13,6 +14,20 @@ export declare const defaultTheme: Required<Omit<Theme, 'slots'>>;
|
|
|
13
14
|
*/
|
|
14
15
|
export declare const themeToVars: (theme: Theme, isDark?: boolean) => ThemeCSSVariables;
|
|
15
16
|
/**
|
|
16
|
-
* Generates a CSS string for the theme variables
|
|
17
|
+
* Generates a CSS string for the theme variables, the same CSS as
|
|
18
|
+
* `generateThemeCSS` from `@c15t/ui/theme`.
|
|
19
|
+
*
|
|
20
|
+
* @param theme - Theme tokens to serialize.
|
|
21
|
+
* @param colorScheme - `'dark'` makes the dark tokens the default,
|
|
22
|
+
* `'system'` follows `prefers-color-scheme`, and `'light'` adds the stock
|
|
23
|
+
* dark palette under the dark classes. Omit it, or pass `null`, to write
|
|
24
|
+
* only the theme's own tokens.
|
|
25
|
+
* @returns Theme CSS for a `<style>` element or a stylesheet.
|
|
26
|
+
* @example
|
|
27
|
+
* ```ts
|
|
28
|
+
* import { generateThemeCSS } from '@c15t/react/utils';
|
|
29
|
+
*
|
|
30
|
+
* const css = generateThemeCSS({ dark: { primary: '#7fd1a8' } }, 'system');
|
|
31
|
+
* ```
|
|
17
32
|
*/
|
|
18
|
-
export declare const generateThemeCSS: (theme: Theme) => string;
|
|
33
|
+
export declare const generateThemeCSS: (theme: Theme, colorScheme?: Parameters<typeof baseGenerateThemeCSS>[1]) => string;
|
package/dist-types/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const version = "3.0.0-alpha.
|
|
1
|
+
export declare const version = "3.0.0-alpha.5";
|
package/docs/README.md
CHANGED
|
@@ -6,14 +6,16 @@ These docs ship inside the package so coding agents can read them offline. Open
|
|
|
6
6
|
|
|
7
7
|
## Using these docs
|
|
8
8
|
|
|
9
|
-
These docs describe v3.
|
|
9
|
+
These docs describe c15t v3. Find your app's row in Choose your setup, then follow that framework guide from start to finish; it names the files to create and the backend URL to use. Install c15t packages with the @alpha dist-tag, because npm latest is still v2. A visible banner does not prove anything: check that vendor requests wait for consent, that rejection survives a reload, and that preferences can be reopened.
|
|
10
10
|
|
|
11
11
|
## Start here
|
|
12
12
|
|
|
13
13
|
- [React quickstart](./frameworks/react/quickstart.md)
|
|
14
|
-
- [
|
|
15
|
-
- [
|
|
16
|
-
- [
|
|
14
|
+
- [Choose your setup](./concepts/choose-your-setup.md): Pick the c15t setup for your framework, rendering mode and hosting, and decide who runs the consent backend.
|
|
15
|
+
- [How consent works](./concepts/how-consent-works.md): What c15t decides on each page load, the difference between a permission and a recorded choice, and what happens when a visitor saves.
|
|
16
|
+
- [Customize the interface](./customization/overview.md): Change c15t's consent banner and dialog one step at a time, from a prop to your own markup, and find where each step lives in your framework.
|
|
17
|
+
- [Verify consent](./guides/verify-consent.md): Check in a production build that vendor requests wait for consent, rejection survives a reload, preferences reopen and privacy signals apply.
|
|
18
|
+
- [Migrate to v3](./upgrade-v3.md): Upgrade a c15t v2 app to v3. Covers packages, the Next.js and React providers, the JavaScript runtime, custom UI built on useConsentManager, callbacks, policies, stored consent and a self-hosted backend.
|
|
17
19
|
|
|
18
20
|
## More documentation
|
|
19
21
|
|
|
@@ -21,90 +23,108 @@ These docs describe v3. Start with Inth hosted setup, identify the framework, ro
|
|
|
21
23
|
|
|
22
24
|
## Frameworks
|
|
23
25
|
|
|
24
|
-
- [
|
|
26
|
+
- [Callbacks](./frameworks/react/callbacks.md): Run code in a React app when a visitor records a consent choice, when permissions change, when a request fails and before the revocation reload, with the ConsentProvider callbacks option.
|
|
27
|
+
- [Clear on revocation](./frameworks/react/clear-on-revocation.md): Delete the first-party cookies and Web Storage keys a consent category owns in a React app when that category is denied, with the clearOnRevocation option on ConsentProvider.
|
|
28
|
+
- [Components](./frameworks/react/components.md): Every c15t component a React app imports from c15t/react, what each renders, where each one mounts, and which to start with.
|
|
29
|
+
- [ConsentBanner](./frameworks/react/components/consent-banner.md): Render the c15t consent banner in a React app, choose its variant and position, and compose its parts.
|
|
25
30
|
- [ConsentDialog](./frameworks/react/components/consent-dialog.md): Open the c15t preference center as a modal ConsentDialog in a React app, wire its triggers and control blocking, focus and policy gating.
|
|
26
31
|
- [ConsentDialogLink](./frameworks/react/components/consent-dialog-link.md): Add a ConsentDialogLink to a React footer so visitors reopen the c15t preference center from your own text link, with asChild and rights data.
|
|
27
|
-
- [ConsentDialogTrigger](./frameworks/react/components/consent-dialog-trigger.md):
|
|
32
|
+
- [ConsentDialogTrigger](./frameworks/react/components/consent-dialog-trigger.md): Add the c15t ConsentDialogTrigger floating button or toolbar inside a React ConsentProvider so visitors can reopen the preference center after the first prompt.
|
|
28
33
|
- [ConsentGate](./frameworks/react/components/consent-gate.md): Gate a YouTube or map iframe behind consent with ConsentGate in React, showing a placeholder that opens the preference center until the category is allowed.
|
|
29
|
-
- [ConsentProvider](./frameworks/react/components/consent-
|
|
34
|
+
- [ConsentProvider](./frameworks/react/components/consent-provider.md): Mount ConsentProvider in a React app and configure its backend, scripts, storage, blocking and presentation options.
|
|
30
35
|
- [ConsentWidget](./frameworks/react/components/consent-widget.md): Embed the c15t preference center inline with ConsentWidget on a React privacy page, with draft toggles that record a choice only on Save.
|
|
31
|
-
- [DevTools](./frameworks/react/components/dev-tools.md):
|
|
32
|
-
- [
|
|
33
|
-
- [Policy
|
|
36
|
+
- [DevTools](./frameworks/react/components/dev-tools.md): Inspect consent state, location, loaded scripts and consent events in a React app during development with the c15t DevTools panel.
|
|
37
|
+
- [Compose your own banner](./frameworks/react/compose.md): Build a React consent banner from the ConsentBanner parts in c15t/react, with your own markup and buttons, while the policy still decides which actions appear.
|
|
38
|
+
- [Content Security Policy](./frameworks/react/content-security-policy.md): Run c15t in a React app under a Content Security Policy, allow the consent backend and vendor hosts, and pass a nonce to ConsentProvider and ConsentTheme.
|
|
39
|
+
- [Customize](./frameworks/react/customize.md): Change the colors, fonts, layout, button styles and copy of the c15t banner and dialog in a React app with the stylesheet, theme tokens, provider options and slots.
|
|
40
|
+
- [Embeds](./frameworks/react/embeds.md): Keep YouTube videos, maps and other iframes out of a React page until their consent category is allowed, with ConsentGate or the iframe blocker in ConsentProvider.
|
|
41
|
+
- [IAB GPP](./frameworks/react/gpp.md): Add the IAB Global Privacy Platform API (__gpp) to a React app with ConsentGPP from @c15t/react/gpp, so ad tech can read US state opt-outs and the TCF EU consent string.
|
|
34
42
|
- [Headless](./frameworks/react/headless.md): Build a custom consent banner in React with the c15t/react/headless hooks inside your ConsentProvider.
|
|
35
|
-
- [Hooks](./frameworks/react/hooks
|
|
36
|
-
- [IAB TCF](./frameworks/react/iab
|
|
37
|
-
- [
|
|
38
|
-
- [Quickstart](./frameworks/react/quickstart.md):
|
|
39
|
-
- [
|
|
40
|
-
- [
|
|
41
|
-
- [
|
|
43
|
+
- [Hooks](./frameworks/react/hooks.md): Gate features and save consent choices in React components with the focused hooks exported from c15t/react.
|
|
44
|
+
- [IAB TCF](./frameworks/react/iab.md): Mount the IAB TCF banner and dialog inside a React ConsentProvider and configure the CMP ID, policy and vendor data.
|
|
45
|
+
- [Network blocker](./frameworks/react/network-blocker.md): Hold fetch and XMLHttpRequest calls in a React app until their consent category is allowed, with networkBlocker rules in the ConsentProvider options.
|
|
46
|
+
- [Quickstart](./frameworks/react/quickstart.md): Add a consent banner, preferences dialog and consent-gated scripts to a React single-page app built with Vite, using Inth as the consent backend.
|
|
47
|
+
- [Rendering and deployment](./frameworks/react/rendering.md): How c15t resolves consent in client-rendered React apps, React Router framework mode, Remix and other server-rendered React apps without a c15t adapter.
|
|
48
|
+
- [Scripts](./frameworks/react/scripts.md): Load vendor scripts by consent category in a React app with ConsentProvider, and clear stored data or reload the page when a visitor withdraws consent.
|
|
49
|
+
- [Translations](./frameworks/react/translations.md): Where c15t banner and dialog copy comes from in a React app, how the browser picks the visitor's language, and how to override copy and switch languages with the provider's i18n option and hooks.
|
|
50
|
+
- [Troubleshooting](./frameworks/react/troubleshooting.md): Fix a missing banner, early vendor requests, unstyled components and theme warnings in a React app that uses c15t/react.
|
|
51
|
+
- [Vendor consent](./frameworks/react/vendor-consent.md): Let visitors allow a category such as marketing in a React app and still turn off one vendor in it, with the vendors option on ConsentProvider and useVendorAllowed.
|
|
52
|
+
|
|
53
|
+
## Concepts
|
|
54
|
+
|
|
55
|
+
- [Choose your setup](./concepts/choose-your-setup.md): Pick the c15t setup for your framework, rendering mode and hosting, and decide who runs the consent backend.
|
|
56
|
+
- [Consent categories](./concepts/consent-categories.md): Assign scripts, embeds and features to c15t consent categories, and understand which categories the preference dialog shows.
|
|
57
|
+
- [Consent state reference](./concepts/consent-state.md): How c15t saves choices, gates IAB vendors, hydrates server records and keeps browser tabs and storage in step.
|
|
58
|
+
- [Data fetching](./concepts/data-fetching.md): How c15t gets policy data through a cached manifest, backend /init, the browser or offline rules, and where consent choices are saved.
|
|
59
|
+
- [How consent works](./concepts/how-consent-works.md): What c15t decides on each page load, the difference between a permission and a recorded choice, and what happens when a visitor saves.
|
|
60
|
+
- [Policies](./concepts/policies.md): How policy models, prompts and scope decide what c15t asks visitors, where to change the rules, and why a banner may not appear.
|
|
42
61
|
|
|
43
62
|
## Guides
|
|
44
63
|
|
|
45
|
-
- [
|
|
46
|
-
- [
|
|
47
|
-
- [
|
|
48
|
-
- [Share consent controls across frameworks](./guides/shared-consent-controls.md): Use the same c15t script lifecycle, external consent source, and event controls in every framework.
|
|
49
|
-
- [Troubleshoot consent](./guides/troubleshooting.md): Diagnose missing banners, early vendor requests, lost choices and hydration differences.
|
|
50
|
-
- [Verify consent before shipping](./guides/verify-consent.md): Test requests, policy resolution, persistence, navigation and preference changes in a production build.
|
|
64
|
+
- [Banner experiments](./guides/banner-experiments.md): Run A/B tests on consent banner presentation with any feature-flag provider or built-in weighted assignment, and attribute every impression and choice to its arm.
|
|
65
|
+
- [Troubleshooting](./guides/troubleshooting.md): Fix a missing banner, analytics that load before consent, choices lost on reload, CORS errors, hydration differences and failed static builds in c15t v3.
|
|
66
|
+
- [Verify consent](./guides/verify-consent.md): Check in a production build that vendor requests wait for consent, rejection survives a reload, preferences reopen and privacy signals apply.
|
|
51
67
|
|
|
52
68
|
## Customization
|
|
53
69
|
|
|
54
|
-
- [
|
|
55
|
-
- [
|
|
56
|
-
- [
|
|
57
|
-
- [
|
|
70
|
+
- [Class names and CSS-in-JS](./customization/class-names.md): Style c15t's component parts with CSS Modules, vanilla-extract, StyleX, Emotion or plain class names, and see which approach works in each framework.
|
|
71
|
+
- [Dark mode](./customization/dark-mode.md): Switch c15t's banner and dialog to dark colors with colorScheme, set your own dark tokens, follow your site's theme switch, and paint dark on the first frame in every framework.
|
|
72
|
+
- [Motion and animation](./customization/motion.md): Change how fast c15t's banner and dialog animate with duration and easing tokens, turn animations off per surface with disableAnimation, and check reduced-motion behavior in each framework.
|
|
73
|
+
- [Customize the interface](./customization/overview.md): Change c15t's consent banner and dialog one step at a time, from a prop to your own markup, and find where each step lives in your framework.
|
|
74
|
+
- [Banner designs](./customization/recipes.md): Five consent banner designs built with c15t, from one prop to your own markup, with tested code for React, Vue, Svelte, Astro and plain HTML.
|
|
75
|
+
- [Component parts](./customization/slots.md): Find every part of c15t's banner, dialog, widget, trigger and ConsentGate placeholder, its key in your framework's part API, and the data attributes to select on.
|
|
76
|
+
- [Stylesheets and CSS layers](./customization/stylesheets.md): Load the right c15t stylesheet for your framework, see when the dialog's CSS loads, order c15t's cascade layer against your own, and run c15t without its styles.
|
|
77
|
+
- [Tailwind CSS](./customization/tailwind.md): Load c15t's styles next to Tailwind CSS 4 or 3 in every framework, put utilities on c15t component parts, and use Tailwind's dark variant with c15t.
|
|
78
|
+
- [Theme tokens](./customization/tokens.md): Change c15t's colors, type, radius, spacing, shadows and motion with theme tokens, and see every --c15t-* variable with its default.
|
|
58
79
|
- [Copy and translations](./customization/translations.md): Change consent wording through i18n and test the complete prompt and preferences flow.
|
|
59
80
|
|
|
60
81
|
## Integrations
|
|
61
82
|
|
|
62
|
-
- [Adobe Analytics](./integrations/adobe-analytics.md):
|
|
63
|
-
- [Ahrefs Analytics](./integrations/ahrefs-analytics.md):
|
|
64
|
-
- [Amplitude](./integrations/amplitude.md):
|
|
65
|
-
- [Custom integrations](./integrations/building-integrations.md):
|
|
66
|
-
- [
|
|
67
|
-
- [
|
|
68
|
-
- [Cloudflare
|
|
69
|
-
- [
|
|
70
|
-
- [
|
|
71
|
-
- [
|
|
72
|
-
- [
|
|
73
|
-
- [
|
|
74
|
-
- [Google
|
|
75
|
-
- [Google Tag](./integrations/google-tag.md):
|
|
76
|
-
- [
|
|
77
|
-
- [
|
|
78
|
-
- [
|
|
79
|
-
- [
|
|
80
|
-
- [
|
|
81
|
-
- [
|
|
82
|
-
- [
|
|
83
|
-
- [
|
|
84
|
-
- [
|
|
85
|
-
- [
|
|
86
|
-
- [Microsoft
|
|
87
|
-
- [
|
|
88
|
-
- [
|
|
89
|
-
- [
|
|
90
|
-
- [
|
|
91
|
-
- [
|
|
92
|
-
- [
|
|
93
|
-
- [
|
|
94
|
-
- [
|
|
95
|
-
- [
|
|
96
|
-
- [
|
|
97
|
-
- [
|
|
98
|
-
- [
|
|
99
|
-
- [
|
|
100
|
-
- [
|
|
101
|
-
- [
|
|
102
|
-
- [
|
|
103
|
-
- [
|
|
104
|
-
- [
|
|
105
|
-
- [X Pixel](./integrations/x-pixel.md): Configure X Pixel with c15t v3, understand marketing permission and verify loading and revocation.
|
|
83
|
+
- [Adobe Analytics](./integrations/adobe-analytics.md): Load an Adobe Data Collection Tags property only after measurement consent with the c15t adobeAnalytics helper, and check its extensions in DevTools.
|
|
84
|
+
- [Ahrefs Analytics](./integrations/ahrefs-analytics.md): Load Ahrefs Web Analytics only after measurement consent with the c15t ahrefsAnalytics helper, and check it in DevTools.
|
|
85
|
+
- [Amplitude](./integrations/amplitude.md): Load the Amplitude Browser SDK 2 only after measurement consent with the c15t amplitude helper, which opts the SDK out on revocation and back in on a new grant.
|
|
86
|
+
- [Custom integrations](./integrations/building-integrations.md): Gate a vendor that has no @c15t/integrations helper, or sync consent with an SDK your app already loads, using a c15t script configuration.
|
|
87
|
+
- [Clearbit](./integrations/clearbit.md): Load the Clearbit enrichment tag only after marketing consent with the c15t clearbit helper, and check it in DevTools.
|
|
88
|
+
- [Cloudflare Web Analytics](./integrations/cloudflare-web-analytics.md): Load the Cloudflare Web Analytics beacon only after measurement consent with the c15t cloudflareWebAnalytics helper, and check it in DevTools.
|
|
89
|
+
- [Cloudflare Zaraz](./integrations/cloudflare-zaraz.md): Sync c15t permissions to Cloudflare Zaraz purposes with the c15t cloudflareZaraz bridge, which runs on every page without loading a script, and check the tools it controls.
|
|
90
|
+
- [Crisp](./integrations/crisp.md): Load the Crisp chat widget only after functionality consent with the c15t crisp helper, pass its runtime settings and check it in DevTools.
|
|
91
|
+
- [Databuddy](./integrations/databuddy.md): Load the Databuddy SDK on every page with the c15t databuddy helper, switch its disabled flag and config from measurement consent, and check both in DevTools.
|
|
92
|
+
- [Fathom Analytics](./integrations/fathom-analytics.md): Load Fathom Analytics only after measurement consent with the c15t fathomAnalytics helper, set its SPA mode, and check it in DevTools.
|
|
93
|
+
- [Front Chat](./integrations/front-chat.md): Load the Front Chat widget only after functionality consent with the c15t frontChat helper, forward CSP nonces, clear the session on revocation and check it in DevTools.
|
|
94
|
+
- [Google Maps](./integrations/google-maps.md): Gate a Google Maps iframe embed with c15t v3 so the map loads only after the visitor allows its consent category, in Next.js, TanStack Start, React, Nuxt, Vue, Astro, Svelte, SvelteKit, HTML or JavaScript.
|
|
95
|
+
- [Google Tag](./integrations/google-tag.md): Load gtag.js for Google Analytics or Google Ads with c15t Consent Mode v2 signals, and verify the consent commands in DevTools.
|
|
96
|
+
- [Google Tag Manager](./integrations/google-tag-manager.md): Load a Google Tag Manager container with c15t Consent Mode v2 signals, configure consent checks inside the container, and verify both in DevTools.
|
|
97
|
+
- [Heap](./integrations/heap.md): Load the Heap config script and heap.js only after measurement consent with the c15t heap helper, and check it in DevTools.
|
|
98
|
+
- [Hightouch](./integrations/hightouch.md): Load the Hightouch Events browser SDK only after measurement consent with the c15t hightouch helper, and check page events in DevTools.
|
|
99
|
+
- [Hotjar](./integrations/hotjar.md): Load Hotjar only after measurement consent with the c15t hotjar helper, and check its loader and recordings in DevTools.
|
|
100
|
+
- [Intercom](./integrations/intercom.md): Load the Intercom messenger only after functionality consent with the c15t intercom helper, set its region and check it in DevTools.
|
|
101
|
+
- [Klaviyo](./integrations/klaviyo.md): Load Klaviyo signup forms and onsite tracking only after marketing and measurement consent with the c15t klaviyo helper, gate your own events, and check it in DevTools.
|
|
102
|
+
- [LinkedIn Insight Tag](./integrations/linkedin-insights.md): Load the LinkedIn Insight Tag only after marketing consent with the c15t linkedinInsights helper, guard lintrk conversion calls, and check it in DevTools.
|
|
103
|
+
- [LogRocket](./integrations/logrocket.md): Load LogRocket session replay only after measurement consent with the c15t logRocket helper, including proxied setups, and check it in DevTools.
|
|
104
|
+
- [Matomo Analytics](./integrations/matomo-analytics.md): Load Matomo after measurement consent with the c15t matomoAnalytics helper, or use Matomo's own consent mode, and check each mode in DevTools.
|
|
105
|
+
- [Meta Pixel](./integrations/meta-pixel.md): Load the Meta Pixel only after marketing consent with the c15t metaPixel helper, guard fbq event calls, and check it in DevTools.
|
|
106
|
+
- [Microsoft Clarity](./integrations/microsoft-clarity.md): Load Microsoft Clarity only after measurement consent with the c15t clarity helper, send Consent V2 storage signals and check them in DevTools.
|
|
107
|
+
- [Microsoft UET](./integrations/microsoft-uet.md): Load Microsoft Advertising UET on every page with the c15t microsoftUet helper, send ad_storage consent defaults and updates, and verify both in DevTools.
|
|
108
|
+
- [Mixpanel](./integrations/mixpanel-analytics.md): Load the Mixpanel SDK on every page with the c15t mixpanelAnalytics helper, which switches Mixpanel tracking on and off with measurement consent, and check it in DevTools.
|
|
109
|
+
- [OneDollarStats](./integrations/one-dollar-stats.md): Load the OneDollarStats tracker only after measurement consent with the c15t oneDollarStats helper, forward its data-attribute settings, and check it in DevTools.
|
|
110
|
+
- [OpenAI Pixel](./integrations/openai-pixel.md): Load the ChatGPT Ads Measurement Pixel only after marketing consent with the c15t openaiPixel helper, guard oaiq conversion calls, and check it in DevTools.
|
|
111
|
+
- [Integrations](./integrations/overview.md): Find all c15t integrations for analytics, tag managers, advertising, email and SMS, chat and embedded content.
|
|
112
|
+
- [Pinterest Tag](./integrations/pinterest-tag.md): Load the Pinterest Tag only after marketing consent with the c15t pinterestTag helper, guard pintrk event calls, and check it in DevTools.
|
|
113
|
+
- [Pirsch](./integrations/pirsch.md): Load Pirsch Analytics only after measurement consent with the c15t pirsch helper, keep custom event bindings working, and check it in DevTools.
|
|
114
|
+
- [Plausible Analytics](./integrations/plausible-analytics.md): Load the Plausible Analytics tracker only after measurement consent with the c15t plausibleAnalytics helper, and check it in DevTools.
|
|
115
|
+
- [PostHog](./integrations/posthog.md): Load PostHog before or after measurement consent with the c15t posthog helper, choose its cookieless behavior, turn off PostHog modules you do not use, and sync consent with an SDK you already initialize.
|
|
116
|
+
- [Promptwatch](./integrations/promptwatch.md): Load the Promptwatch attribution client only after measurement consent with the c15t promptwatch helper, and check it in DevTools.
|
|
117
|
+
- [Reddit Pixel](./integrations/reddit-pixel.md): Load the Reddit Pixel only after marketing consent with the c15t redditPixel helper, guard rdt conversion calls, and check it in DevTools.
|
|
118
|
+
- [RudderStack](./integrations/rudderstack.md): Load the RudderStack JavaScript SDK after measurement consent with the c15t rudderstack helper, or map c15t categories to destination consent IDs, and check each mode.
|
|
119
|
+
- [Rybbit Analytics](./integrations/rybbit-analytics.md): Load Rybbit Analytics only after measurement consent with the c15t rybbitAnalytics helper, map its tracking options to data attributes, and check it in DevTools.
|
|
120
|
+
- [Segment](./integrations/segment.md): Load Segment Analytics.js only after measurement consent with the c15t segment helper, guard your own track and identify calls, and check it in DevTools.
|
|
121
|
+
- [Snapchat Pixel](./integrations/snapchat-pixel.md): Load the Snapchat Pixel only after marketing consent with the c15t snapchatPixel helper, guard snaptr event calls, and check it in DevTools.
|
|
122
|
+
- [TikTok Pixel](./integrations/tiktok-pixel.md): Load the TikTok Pixel only after marketing consent with the c15t tiktokPixel helper, guard ttq event calls, and check it in DevTools.
|
|
123
|
+
- [Umami Analytics](./integrations/umami-analytics.md): Load the Umami Analytics tracker only after measurement consent with the c15t umamiAnalytics helper, point it at a self-hosted instance, and check it in DevTools.
|
|
124
|
+
- [Vercel Analytics](./integrations/vercel-analytics.md): Load the Vercel Web Analytics script only after measurement consent with the c15t vercelAnalytics helper, choose the debug script, and check it in DevTools.
|
|
125
|
+
- [X Pixel](./integrations/x-pixel.md): Load the X Pixel only after marketing consent with the c15t xPixel helper, guard twq conversion events, and check it in DevTools.
|
|
106
126
|
- [YouTube](./integrations/youtube.md): Gate YouTube embeds with c15t v3 in Next.js, TanStack Start, React, Nuxt, Vue, Astro, Svelte, SvelteKit or JavaScript.
|
|
107
127
|
|
|
108
128
|
## Reference
|
|
109
129
|
|
|
110
|
-
- [
|
|
130
|
+
- [Migrate to v3](./upgrade-v3.md): Upgrade a c15t v2 app to v3. Covers packages, the Next.js and React providers, the JavaScript runtime, custom UI built on useConsentManager, callbacks, policies, stored consent and a self-hosted backend.
|
|
Binary file
|