@c15t/react 3.0.0-alpha.0 → 3.0.0-alpha.10
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 +96 -69
- package/README.md +21 -17
- package/SKILL.md +34 -0
- package/dist/aggregate-components.js +1 -1
- package/dist/chunk-warming.js +1 -1
- 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/component-hooks/use-panel-trigger.js +1 -1
- package/dist/components/consent-gate/atoms.js +1 -0
- package/dist/components/consent-gate/consent-gate.js +2 -0
- package/dist/components/consent-gate/frame.js +2 -0
- package/dist/components/consent-gate/index.js +2 -0
- package/dist/components/consent-preferences-link/consent-preferences-link.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/atoms/purpose-item.js +1 -1
- package/dist/components/iab-panel/atoms/root.js +1 -1
- package/dist/components/iab-panel/atoms/stack-item.js +1 -1
- package/dist/components/iab-panel/atoms/vendor-list.js +1 -1
- package/dist/components/iab-panel/hooks/use-gvl-data.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/overlay.js +1 -1
- package/dist/components/panel/atoms/root.js +1 -1
- package/dist/components/panel/panel.js +1 -1
- package/dist/components/panel-trigger/atoms/button.js +1 -1
- package/dist/components/panel-trigger/atoms/icon.js +1 -1
- package/dist/components/panel-trigger/atoms/root.js +1 -1
- package/dist/components/panel-trigger/atoms/toolbar.js +1 -1
- package/dist/components/panel-trigger/atoms/trigger-icons.js +1 -0
- package/dist/components/panel-trigger/panel-trigger-toolbar.js +1 -1
- package/dist/components/panel-trigger/panel-trigger.js +1 -1
- package/dist/components/preferences/atoms/accordion.js +1 -1
- package/dist/components/preferences/atoms/root.js +1 -1
- package/dist/components/preferences/atoms/vendor-list.js +1 -0
- package/dist/components/preferences/index.js +1 -1
- package/dist/components/prompt/atoms/early-tap-script.js +2 -0
- 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/prompt/policy-actions.js +1 -1
- package/dist/components/prompt/prompt.js +1 -1
- package/dist/components/shared/dialog-sheets.js +1 -0
- package/dist/components/shared/first-paint-sheets.js +1 -0
- package/dist/components/shared/iab-dialog-sheets.js +1 -0
- package/dist/components/shared/iab-first-paint-sheets.js +1 -0
- 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/primitives/legal-links/index.js +1 -1
- package/dist/components/shared/streamed-surface.js +2 -0
- package/dist/components/shared/surface-styles.js +2 -0
- package/dist/components/shared/ui/dialog/dialog.js +1 -1
- package/dist/components/shared/ui/icon.js +1 -1
- package/dist/components/shared/ui/logo.js +1 -1
- package/dist/components/shared/ui/preference-item/preference-item.js +1 -1
- package/dist/consent-gate.js +2 -0
- package/dist/consent-theme.js +1 -0
- package/dist/context/consent-tracking-context.js +1 -1
- package/dist/context/index.js +1 -1
- package/dist/context.js +1 -1
- package/dist/devtools-launcher.js +2 -0
- 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/headless.js +1 -1
- package/dist/hooks/use-color-scheme.js +1 -1
- package/dist/hooks/use-committed-ref.js +2 -0
- package/dist/hooks/use-focus-trap.js +1 -1
- package/dist/hooks/use-headless-iab-consent-ui.js +1 -1
- package/dist/hooks/use-iab-policy-guard.js +1 -0
- package/dist/hooks/use-late-entry.js +2 -0
- package/dist/hooks.js +1 -1
- package/dist/iab/styles.tw3.css +5 -151
- package/dist/iab-context.js +1 -1
- 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/frame.js +1 -0
- package/dist/index-parts/hooks.js +1 -0
- package/dist/index-parts/hosted.js +1 -0
- package/dist/index-parts/module-hooks.js +1 -0
- package/dist/index-parts/offline.js +1 -0
- package/dist/index-parts/presets.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 -0
- package/dist/modes.js +1 -0
- package/dist/module-hooks/iframe-blocker.js +1 -1
- package/dist/module-hooks/network-blocker.js +1 -1
- package/dist/module-hooks/network-hold.js +2 -0
- package/dist/module-hooks/persistence.js +1 -1
- package/dist/panel-link.js +1 -1
- package/dist/panel-trigger.js +1 -1
- package/dist/panel.js +1 -1
- package/dist/postcss-tailwind3.js +1 -0
- package/dist/preferences.js +1 -2
- 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 +35 -159
- package/dist/transports/hosted.js +1 -0
- package/dist/transports/manifest.js +1 -0
- package/dist/transports/offline.js +1 -1
- package/dist/utils/deferred-module.js +2 -0
- 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/aggregate-components.d.ts +2 -2
- package/dist-types/chunk-warming.d.ts +45 -8
- package/dist-types/component-hooks/use-headless-consent-ui.d.ts +5 -5
- package/dist-types/component-hooks/use-headless-iab-consent-ui.d.ts +2 -2
- package/dist-types/components/consent-gate/atoms.d.ts +11 -0
- package/dist-types/components/consent-gate/consent-gate.d.ts +2 -0
- package/dist-types/components/consent-gate/frame.d.ts +19 -0
- package/dist-types/components/consent-gate/index.d.ts +25 -0
- package/dist-types/components/{frame → consent-gate}/types.d.ts +7 -7
- package/dist-types/components/consent-preferences-link/consent-preferences-link.d.ts +1 -1
- package/dist-types/components/consent-preferences-link/index.d.ts +1 -1
- package/dist-types/components/iab-panel/atoms/feature-item.d.ts +28 -0
- package/dist-types/components/iab-panel/atoms/purpose-item.d.ts +5 -2
- package/dist-types/components/iab-panel/atoms/stack-item.d.ts +7 -2
- package/dist-types/components/iab-panel/atoms/vendor-list.d.ts +1 -1
- package/dist-types/components/iab-panel/iab-panel.d.ts +3 -3
- package/dist-types/components/iab-panel/index.d.ts +29 -26
- package/dist-types/components/iab-panel/use-iab-translations.d.ts +4 -0
- package/dist-types/components/iab-prompt/iab-prompt.d.ts +3 -3
- package/dist-types/components/iab-prompt/index.d.ts +19 -19
- package/dist-types/components/panel/atoms/card.d.ts +5 -4
- package/dist-types/components/panel/atoms/overlay.d.ts +1 -1
- package/dist-types/components/panel/index.d.ts +8 -8
- package/dist-types/components/panel/panel.d.ts +3 -3
- package/dist-types/components/panel-link/index.d.ts +1 -1
- package/dist-types/components/panel-trigger/atoms/button.d.ts +1 -1
- package/dist-types/components/panel-trigger/atoms/icon.d.ts +1 -1
- package/dist-types/components/panel-trigger/atoms/root.d.ts +2 -2
- package/dist-types/components/panel-trigger/atoms/toolbar.d.ts +2 -2
- package/dist-types/components/panel-trigger/atoms/trigger-icons.d.ts +25 -0
- package/dist-types/components/panel-trigger/index.d.ts +4 -4
- package/dist-types/components/panel-trigger/panel-trigger-toolbar.d.ts +1 -1
- package/dist-types/components/panel-trigger/panel-trigger.d.ts +9 -17
- package/dist-types/components/panel-trigger/types.d.ts +1 -1
- package/dist-types/components/preferences/atoms/accordion.d.ts +6 -4
- package/dist-types/components/preferences/atoms/button.d.ts +1 -1
- package/dist-types/components/preferences/atoms/footer.d.ts +1 -1
- package/dist-types/components/preferences/atoms/root.d.ts +1 -1
- package/dist-types/components/preferences/atoms/vendor-list.d.ts +23 -0
- package/dist-types/components/preferences/index.d.ts +14 -12
- package/dist-types/components/preferences/policy-actions.d.ts +2 -2
- package/dist-types/components/preferences/preferences.d.ts +1 -1
- package/dist-types/components/preferences/types.d.ts +1 -1
- package/dist-types/components/prompt/atoms/early-tap-script.d.ts +17 -0
- package/dist-types/components/prompt/atoms/root.d.ts +4 -0
- package/dist-types/components/prompt/components.d.ts +9 -3
- package/dist-types/components/prompt/index.d.ts +12 -12
- package/dist-types/components/prompt/policy-actions.d.ts +2 -2
- package/dist-types/components/prompt/prompt.d.ts +5 -1
- package/dist-types/components/shared/dialog-sheets.d.ts +9 -0
- package/dist-types/components/shared/first-paint-sheets.d.ts +8 -0
- package/dist-types/components/shared/iab-dialog-sheets.d.ts +3 -0
- package/dist-types/components/shared/iab-first-paint-sheets.d.ts +3 -0
- package/dist-types/components/shared/libs/compose-refs.d.ts +20 -0
- package/dist-types/components/shared/policy-actions.d.ts +2 -2
- package/dist-types/components/shared/primitives/box.d.ts +1 -1
- package/dist-types/components/shared/primitives/button.d.ts +2 -2
- package/dist-types/components/shared/primitives/button.types.d.ts +1 -1
- package/dist-types/components/shared/streamed-surface.d.ts +23 -0
- package/dist-types/components/shared/surface-styles.d.ts +36 -0
- package/dist-types/components/shared/ui/accordion/accordion.d.ts +2 -2
- package/dist-types/components/shared/ui/accordion/index.d.ts +2 -2
- package/dist-types/components/shared/ui/animated-collapse/index.d.ts +2 -2
- package/dist-types/components/shared/ui/branding.d.ts +1 -1
- package/dist-types/components/shared/ui/button/button.d.ts +1 -1
- package/dist-types/components/shared/ui/button/index.d.ts +2 -2
- package/dist-types/components/shared/ui/collapsible/index.d.ts +1 -1
- package/dist-types/components/shared/ui/dialog/index.d.ts +1 -1
- package/dist-types/components/shared/ui/icon.d.ts +2 -1
- package/dist-types/components/shared/ui/logo.d.ts +0 -10
- package/dist-types/components/shared/ui/preference-item/index.d.ts +1 -1
- package/dist-types/components/shared/ui/preference-item/preference-item.d.ts +13 -0
- package/dist-types/components/shared/ui/switch/index.d.ts +2 -2
- package/dist-types/components/shared/ui/switch/switch.d.ts +1 -1
- package/dist-types/components/shared/ui/tabs/index.d.ts +1 -1
- package/dist-types/consent-gate.d.ts +1 -0
- package/dist-types/consent-theme.d.ts +38 -0
- package/dist-types/context/consent-tracking-context.d.ts +10 -0
- package/dist-types/context/index.d.ts +3 -3
- package/dist-types/context/theme-context.d.ts +3 -3
- package/dist-types/context.d.ts +25 -1
- package/dist-types/devtools-launcher.d.ts +29 -0
- package/dist-types/devtools.d.ts +13 -2
- package/dist-types/draft-context.d.ts +31 -0
- package/dist-types/draft.d.ts +81 -9
- package/dist-types/gpp.d.ts +27 -0
- package/dist-types/headless.d.ts +6 -7
- package/dist-types/hooks/use-committed-ref.d.ts +24 -0
- package/dist-types/hooks/use-focus-trap.d.ts +3 -1
- package/dist-types/hooks/use-headless-iab-consent-ui.d.ts +1 -1
- package/dist-types/hooks/use-iab-manager.d.ts +5 -5
- package/dist-types/hooks/use-iab-policy-guard.d.ts +35 -0
- package/dist-types/hooks/use-late-entry.d.ts +14 -0
- package/dist-types/hooks/use-theme.d.ts +1 -1
- package/dist-types/hooks.d.ts +106 -11
- package/dist-types/iab.d.ts +7 -7
- 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 +7 -0
- package/dist-types/index-parts/draft.d.ts +7 -0
- package/dist-types/index-parts/frame.d.ts +7 -0
- package/dist-types/index-parts/hooks.d.ts +7 -0
- package/dist-types/index-parts/hosted.d.ts +7 -0
- package/dist-types/index-parts/module-hooks.d.ts +7 -0
- package/dist-types/index-parts/offline.d.ts +7 -0
- package/dist-types/index-parts/presets.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 +32 -28
- package/dist-types/kernel-selector.d.ts +68 -0
- package/dist-types/modes.d.ts +26 -0
- package/dist-types/module-hooks/iframe-blocker.d.ts +33 -1
- package/dist-types/module-hooks/network-blocker.d.ts +23 -0
- package/dist-types/module-hooks/network-hold.d.ts +47 -0
- package/dist-types/module-hooks.d.ts +4 -4
- package/dist-types/panel-link.d.ts +1 -1
- package/dist-types/panel-trigger.d.ts +1 -1
- package/dist-types/panel.d.ts +13 -1
- package/dist-types/postcss-tailwind3.d.ts +21 -0
- package/dist-types/preferences.d.ts +12 -1
- package/dist-types/primitives/accordion.d.ts +1 -1
- package/dist-types/primitives/button.d.ts +1 -1
- package/dist-types/primitives/collapsible.d.ts +1 -1
- package/dist-types/primitives/dialog.d.ts +1 -1
- package/dist-types/primitives/preference-item.d.ts +1 -1
- package/dist-types/primitives/switch.d.ts +1 -1
- package/dist-types/primitives/tabs.d.ts +1 -1
- package/dist-types/primitives.d.ts +7 -7
- package/dist-types/prompt.d.ts +1 -1
- package/dist-types/provider.d.ts +174 -28
- package/dist-types/server/fetch-ssr-data.d.ts +1 -1
- package/dist-types/server/headers.d.ts +14 -4
- package/dist-types/server/index.d.ts +5 -5
- package/dist-types/server/normalize-url.d.ts +14 -7
- package/dist-types/server/types.d.ts +12 -1
- package/dist-types/theme-provider.d.ts +2 -2
- package/dist-types/transports/hosted.d.ts +36 -0
- package/dist-types/transports/manifest.d.ts +48 -0
- package/dist-types/transports/offline.d.ts +7 -16
- package/dist-types/types/index.d.ts +3 -3
- package/dist-types/types/manager.d.ts +1 -1
- package/dist-types/types/theme/index.d.ts +1 -1
- package/dist-types/ui-config-context.d.ts +14 -2
- package/dist-types/utils/deferred-module.d.ts +13 -0
- package/dist-types/utils/index.d.ts +4 -4
- package/dist-types/utils/merge-slot-props.d.ts +17 -3
- package/dist-types/utils/merge-styles.d.ts +1 -1
- package/dist-types/utils/theme-utils.d.ts +18 -3
- package/dist-types/version.d.ts +1 -1
- package/docs/README.md +96 -69
- 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 +138 -0
- package/docs/concepts/consent-categories.md +84 -0
- package/docs/concepts/consent-state.md +421 -0
- package/docs/concepts/data-fetching.md +270 -0
- package/docs/concepts/how-consent-works.md +123 -0
- package/docs/concepts/modes.md +278 -0
- package/docs/{frameworks/react/concepts/policy-presets.md → concepts/policies.md} +8 -60
- package/docs/customization/class-names.md +202 -0
- package/docs/customization/dark-mode.md +157 -0
- package/docs/customization/motion.md +128 -0
- package/docs/customization/overview.md +68 -33
- package/docs/customization/recipes.md +838 -47
- package/docs/customization/slots.md +217 -35
- package/docs/customization/stylesheets.md +248 -0
- package/docs/customization/tailwind.md +863 -0
- package/docs/customization/tokens.md +167 -36
- package/docs/customization/translations.md +87 -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 +48 -27
- package/docs/frameworks/react/components/consent-dialog-link.md +13 -11
- package/docs/frameworks/react/components/consent-dialog-trigger.md +86 -76
- package/docs/frameworks/react/components/consent-dialog.md +111 -58
- package/docs/frameworks/react/components/{frame.md → consent-gate.md} +70 -49
- package/docs/frameworks/react/components/consent-provider.md +140 -0
- package/docs/frameworks/react/components/consent-widget.md +69 -24
- package/docs/frameworks/react/components/dev-tools.md +76 -85
- package/docs/frameworks/react/components.md +113 -0
- package/docs/frameworks/react/compose.md +354 -0
- package/docs/frameworks/react/content-security-policy.md +143 -0
- package/docs/frameworks/react/customize.md +258 -0
- package/docs/frameworks/react/embeds.md +89 -0
- package/docs/frameworks/react/gpp.md +163 -0
- package/docs/frameworks/react/headless.md +4 -4
- package/docs/frameworks/react/hooks.md +70 -0
- package/docs/frameworks/react/iab.md +259 -0
- package/docs/frameworks/react/network-blocker.md +140 -0
- package/docs/frameworks/react/quickstart.md +220 -102
- package/docs/frameworks/react/rendering.md +263 -0
- package/docs/frameworks/react/scripts.md +114 -0
- package/docs/frameworks/react/translations.md +155 -0
- package/docs/frameworks/react/troubleshooting.md +188 -61
- package/docs/frameworks/react/upgrade-v3.md +651 -0
- package/docs/frameworks/react/vendor-consent.md +188 -0
- package/docs/guides/banner-experiments.md +672 -0
- package/docs/guides/troubleshooting.md +192 -54
- package/docs/guides/verify-consent.md +96 -49
- package/docs/integrations/adobe-analytics.md +177 -183
- package/docs/integrations/ahrefs-analytics.md +162 -178
- package/docs/integrations/amplitude.md +172 -180
- package/docs/integrations/building-integrations.md +137 -33
- package/docs/integrations/clearbit.md +164 -178
- package/docs/integrations/cloudflare-web-analytics.md +166 -180
- package/docs/integrations/cloudflare-zaraz.md +333 -0
- package/docs/integrations/crisp.md +174 -182
- package/docs/integrations/databuddy.md +167 -197
- package/docs/integrations/fathom-analytics.md +168 -180
- package/docs/integrations/front-chat.md +308 -0
- package/docs/integrations/google-maps.md +142 -108
- package/docs/integrations/google-tag-manager.md +258 -185
- package/docs/integrations/google-tag.md +226 -182
- package/docs/integrations/heap.md +173 -179
- package/docs/integrations/hightouch.md +171 -181
- package/docs/integrations/hotjar.md +169 -179
- package/docs/integrations/intercom.md +193 -177
- package/docs/integrations/klaviyo.md +473 -0
- package/docs/integrations/linkedin-insights.md +184 -174
- package/docs/integrations/logrocket.md +170 -180
- package/docs/integrations/matomo-analytics.md +198 -202
- package/docs/integrations/meta-pixel.md +198 -174
- package/docs/integrations/microsoft-clarity.md +173 -179
- package/docs/integrations/microsoft-uet.md +158 -178
- package/docs/integrations/mixpanel-analytics.md +165 -184
- package/docs/integrations/one-dollar-stats.md +292 -0
- package/docs/integrations/openai-pixel.md +214 -325
- package/docs/integrations/overview.md +152 -83
- package/docs/integrations/pinterest-tag.md +315 -0
- package/docs/integrations/pirsch.md +179 -183
- package/docs/integrations/plausible-analytics.md +182 -182
- package/docs/integrations/posthog.md +323 -264
- package/docs/integrations/promptwatch.md +164 -178
- package/docs/integrations/reddit-pixel.md +195 -181
- package/docs/integrations/rudderstack.md +211 -210
- package/docs/integrations/rybbit-analytics.md +181 -184
- package/docs/integrations/segment.md +192 -178
- package/docs/integrations/sentry.md +402 -0
- package/docs/integrations/snapchat-pixel.md +196 -180
- package/docs/integrations/tiktok-pixel.md +181 -174
- package/docs/integrations/umami-analytics.md +173 -182
- package/docs/integrations/vercel-analytics.md +176 -181
- package/docs/integrations/x-pixel.md +186 -174
- package/docs/integrations/youtube.md +150 -111
- package/package.json +48 -17
- package/dist/component-hooks/use-manager.js +0 -2
- package/dist/components/frame/atoms.js +0 -1
- package/dist/components/frame/frame.js +0 -2
- package/dist/components/frame/index.js +0 -2
- package/dist/frame.js +0 -2
- package/dist/ui-save.js +0 -1
- package/dist-types/component-hooks/use-manager.d.ts +0 -40
- package/dist-types/components/frame/atoms.d.ts +0 -11
- package/dist-types/components/frame/frame.d.ts +0 -2
- package/dist-types/components/frame/index.d.ts +0 -24
- package/dist-types/frame.d.ts +0 -1
- package/dist-types/ui-save.d.ts +0 -5
- 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 -62
- package/docs/frameworks/react/concepts/consent-categories.md +0 -33
- package/docs/frameworks/react/hooks/use-consent-manager/overview.md +0 -58
- package/docs/frameworks/react/iab/overview.md +0 -53
- package/docs/frameworks/react/script-loader.md +0 -55
- package/docs/frameworks/react/styling/overview.md +0 -207
- package/docs/guides/consent-state.md +0 -60
- package/docs/guides/data-fetching.md +0 -163
- package/docs/guides/deployment-modes.md +0 -63
- package/docs/upgrade-v3.md +0 -334
- package/readme.json +0 -48
- package/src/iab/styles.css +0 -11
- package/src/styles.css +0 -10
- /package/dist/components/{frame → consent-gate}/types.js +0 -0
|
@@ -1,210 +1,153 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Google Tag Manager
|
|
3
|
-
description: Load
|
|
3
|
+
description: Load a Google Tag Manager container before or after consent with
|
|
4
|
+
c15t Consent Mode v2 signals, configure consent checks inside the container,
|
|
5
|
+
and verify both in DevTools.
|
|
6
|
+
icon: google-tag-manager
|
|
4
7
|
group: integrations
|
|
5
8
|
---
|
|
6
9
|
|
|
7
|
-
##
|
|
10
|
+
## Configure Google Tag Manager
|
|
8
11
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
|
14
|
-
|
|
|
12
|
+
Copy the container ID, which starts with `GTM-`, from your GTM workspace.
|
|
13
|
+
Remove the existing GTM snippet, its `<noscript>` iframe and any framework
|
|
14
|
+
plugin that loads the same container.
|
|
15
|
+
|
|
16
|
+
| Package manager | Command |
|
|
17
|
+
| :-------------- | :------------------------------------- |
|
|
18
|
+
| npm | `npm install @c15t/integrations@alpha` |
|
|
19
|
+
| pnpm | `pnpm add @c15t/integrations@alpha` |
|
|
20
|
+
| yarn | `yarn add @c15t/integrations@alpha` |
|
|
21
|
+
| bun | `bun add @c15t/integrations@alpha` |
|
|
15
22
|
|
|
16
23
|
```ts title="src/consent-scripts.ts"
|
|
17
|
-
import { googleTagManager } from '@c15t/
|
|
24
|
+
import { googleTagManager } from '@c15t/integrations/google-tag-manager';
|
|
18
25
|
|
|
19
26
|
export const scripts = [googleTagManager({ id: 'GTM-XXXXXXX' })];
|
|
20
27
|
```
|
|
21
28
|
|
|
22
|
-
Replace the container ID and pass `scripts` to your existing provider options.
|
|
23
|
-
Remove the previous GTM snippet and any duplicate framework integration. The
|
|
24
|
-
helper sends a `consent-update` event after consent changes; `updateEventName`
|
|
25
|
-
customizes that event name.
|
|
26
|
-
|
|
27
29
|
## Register the scripts
|
|
28
30
|
|
|
29
|
-
Complete your [framework quickstart](https://c15t.com/docs/frameworks) first. Keep its Inth
|
|
31
|
+
Complete your [framework quickstart](https://v3.c15t.com/docs/frameworks) first. Keep its Inth
|
|
30
32
|
endpoint, policy, styles and consent UI. Remove the vendor's original script,
|
|
31
|
-
SDK initializer or tag-manager entry so
|
|
33
|
+
SDK initializer or tag-manager entry, so the vendor loads only through c15t.
|
|
32
34
|
|
|
33
|
-
The
|
|
34
|
-
|
|
35
|
-
|
|
35
|
+
The vendor pages put the helper in `src/consent-scripts.ts`. If your framework
|
|
36
|
+
quickstart already has a `scripts` array, such as the one in `c15t.config.ts`
|
|
37
|
+
in the Next.js guide, add the helper to that array instead of creating a
|
|
38
|
+
second file.
|
|
39
|
+
The `scripts` export is a configuration, not an initializer. Add it to the c15t provider you already have, at the registration
|
|
40
|
+
point for your framework below. These are edits to that provider, not a second
|
|
41
|
+
provider.
|
|
36
42
|
|
|
37
43
|
**Next.js**
|
|
38
44
|
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
```ts
|
|
42
|
-
import { ConsentRoot } from 'c15t/next';
|
|
43
|
-
import { scripts } from './consent-scripts';
|
|
44
|
-
```
|
|
45
|
+
Add the configuration to `scripts` in `c15t.config.ts`, next to
|
|
46
|
+
`next.config.ts`:
|
|
45
47
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
48
|
+
```ts title="c15t.config.ts"
|
|
49
|
+
import { defineConsentConfig } from 'c15t/next';
|
|
50
|
+
import { scripts } from './src/consent-scripts';
|
|
49
51
|
|
|
50
|
-
|
|
51
|
-
<ConsentRoot state={state} config={consentConfig} scripts={scripts}>
|
|
52
|
-
{children}
|
|
53
|
-
</ConsentRoot>
|
|
52
|
+
export default defineConsentConfig({ scripts });
|
|
54
53
|
```
|
|
55
54
|
|
|
56
|
-
|
|
57
|
-
`
|
|
58
|
-
|
|
55
|
+
Keep the rest of your config, such as `mode` and `routePrefix`, in the
|
|
56
|
+
same call. `ConsentRoot` reads the config in the browser, so the layout
|
|
57
|
+
keeps passing only `state`. App Router, Pages Router and static export all
|
|
58
|
+
read the same file. See
|
|
59
|
+
[Next.js scripts and embeds](https://v3.c15t.com/docs/frameworks/next/scripts).
|
|
59
60
|
|
|
60
61
|
**TanStack Start**
|
|
61
62
|
|
|
62
|
-
|
|
63
|
-
`ConsentRoot
|
|
63
|
+
Import the configuration into your root route and pass it to the existing
|
|
64
|
+
`ConsentRoot` as a top-level prop. Keep the loader from the
|
|
65
|
+
[TanStack Start quickstart](https://v3.c15t.com/docs/frameworks/tanstack-start/quickstart):
|
|
64
66
|
|
|
65
|
-
```tsx
|
|
66
|
-
import { Outlet } from '@tanstack/react-router';
|
|
67
|
-
import { ConsentRoot } from 'c15t/tanstack-start';
|
|
67
|
+
```tsx title="src/routes/__root.tsx"
|
|
68
68
|
import { scripts } from '../consent-scripts';
|
|
69
69
|
|
|
70
|
-
|
|
71
|
-
const state = Route.useLoaderData();
|
|
72
|
-
return (
|
|
73
|
-
<ConsentRoot state={state} backendURL={backendURL} initRoute={false} scripts={scripts}>
|
|
74
|
-
<Outlet />
|
|
75
|
-
{/* Keep your consent banner, dialog and preferences link here. */}
|
|
76
|
-
</ConsentRoot>
|
|
77
|
-
);
|
|
78
|
-
}
|
|
70
|
+
<ConsentRoot state={consent} scripts={scripts}>
|
|
79
71
|
```
|
|
80
72
|
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
instead. Do not return script callbacks from a server function or route loader.
|
|
73
|
+
Import vendor helpers in the root route module, not in a server function.
|
|
74
|
+
A server function's return value must be serializable, and script
|
|
75
|
+
configurations carry callbacks. See
|
|
76
|
+
[TanStack Start scripts](https://v3.c15t.com/docs/frameworks/tanstack-start/scripts).
|
|
86
77
|
|
|
87
78
|
**React**
|
|
88
79
|
|
|
89
|
-
|
|
80
|
+
Add the configuration to the existing `ConsentProvider` options, next to
|
|
81
|
+
`mode`:
|
|
90
82
|
|
|
91
|
-
```
|
|
92
|
-
import { ConsentProvider } from 'c15t/react';
|
|
83
|
+
```tsx title="src/consent.tsx"
|
|
93
84
|
import { scripts } from './consent-scripts';
|
|
94
|
-
```
|
|
95
85
|
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
```tsx
|
|
99
|
-
<ConsentProvider options={{ ...consentOptions, scripts }}>
|
|
100
|
-
{children}
|
|
101
|
-
</ConsentProvider>
|
|
86
|
+
<ConsentProvider options={{ mode, scripts }}>
|
|
102
87
|
```
|
|
103
88
|
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
link inside the provider. See
|
|
89
|
+
`mode` is the `manifest()` value from the
|
|
90
|
+
[React quickstart](../frameworks/react/quickstart.md). Keep the banner,
|
|
91
|
+
dialog and preferences link inside the provider. See
|
|
92
|
+
[React scripts and embeds](../frameworks/react/scripts.md).
|
|
107
93
|
|
|
108
94
|
**Nuxt**
|
|
109
95
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
than serialized `nuxt.config.ts` runtime configuration.
|
|
96
|
+
Register the scripts under the `c15t` key in `app/app.config.ts`. Adjust the
|
|
97
|
+
relative import to where you created `consent-scripts.ts`:
|
|
113
98
|
|
|
114
|
-
```
|
|
115
|
-
<script setup lang="ts">
|
|
116
|
-
import { onUnmounted } from 'vue';
|
|
117
|
-
import { createScriptLoader } from 'c15t/modules/script-loader';
|
|
99
|
+
```ts title="app/app.config.ts"
|
|
118
100
|
import { scripts } from '../src/consent-scripts';
|
|
119
101
|
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
let loader: ReturnType<typeof createScriptLoader> | undefined;
|
|
123
|
-
|
|
124
|
-
const removeMountedHook = nuxtApp.hook('app:mounted', () => {
|
|
125
|
-
loader = createScriptLoader({ kernel, scripts });
|
|
126
|
-
});
|
|
127
|
-
onUnmounted(() => {
|
|
128
|
-
removeMountedHook();
|
|
129
|
-
loader?.dispose();
|
|
102
|
+
export default defineAppConfig({
|
|
103
|
+
c15t: { scripts },
|
|
130
104
|
});
|
|
131
|
-
</script>
|
|
132
|
-
|
|
133
|
-
<template>
|
|
134
|
-
<ConsentRoot />
|
|
135
|
-
<NuxtPage />
|
|
136
|
-
</template>
|
|
137
105
|
```
|
|
138
106
|
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
107
|
+
The Nuxt module merges this over its options in `nuxt.config.ts` and starts
|
|
108
|
+
one script loader in the browser after hydration, once it has applied the
|
|
109
|
+
visitor's stored choice and privacy signals. Keep `scripts` out of
|
|
110
|
+
`nuxt.config.ts`, which reaches the browser as JSON and drops the vendor
|
|
111
|
+
callbacks. Write the vendor IDs into `consent-scripts.ts`. See
|
|
112
|
+
[Nuxt scripts and embeds](https://v3.c15t.com/docs/frameworks/nuxt/scripts).
|
|
145
113
|
|
|
146
114
|
**Vue**
|
|
147
115
|
|
|
148
|
-
|
|
149
|
-
`App.vue`, whose lifetime covers the application:
|
|
116
|
+
Pass the scripts to the existing `c15tVue` plugin call in `src/main.ts`:
|
|
150
117
|
|
|
151
|
-
```
|
|
152
|
-
|
|
153
|
-
import { onMounted, onUnmounted } from 'vue';
|
|
154
|
-
import { createScriptLoader } from 'c15t/modules/script-loader';
|
|
155
|
-
import { useConsentKernel } from 'c15t/vue/vue-plugin';
|
|
156
|
-
import ConsentRoot from 'c15t/vue/consent-root';
|
|
118
|
+
```ts title="src/main.ts"
|
|
119
|
+
import { c15tVue, manifest } from 'c15t/vue/vue-plugin';
|
|
157
120
|
import { scripts } from './consent-scripts';
|
|
158
121
|
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
onMounted(() => {
|
|
163
|
-
loader = createScriptLoader({ kernel, scripts });
|
|
122
|
+
app.use(c15tVue, {
|
|
123
|
+
mode: manifest(),
|
|
124
|
+
scripts,
|
|
164
125
|
});
|
|
165
|
-
onUnmounted(() => loader?.dispose());
|
|
166
|
-
</script>
|
|
167
|
-
|
|
168
|
-
<template>
|
|
169
|
-
<ConsentRoot />
|
|
170
|
-
<main>Your application</main>
|
|
171
|
-
</template>
|
|
172
126
|
```
|
|
173
127
|
|
|
174
|
-
Keep your existing
|
|
175
|
-
the
|
|
176
|
-
Do not
|
|
177
|
-
[Vue
|
|
128
|
+
Keep your existing `mode` and other options. The plugin starts one
|
|
129
|
+
script loader when the app mounts, after it has applied the visitor's stored
|
|
130
|
+
choice. Do not also call `createScriptLoader` from a component. See
|
|
131
|
+
[Vue scripts and embeds](https://v3.c15t.com/docs/frameworks/vue/scripts).
|
|
178
132
|
|
|
179
133
|
**Astro**
|
|
180
134
|
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
```js title="astro.config.mjs"
|
|
186
|
-
import { fileURLToPath } from 'node:url';
|
|
187
|
-
```
|
|
188
|
-
|
|
189
|
-
Add this option to the existing `c15t({ ... })` call. Resolve the path from
|
|
190
|
-
the configuration file because Astro injects the import into a virtual module:
|
|
191
|
-
|
|
192
|
-
```js
|
|
193
|
-
clientEntrypoint: fileURLToPath(new URL('./src/c15t.client.ts', import.meta.url)),
|
|
194
|
-
```
|
|
195
|
-
|
|
196
|
-
Export the scripts from that module:
|
|
135
|
+
Add the scripts to the client entrypoint from the
|
|
136
|
+
[Astro quickstart](https://v3.c15t.com/docs/frameworks/astro/quickstart), `src/c15t.client.ts`,
|
|
137
|
+
which the integration finds on its own. Keep `astro.config.mjs` as it is.
|
|
138
|
+
If the module already exports scripts, combine the two arrays.
|
|
197
139
|
|
|
198
140
|
```ts title="src/c15t.client.ts"
|
|
199
|
-
import type { C15tClientOptionsExtension } from '
|
|
141
|
+
import type { C15tClientOptionsExtension } from 'c15t/astro';
|
|
200
142
|
import { scripts } from './consent-scripts';
|
|
201
143
|
|
|
202
144
|
export default { scripts } satisfies C15tClientOptionsExtension;
|
|
203
145
|
```
|
|
204
146
|
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
147
|
+
Vendor helpers contain callbacks, and the integration options in
|
|
148
|
+
`astro.config.mjs` are serialized into the page, so do not put helpers in
|
|
149
|
+
the integration's `scripts` option. The integration passes the client
|
|
150
|
+
entrypoint to the one runtime every page shares, including across
|
|
208
151
|
`ClientRouter` navigation.
|
|
209
152
|
|
|
210
153
|
**Svelte**
|
|
@@ -214,73 +157,156 @@ pass them as a top-level prop:
|
|
|
214
157
|
|
|
215
158
|
```svelte title="src/App.svelte"
|
|
216
159
|
<script lang="ts">
|
|
217
|
-
import {
|
|
160
|
+
import { ConsentProvider, manifest } from '@c15t/svelte';
|
|
218
161
|
import { scripts } from './consent-scripts';
|
|
219
|
-
|
|
220
|
-
const backendURL = import.meta.env.VITE_C15T_BACKEND_URL;
|
|
221
|
-
if (!backendURL) throw new Error('Set VITE_C15T_BACKEND_URL');
|
|
222
|
-
const mode = hosted({ url: backendURL });
|
|
223
162
|
</script>
|
|
224
163
|
|
|
225
|
-
<
|
|
164
|
+
<ConsentProvider mode={manifest()} {scripts}>
|
|
226
165
|
<!-- Keep your application, consent UI and preferences link here. -->
|
|
227
|
-
</
|
|
166
|
+
</ConsentProvider>
|
|
228
167
|
```
|
|
229
168
|
|
|
230
|
-
Retain the styles and consent UI from the [Svelte quickstart](https://c15t.com/docs/frameworks/svelte/quickstart).
|
|
169
|
+
Retain the styles and consent UI from the [Svelte quickstart](https://v3.c15t.com/docs/frameworks/svelte/quickstart).
|
|
231
170
|
The provider owns the loader and disposes it on unmount.
|
|
232
171
|
|
|
233
172
|
**SvelteKit**
|
|
234
173
|
|
|
235
|
-
Add the scripts to the existing root layout
|
|
236
|
-
and
|
|
174
|
+
Add the scripts to the existing `ConsentRoot` in the root layout. Keep the
|
|
175
|
+
handle and the layout load from the [SvelteKit quickstart](https://v3.c15t.com/docs/frameworks/sveltekit/quickstart).
|
|
237
176
|
|
|
238
177
|
```svelte title="src/routes/+layout.svelte"
|
|
239
178
|
<script lang="ts">
|
|
240
|
-
import {
|
|
179
|
+
import { ConsentRoot } from '@c15t/svelte';
|
|
241
180
|
import { scripts } from '../consent-scripts';
|
|
242
181
|
|
|
243
182
|
let { children, data } = $props();
|
|
244
|
-
const mode = hosted({ url: data.backendURL });
|
|
245
183
|
</script>
|
|
246
184
|
|
|
247
|
-
<
|
|
185
|
+
<ConsentRoot state={data.consent} {scripts}>
|
|
248
186
|
{@render children()}
|
|
249
187
|
<!-- Keep your consent UI and preferences link here. -->
|
|
250
|
-
</
|
|
188
|
+
</ConsentRoot>
|
|
251
189
|
```
|
|
252
190
|
|
|
253
|
-
Import vendor helpers in the layout component, not in `+layout.server.ts
|
|
254
|
-
|
|
255
|
-
|
|
191
|
+
Import vendor helpers in the layout component, not in `+layout.server.ts`:
|
|
192
|
+
a server load cannot send functions to the browser. Prerendered, static and
|
|
193
|
+
SPA-mode pages use the same `scripts` prop. If you pass an externally owned
|
|
256
194
|
`runtime` to the provider, register scripts when creating that runtime instead.
|
|
257
195
|
|
|
196
|
+
**HTML**
|
|
197
|
+
|
|
198
|
+
The helpers in `@c15t/integrations` are ES modules that need a bundler. On a
|
|
199
|
+
page that loads the c15t script tag, paste the vendor's own snippet instead
|
|
200
|
+
and keep it inert until its category is allowed:
|
|
201
|
+
|
|
202
|
+
```html
|
|
203
|
+
<script type="text/plain" data-c15t-category="measurement">
|
|
204
|
+
// The vendor's snippet, unchanged
|
|
205
|
+
</script>
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
Use the category this guide names for the vendor. c15t runs the snippet
|
|
209
|
+
once that category is allowed, and reloads the page when the visitor
|
|
210
|
+
withdraws it. Helper options on this page, such as `loadMode`, do not apply
|
|
211
|
+
to a pasted snippet. See [HTML scripts](https://v3.c15t.com/docs/frameworks/html/scripts).
|
|
212
|
+
|
|
258
213
|
**JavaScript**
|
|
259
214
|
|
|
260
|
-
|
|
261
|
-
`kernel.commands.init()`:
|
|
215
|
+
Pass the scripts to `init()` from `@c15t/browser`, next to your mode:
|
|
262
216
|
|
|
263
217
|
```ts
|
|
264
|
-
import {
|
|
218
|
+
import { init, manifest } from '@c15t/browser';
|
|
265
219
|
import { scripts } from './consent-scripts';
|
|
266
220
|
|
|
267
|
-
const
|
|
221
|
+
const consent = init({
|
|
222
|
+
mode: manifest(),
|
|
223
|
+
scripts,
|
|
224
|
+
});
|
|
268
225
|
```
|
|
269
226
|
|
|
270
|
-
|
|
271
|
-
`
|
|
272
|
-
|
|
273
|
-
|
|
227
|
+
Keep the mode from your quickstart. With
|
|
228
|
+
`createConsentRuntime` from `c15t/runtime`, pass `scripts` to it instead.
|
|
229
|
+
A kernel you create yourself needs a loader from
|
|
230
|
+
`c15t/modules/script-loader`. Attach one loader per kernel. See
|
|
231
|
+
[JavaScript scripts](https://v3.c15t.com/docs/frameworks/javascript/scripts).
|
|
232
|
+
|
|
233
|
+
## Options
|
|
234
|
+
|
|
235
|
+
| Option | Default | Behavior |
|
|
236
|
+
| ----------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
237
|
+
| `id` | Required | Container ID, for example `GTM-1234XXX`. The helper trims it. Empty or whitespace-only values log an error and the script does not load. |
|
|
238
|
+
| `dataLayer` | `'dataLayer'` | Queue name. A custom name adds `&l=<name>` to the container URL and renames the helper's queue function to `<name>Gtag`. |
|
|
239
|
+
| `updateEventName` | `'consent-update'` | `dataLayer` event pushed after every consent update. Use it as a GTM trigger. |
|
|
240
|
+
| `consentMapping` | The table below | Replaces the category-to-Google mapping. |
|
|
241
|
+
| `loadMode` | `'always'` | When `gtm.js` loads. See [choose when the container loads](#choose-when-the-container-loads). |
|
|
242
|
+
| `category` | `'necessary'`, or `{ or: ['measurement', 'marketing'] }` with `loadMode: 'after-consent'` | Consent condition for the container. With `'after-consent'`, `gtm.js` waits for it. With `'always'`, it sets the script's permission, which callbacks receive, but does not delay loading. |
|
|
274
243
|
|
|
275
|
-
##
|
|
244
|
+
## Choose when the container loads
|
|
276
245
|
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
Google
|
|
246
|
+
| `loadMode` | Until the category is allowed | After the category is allowed |
|
|
247
|
+
| ----------------- | ---------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
248
|
+
| `'always'` | Loads `gtm.js` and sends `consent` `default` with the current permissions before the `gtm.js` start event. | Sends `consent` `update`, then the `consent-update` event. |
|
|
249
|
+
| `'after-consent'` | Sends nothing to Google. The helper creates no `dataLayer` or `gtag` function. | Loads `gtm.js` once. `consent` `default` carries the current permissions and comes before the `gtm.js` start event. Later changes send `update` and `consent-update`. |
|
|
250
|
+
|
|
251
|
+
Use `'after-consent'` when your policy forbids any request to Google before
|
|
252
|
+
the visitor opts in:
|
|
253
|
+
|
|
254
|
+
```ts title="src/consent-scripts.ts (partial)"
|
|
255
|
+
googleTagManager({ id: 'GTM-XXXXXXX', loadMode: 'after-consent' }),
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
`'after-consent'` waits for the category to be allowed, not for a recorded
|
|
259
|
+
choice. Under an `opt-in` policy, that happens when the visitor allows it.
|
|
260
|
+
Under an `opt-out` or `none` policy, optional categories are allowed before a
|
|
261
|
+
choice, so `gtm.js` loads on the first page unless a saved refusal or a
|
|
262
|
+
privacy signal restricts the category; see
|
|
263
|
+
[policies](../concepts/policies.md).
|
|
264
|
+
|
|
265
|
+
`necessary` is always allowed, so a gated container needs another category.
|
|
266
|
+
This mode defaults to `{ or: ['measurement', 'marketing'] }`. A container
|
|
267
|
+
usually holds Analytics tags and advertising tags, and this default loads it
|
|
268
|
+
once the visitor allows either purpose. Google tags inside still follow the
|
|
269
|
+
Consent Mode types, so an Ads tag stays restricted for a visitor who allowed
|
|
270
|
+
only measurement. If the container holds only Analytics tags, pass
|
|
271
|
+
`category: 'measurement'`.
|
|
272
|
+
|
|
273
|
+
This mode gives up part of Consent Mode. With `'always'`, Google tags send
|
|
274
|
+
cookieless pings while a type is denied, and Google uses them to model
|
|
275
|
+
conversions and behavior for visitors who refused or have not chosen. With
|
|
276
|
+
`'after-consent'`, visitors whose category is denied send nothing, so Google
|
|
277
|
+
has no data to model them from. Reports cover only visitors who allowed the
|
|
278
|
+
category.
|
|
279
|
+
|
|
280
|
+
The container starts with the visitor's current choice in its `default`
|
|
281
|
+
command. On the page where the visitor accepts, it loads after the choice, so
|
|
282
|
+
no `consent-update` event fires for that choice. Triggers that wait only for
|
|
283
|
+
`consent-update` first fire on a later change. Use the tag's consent settings,
|
|
284
|
+
described below, for tags that should fire on the first page.
|
|
285
|
+
|
|
286
|
+
When the visitor withdraws the category, c15t reloads the page and the new
|
|
287
|
+
page does not load `gtm.js`. With `reloadOnConsentRevoked: false`, the running
|
|
288
|
+
container stays on the page and gets an `update` that denies the withdrawn
|
|
289
|
+
types. A later grant reuses it instead of starting a second container.
|
|
290
|
+
|
|
291
|
+
## Google loads before a choice by default
|
|
292
|
+
|
|
293
|
+
With the default `loadMode: 'always'`, the `googleTagManager` and `gtag`
|
|
294
|
+
helpers set `alwaysLoad: true`. Before the visitor chooses, the helper creates
|
|
295
|
+
the `dataLayer` queue, sends `gtag('consent', 'default', ...)` with the current
|
|
296
|
+
permissions and loads Google's script. After each permission change it sends
|
|
297
|
+
`gtag('consent', 'update', ...)`. Google's tags then adjust what they store and
|
|
298
|
+
send; see Google's
|
|
281
299
|
[Consent Mode overview](https://developers.google.com/tag-platform/security/concepts/consent-mode).
|
|
282
300
|
|
|
283
|
-
|
|
301
|
+
So the browser contacts Google before consent. If your policy requires no
|
|
302
|
+
Google request until the visitor allows it, set `loadMode: 'after-consent'`.
|
|
303
|
+
The helper then creates nothing and requests nothing until its category is
|
|
304
|
+
allowed. When it loads, it sends the `default` command first, with the
|
|
305
|
+
permissions at that moment, and `update` commands after later changes. Under
|
|
306
|
+
an `opt-out` or `none` policy, optional categories are allowed before a
|
|
307
|
+
choice, so the helper loads on the first page.
|
|
308
|
+
|
|
309
|
+
## How categories map to Google consent types
|
|
284
310
|
|
|
285
311
|
| c15t category | Google consent types |
|
|
286
312
|
| --------------- | -------------------------------------------------- |
|
|
@@ -290,17 +316,64 @@ The default mapping is:
|
|
|
290
316
|
| `marketing` | `ad_storage`, `ad_user_data`, `ad_personalization` |
|
|
291
317
|
| `experience` | `personalization_storage` |
|
|
292
318
|
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
Configure
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
319
|
+
Each Google type is `granted` when its category is allowed and `denied`
|
|
320
|
+
otherwise. If a visitor turns off the helper's vendor, every optional type is
|
|
321
|
+
sent as `denied`. The `consentMapping` option replaces the whole table, so
|
|
322
|
+
include every category you still want signalled.
|
|
323
|
+
|
|
324
|
+
Under an opt-out policy, the default command can grant types before the
|
|
325
|
+
visitor has chosen anything. That is a permission, not a recorded choice.
|
|
326
|
+
|
|
327
|
+
## Configure consent inside the container
|
|
328
|
+
|
|
329
|
+
With the default `loadMode: 'always'`, `googleTagManager` uses the `necessary`
|
|
330
|
+
category and `alwaysLoad`, so the container loads on every page. With
|
|
331
|
+
`'after-consent'`, it loads once its category is allowed. In both modes,
|
|
332
|
+
consent signals reach Google tags that support Consent Mode. Other tags in the
|
|
333
|
+
container, such as a third-party pixel added as Custom HTML, ignore those
|
|
334
|
+
signals and fire on their triggers.
|
|
335
|
+
|
|
336
|
+
For each non-Google tag, add a consent requirement in the tag's consent
|
|
337
|
+
settings, or fire it from a Custom Event trigger on `consent-update`. If a
|
|
338
|
+
vendor must make no request before consent, remove it from the container and
|
|
339
|
+
register its own c15t helper instead.
|
|
340
|
+
|
|
341
|
+
## Measure opt-in rate
|
|
342
|
+
|
|
343
|
+
If you run a banner experiment, the backend already counts visitors and
|
|
344
|
+
choices per arm. To see the arm in GTM as well, forward the `onSurfaceShown` and
|
|
345
|
+
`onChoiceRecorded` callbacks, which carry `experiment: { id, arm }`. See
|
|
346
|
+
[banner experiments](../guides/banner-experiments.md#send-the-events-to-your-own-analytics-too).
|
|
347
|
+
|
|
348
|
+
## Verify Google Tag Manager
|
|
349
|
+
|
|
350
|
+
With the default `loadMode: 'always'`:
|
|
351
|
+
|
|
352
|
+
1. In a private window with an opt-in policy, load the page. `gtm.js` loads.
|
|
353
|
+
In Google Tag Assistant, the first consent command is `default` with
|
|
354
|
+
`analytics_storage` and `ad_storage` set to `denied`.
|
|
355
|
+
2. Click Reject, then reload. The `default` command still denies every
|
|
356
|
+
optional type, and in DevTools Network no non-Google tag in the container
|
|
357
|
+
fires.
|
|
358
|
+
3. Open Privacy settings and allow measurement. Tag Assistant shows an
|
|
359
|
+
`update` command with `analytics_storage` set to `granted`, followed by a
|
|
360
|
+
`consent-update` event, and measurement tags fire.
|
|
361
|
+
4. Turn measurement off again and save. c15t reloads the page, and the new
|
|
362
|
+
page starts with `analytics_storage` denied.
|
|
363
|
+
|
|
364
|
+
With `loadMode: 'after-consent'`:
|
|
365
|
+
|
|
366
|
+
1. In a private window with an opt-in policy, filter DevTools Network by
|
|
367
|
+
`google` and load the page. No request appears, and `window.dataLayer` is
|
|
368
|
+
`undefined` in the Console.
|
|
369
|
+
2. Allow measurement. `gtm.js` loads once. In Tag Assistant, the first command
|
|
370
|
+
is `consent` `default` with `analytics_storage` set to `granted`, before
|
|
371
|
+
the container starts.
|
|
372
|
+
3. Allow marketing as well. Tag Assistant shows an `update` command that
|
|
373
|
+
grants the ad types, followed by a `consent-update` event. No second
|
|
374
|
+
`gtm.js` request appears.
|
|
375
|
+
4. Turn both off again and save. c15t reloads the page, and the new page makes
|
|
376
|
+
no request to Google.
|
|
377
|
+
|
|
378
|
+
See the [consent verification guide](../guides/verify-consent.md) for
|
|
379
|
+
navigation and hosting checks.
|