@c15t/scripts 3.0.0-alpha.2 → 3.0.0-alpha.4

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.
Files changed (300) hide show
  1. package/AGENTS.md +129 -63
  2. package/README.md +8 -29
  3. package/SKILL.md +33 -0
  4. package/dist/adobe-analytics.js +2 -0
  5. package/dist/ahrefs-analytics.js +2 -0
  6. package/dist/amplitude.js +2 -0
  7. package/dist/clearbit.js +2 -0
  8. package/dist/cloudflare-web-analytics.js +2 -0
  9. package/dist/cloudflare-zaraz.js +2 -0
  10. package/dist/crisp.js +2 -0
  11. package/dist/databuddy.js +2 -0
  12. package/dist/e2e-test-utils.js +2 -139
  13. package/dist/engine/compile.js +2 -89
  14. package/dist/engine/runtime.js +2 -448
  15. package/dist/events.js +2 -218
  16. package/dist/fathom-analytics.js +2 -0
  17. package/dist/front-chat.js +2 -0
  18. package/dist/google-tag-manager.js +2 -0
  19. package/dist/google-tag.js +2 -0
  20. package/dist/heap.js +2 -0
  21. package/dist/hightouch.js +2 -0
  22. package/dist/hotjar.js +2 -0
  23. package/dist/intercom.js +2 -0
  24. package/dist/klaviyo.js +2 -0
  25. package/dist/linkedin-insights.js +2 -0
  26. package/dist/logrocket.js +2 -0
  27. package/dist/matomo-analytics.js +2 -0
  28. package/dist/meta-pixel.js +2 -0
  29. package/dist/microsoft-clarity.js +2 -0
  30. package/dist/microsoft-uet.js +2 -0
  31. package/dist/mixpanel-analytics.js +2 -0
  32. package/dist/one-dollar-stats.js +2 -0
  33. package/dist/openai-pixel.js +2 -0
  34. package/dist/pinterest-tag.js +2 -0
  35. package/dist/pirsch.js +2 -0
  36. package/dist/plausible-analytics.js +2 -0
  37. package/dist/posthog.js +2 -0
  38. package/dist/promptwatch.js +2 -0
  39. package/dist/reddit-pixel.js +2 -0
  40. package/dist/registry.js +2 -422
  41. package/dist/resolve.js +2 -33
  42. package/dist/rudderstack.js +2 -0
  43. package/dist/rybbit-analytics.js +2 -0
  44. package/dist/segment.js +2 -0
  45. package/dist/snapchat-pixel.js +2 -0
  46. package/dist/tiktok-pixel.js +2 -0
  47. package/dist/types.js +2 -16
  48. package/dist/umami-analytics.js +2 -0
  49. package/dist/vendors/_shared/attributes.js +2 -14
  50. package/dist/vendors/_shared/google-consent.js +2 -27
  51. package/dist/vendors/_shared/install-builders.js +2 -21
  52. package/dist/vendors/_shared/required-id.js +2 -0
  53. package/dist/vendors/_shared/script-url.js +2 -28
  54. package/dist/vendors/ads-and-pixels/linkedin-insights.js +2 -48
  55. package/dist/vendors/ads-and-pixels/meta-pixel.js +2 -153
  56. package/dist/vendors/ads-and-pixels/microsoft-uet.js +2 -110
  57. package/dist/vendors/ads-and-pixels/openai-pixel.js +2 -88
  58. package/dist/vendors/ads-and-pixels/pinterest-tag.js +2 -123
  59. package/dist/vendors/ads-and-pixels/reddit-pixel.js +2 -107
  60. package/dist/vendors/ads-and-pixels/snapchat-pixel.js +2 -87
  61. package/dist/vendors/ads-and-pixels/tiktok-pixel.js +2 -89
  62. package/dist/vendors/ads-and-pixels/x-pixel.js +2 -48
  63. package/dist/vendors/analytics/adobe-analytics.js +2 -49
  64. package/dist/vendors/analytics/ahrefs-analytics.js +2 -27
  65. package/dist/vendors/analytics/amplitude.js +2 -134
  66. package/dist/vendors/analytics/clearbit.js +2 -28
  67. package/dist/vendors/analytics/cloudflare-web-analytics.js +2 -32
  68. package/dist/vendors/analytics/databuddy.js +2 -103
  69. package/dist/vendors/analytics/fathom-analytics.js +2 -35
  70. package/dist/vendors/analytics/google-tag.js +2 -78
  71. package/dist/vendors/analytics/heap.js +2 -134
  72. package/dist/vendors/analytics/hightouch.js +2 -109
  73. package/dist/vendors/analytics/hotjar.js +2 -44
  74. package/dist/vendors/analytics/logrocket.js +2 -58
  75. package/dist/vendors/analytics/matomo-analytics.js +2 -191
  76. package/dist/vendors/analytics/microsoft-clarity.js +2 -100
  77. package/dist/vendors/analytics/mixpanel-analytics.js +2 -93
  78. package/dist/vendors/analytics/one-dollar-stats.js +2 -30
  79. package/dist/vendors/analytics/pirsch.js +2 -67
  80. package/dist/vendors/analytics/plausible-analytics.js +2 -81
  81. package/dist/vendors/analytics/posthog.js +2 -200
  82. package/dist/vendors/analytics/promptwatch.js +2 -29
  83. package/dist/vendors/analytics/rudderstack.js +2 -183
  84. package/dist/vendors/analytics/rybbit-analytics.js +2 -63
  85. package/dist/vendors/analytics/segment.js +2 -65
  86. package/dist/vendors/analytics/umami-analytics.js +2 -39
  87. package/dist/vendors/analytics/vercel-analytics.js +2 -53
  88. package/dist/vendors/email-and-sms/klaviyo.js +2 -0
  89. package/dist/vendors/functional/crisp.js +2 -100
  90. package/dist/vendors/functional/front-chat.js +2 -64
  91. package/dist/vendors/functional/intercom.js +2 -45
  92. package/dist/vendors/tag-managers/cloudflare-zaraz.js +2 -98
  93. package/dist/vendors/tag-managers/google-tag-manager.js +2 -73
  94. package/dist/vercel-analytics.js +2 -0
  95. package/dist/x-pixel.js +2 -0
  96. package/dist-types/adobe-analytics.d.ts +2 -0
  97. package/dist-types/ahrefs-analytics.d.ts +2 -0
  98. package/dist-types/amplitude.d.ts +2 -0
  99. package/dist-types/clearbit.d.ts +2 -0
  100. package/dist-types/cloudflare-web-analytics.d.ts +2 -0
  101. package/dist-types/cloudflare-zaraz.d.ts +2 -0
  102. package/dist-types/crisp.d.ts +2 -0
  103. package/dist-types/databuddy.d.ts +2 -0
  104. package/dist-types/e2e-test-utils.d.ts +2 -0
  105. package/dist-types/engine/compile.d.ts +2 -3
  106. package/dist-types/engine/runtime.d.ts +2 -3
  107. package/dist-types/events.d.ts +2 -46
  108. package/dist-types/fathom-analytics.d.ts +2 -0
  109. package/dist-types/front-chat.d.ts +2 -0
  110. package/dist-types/google-tag-manager.d.ts +2 -0
  111. package/dist-types/google-tag.d.ts +2 -0
  112. package/dist-types/heap.d.ts +2 -0
  113. package/dist-types/hightouch.d.ts +2 -0
  114. package/dist-types/hotjar.d.ts +2 -0
  115. package/dist-types/intercom.d.ts +2 -0
  116. package/dist-types/klaviyo.d.ts +2 -0
  117. package/dist-types/linkedin-insights.d.ts +2 -0
  118. package/dist-types/logrocket.d.ts +2 -0
  119. package/dist-types/matomo-analytics.d.ts +2 -0
  120. package/dist-types/meta-pixel.d.ts +2 -0
  121. package/dist-types/microsoft-clarity.d.ts +2 -0
  122. package/dist-types/microsoft-uet.d.ts +2 -0
  123. package/dist-types/mixpanel-analytics.d.ts +2 -0
  124. package/dist-types/one-dollar-stats.d.ts +2 -0
  125. package/dist-types/openai-pixel.d.ts +2 -0
  126. package/dist-types/pinterest-tag.d.ts +2 -0
  127. package/dist-types/pirsch.d.ts +2 -0
  128. package/dist-types/plausible-analytics.d.ts +2 -0
  129. package/dist-types/posthog.d.ts +2 -0
  130. package/dist-types/promptwatch.d.ts +2 -0
  131. package/dist-types/reddit-pixel.d.ts +2 -0
  132. package/dist-types/registry.d.ts +2 -485
  133. package/dist-types/resolve.d.ts +2 -9
  134. package/dist-types/rudderstack.d.ts +2 -0
  135. package/dist-types/rybbit-analytics.d.ts +2 -0
  136. package/dist-types/segment.d.ts +2 -0
  137. package/dist-types/snapchat-pixel.d.ts +2 -0
  138. package/dist-types/tiktok-pixel.d.ts +2 -0
  139. package/dist-types/types.d.ts +2 -314
  140. package/dist-types/umami-analytics.d.ts +2 -0
  141. package/dist-types/vendors/_shared/attributes.d.ts +2 -35
  142. package/dist-types/vendors/_shared/google-consent.d.ts +2 -47
  143. package/dist-types/vendors/_shared/install-builders.d.ts +2 -30
  144. package/dist-types/vendors/_shared/required-id.d.ts +2 -0
  145. package/dist-types/vendors/_shared/script-url.d.ts +2 -75
  146. package/dist-types/vendors/ads-and-pixels/linkedin-insights.d.ts +2 -92
  147. package/dist-types/vendors/ads-and-pixels/meta-pixel.d.ts +2 -289
  148. package/dist-types/vendors/ads-and-pixels/microsoft-uet.d.ts +2 -105
  149. package/dist-types/vendors/ads-and-pixels/openai-pixel.d.ts +2 -211
  150. package/dist-types/vendors/ads-and-pixels/pinterest-tag.d.ts +2 -295
  151. package/dist-types/vendors/ads-and-pixels/reddit-pixel.d.ts +2 -210
  152. package/dist-types/vendors/ads-and-pixels/snapchat-pixel.d.ts +2 -171
  153. package/dist-types/vendors/ads-and-pixels/tiktok-pixel.d.ts +2 -106
  154. package/dist-types/vendors/ads-and-pixels/x-pixel.d.ts +2 -183
  155. package/dist-types/vendors/analytics/adobe-analytics.d.ts +2 -75
  156. package/dist-types/vendors/analytics/ahrefs-analytics.d.ts +2 -62
  157. package/dist-types/vendors/analytics/amplitude.d.ts +2 -234
  158. package/dist-types/vendors/analytics/clearbit.d.ts +2 -60
  159. package/dist-types/vendors/analytics/cloudflare-web-analytics.d.ts +2 -67
  160. package/dist-types/vendors/analytics/databuddy.d.ts +2 -147
  161. package/dist-types/vendors/analytics/fathom-analytics.d.ts +2 -90
  162. package/dist-types/vendors/analytics/google-tag.d.ts +2 -95
  163. package/dist-types/vendors/analytics/heap.d.ts +2 -316
  164. package/dist-types/vendors/analytics/hightouch.d.ts +2 -285
  165. package/dist-types/vendors/analytics/hotjar.d.ts +2 -73
  166. package/dist-types/vendors/analytics/logrocket.d.ts +2 -101
  167. package/dist-types/vendors/analytics/matomo-analytics.d.ts +2 -41
  168. package/dist-types/vendors/analytics/microsoft-clarity.d.ts +2 -97
  169. package/dist-types/vendors/analytics/mixpanel-analytics.d.ts +2 -113
  170. package/dist-types/vendors/analytics/one-dollar-stats.d.ts +2 -39
  171. package/dist-types/vendors/analytics/pirsch.d.ts +2 -96
  172. package/dist-types/vendors/analytics/plausible-analytics.d.ts +2 -122
  173. package/dist-types/vendors/analytics/posthog.d.ts +2 -175
  174. package/dist-types/vendors/analytics/promptwatch.d.ts +2 -36
  175. package/dist-types/vendors/analytics/rudderstack.d.ts +2 -330
  176. package/dist-types/vendors/analytics/rybbit-analytics.d.ts +2 -82
  177. package/dist-types/vendors/analytics/segment.d.ts +2 -164
  178. package/dist-types/vendors/analytics/umami-analytics.d.ts +2 -93
  179. package/dist-types/vendors/analytics/vercel-analytics.d.ts +2 -66
  180. package/dist-types/vendors/email-and-sms/klaviyo.d.ts +2 -0
  181. package/dist-types/vendors/functional/crisp.d.ts +2 -78
  182. package/dist-types/vendors/functional/front-chat.d.ts +2 -62
  183. package/dist-types/vendors/functional/intercom.d.ts +2 -135
  184. package/dist-types/vendors/tag-managers/cloudflare-zaraz.d.ts +2 -39
  185. package/dist-types/vendors/tag-managers/google-tag-manager.d.ts +2 -96
  186. package/dist-types/vercel-analytics.d.ts +2 -0
  187. package/dist-types/x-pixel.d.ts +2 -0
  188. package/docs/README.md +129 -63
  189. package/docs/assets/v3/bottom-bar.png +0 -0
  190. package/docs/assets/v3/brand-card.png +0 -0
  191. package/docs/assets/v3/brand-preferences.png +0 -0
  192. package/docs/assets/v3/choice-wall.png +0 -0
  193. package/docs/assets/v3/headless-bar-html.png +0 -0
  194. package/docs/assets/v3/headless-bar-mobile.png +0 -0
  195. package/docs/assets/v3/headless-bar.png +0 -0
  196. package/docs/assets/v3/slim-bar.png +0 -0
  197. package/docs/concepts/choose-your-setup.md +87 -0
  198. package/docs/concepts/consent-categories.md +84 -0
  199. package/docs/{guides → concepts}/consent-state.md +89 -105
  200. package/docs/{guides → concepts}/data-fetching.md +31 -27
  201. package/docs/concepts/how-consent-works.md +123 -0
  202. package/docs/concepts/policies.md +71 -0
  203. package/docs/customization/class-names.md +202 -0
  204. package/docs/customization/dark-mode.md +157 -0
  205. package/docs/customization/motion.md +119 -0
  206. package/docs/customization/overview.md +67 -34
  207. package/docs/customization/recipes.md +839 -49
  208. package/docs/customization/slots.md +216 -35
  209. package/docs/customization/stylesheets.md +147 -0
  210. package/docs/customization/tailwind.md +842 -0
  211. package/docs/customization/tokens.md +163 -96
  212. package/docs/customization/translations.md +60 -3
  213. package/docs/frameworks/astro/embeds.md +160 -0
  214. package/docs/frameworks/astro/network-blocker.md +86 -0
  215. package/docs/frameworks/astro/scripts.md +155 -0
  216. package/docs/frameworks/html/embeds.md +142 -0
  217. package/docs/frameworks/html/network-blocker.md +105 -0
  218. package/docs/frameworks/html/scripts.md +164 -0
  219. package/docs/frameworks/javascript/scripts.md +137 -0
  220. package/docs/frameworks/next/embeds.md +90 -0
  221. package/docs/frameworks/next/network-blocker.md +153 -0
  222. package/docs/frameworks/next/scripts.md +196 -0
  223. package/docs/frameworks/nuxt/embeds.md +81 -0
  224. package/docs/frameworks/nuxt/network-blocker.md +97 -0
  225. package/docs/frameworks/nuxt/scripts.md +89 -0
  226. package/docs/frameworks/react/embeds.md +89 -0
  227. package/docs/frameworks/react/network-blocker.md +140 -0
  228. package/docs/frameworks/react/scripts.md +115 -0
  229. package/docs/frameworks/svelte/embeds.md +96 -0
  230. package/docs/frameworks/svelte/network-blocker.md +141 -0
  231. package/docs/frameworks/svelte/scripts.md +144 -0
  232. package/docs/frameworks/sveltekit/embeds.md +103 -0
  233. package/docs/frameworks/sveltekit/network-blocker.md +159 -0
  234. package/docs/frameworks/sveltekit/scripts.md +172 -0
  235. package/docs/frameworks/tanstack-start/embeds.md +96 -0
  236. package/docs/frameworks/tanstack-start/network-blocker.md +145 -0
  237. package/docs/frameworks/tanstack-start/scripts.md +103 -0
  238. package/docs/frameworks/vue/embeds.md +84 -0
  239. package/docs/frameworks/vue/network-blocker.md +99 -0
  240. package/docs/frameworks/vue/scripts.md +93 -0
  241. package/docs/guides/banner-experiments.md +654 -0
  242. package/docs/guides/troubleshooting.md +120 -47
  243. package/docs/guides/verify-consent.md +81 -49
  244. package/docs/integrations/adobe-analytics.md +167 -159
  245. package/docs/integrations/ahrefs-analytics.md +152 -154
  246. package/docs/integrations/amplitude.md +162 -156
  247. package/docs/integrations/building-integrations.md +136 -37
  248. package/docs/integrations/clearbit.md +154 -154
  249. package/docs/integrations/cloudflare-web-analytics.md +156 -156
  250. package/docs/integrations/cloudflare-zaraz.md +209 -261
  251. package/docs/integrations/crisp.md +164 -158
  252. package/docs/integrations/databuddy.md +157 -173
  253. package/docs/integrations/fathom-analytics.md +158 -156
  254. package/docs/integrations/front-chat.md +167 -167
  255. package/docs/integrations/google-maps.md +118 -83
  256. package/docs/integrations/google-tag-manager.md +178 -163
  257. package/docs/integrations/google-tag.md +163 -160
  258. package/docs/integrations/heap.md +163 -155
  259. package/docs/integrations/hightouch.md +161 -157
  260. package/docs/integrations/hotjar.md +159 -155
  261. package/docs/integrations/intercom.md +183 -153
  262. package/docs/integrations/klaviyo.md +486 -0
  263. package/docs/integrations/linkedin-insights.md +174 -150
  264. package/docs/integrations/logrocket.md +160 -156
  265. package/docs/integrations/matomo-analytics.md +188 -178
  266. package/docs/integrations/meta-pixel.md +188 -150
  267. package/docs/integrations/microsoft-clarity.md +163 -155
  268. package/docs/integrations/microsoft-uet.md +148 -154
  269. package/docs/integrations/mixpanel-analytics.md +155 -160
  270. package/docs/integrations/one-dollar-stats.md +166 -165
  271. package/docs/integrations/openai-pixel.md +204 -301
  272. package/docs/integrations/overview.md +137 -80
  273. package/docs/integrations/pinterest-tag.md +191 -183
  274. package/docs/integrations/pirsch.md +169 -159
  275. package/docs/integrations/plausible-analytics.md +172 -158
  276. package/docs/integrations/posthog.md +313 -240
  277. package/docs/integrations/promptwatch.md +154 -154
  278. package/docs/integrations/reddit-pixel.md +185 -157
  279. package/docs/integrations/rudderstack.md +201 -186
  280. package/docs/integrations/rybbit-analytics.md +171 -160
  281. package/docs/integrations/segment.md +182 -154
  282. package/docs/integrations/snapchat-pixel.md +186 -156
  283. package/docs/integrations/tiktok-pixel.md +171 -150
  284. package/docs/integrations/umami-analytics.md +163 -158
  285. package/docs/integrations/vercel-analytics.md +166 -157
  286. package/docs/integrations/x-pixel.md +176 -150
  287. package/docs/integrations/youtube.md +121 -86
  288. package/docs/upgrade-v3.md +496 -467
  289. package/package.json +10 -257
  290. package/dist-types/__tests__/helpers.d.ts +0 -141
  291. package/docs/assets/v3/brand-bar.png +0 -0
  292. package/docs/assets/v3/mobile-card.png +0 -0
  293. package/docs/assets/v3/preferences.png +0 -0
  294. package/docs/frameworks/javascript/script-loader.md +0 -100
  295. package/docs/frameworks/next/script-loader.md +0 -216
  296. package/docs/frameworks/react/script-loader.md +0 -69
  297. package/docs/guides/deployment-modes.md +0 -75
  298. package/docs/guides/shared-consent-controls.md +0 -158
  299. package/docs/integrations/clear-on-revocation.md +0 -167
  300. package/docs/integrations/granular-consent.md +0 -210
@@ -1,48 +1,54 @@
1
1
  ---
2
2
  title: PostHog
3
- description: Choose PostHog loading and cookieless behavior, configure the
4
- region, and synchronize v3 permissions.
3
+ description: Load PostHog before or after measurement consent with the c15t
4
+ posthog helper, choose its cookieless behavior, turn off PostHog modules you
5
+ do not use, and sync consent with an SDK you already initialize.
6
+ icon: posthog
5
7
  group: integrations
6
8
  ---
7
9
 
8
10
  ## Configure PostHog
9
11
 
10
- Use the browser project token beginning with `phc_`. Select the region matching
11
- your PostHog project. This example waits for measurement permission before
12
- requesting the SDK.
12
+ Use the project token that starts with `phc_`, and the region of your PostHog
13
+ project. This example waits for measurement permission before requesting the
14
+ SDK, and turns off cookieless capture after a refusal.
13
15
 
14
- | Package manager | Command |
15
- | :-------------- | :-------------------------- |
16
- | npm | `npm install @c15t/scripts` |
17
- | pnpm | `pnpm add @c15t/scripts` |
18
- | yarn | `yarn add @c15t/scripts` |
19
- | bun | `bun add @c15t/scripts` |
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` |
20
22
 
21
23
  ```ts title="src/consent-scripts.ts"
22
- import { posthog } from '@c15t/scripts/posthog';
24
+ import { posthog } from '@c15t/integrations/posthog';
23
25
 
24
26
  export const scripts = [
25
- posthog({
26
- id: 'phc_YOUR_PROJECT_TOKEN',
27
- region: 'eu',
28
- loadMode: 'after-consent',
29
- initOptions: { cookieless_mode: 'never' },
30
- }),
27
+ posthog({
28
+ id: 'phc_YOUR_PROJECT_TOKEN',
29
+ region: 'eu',
30
+ loadMode: 'after-consent',
31
+ initOptions: { cookieless_mode: 'never' },
32
+ }),
31
33
  ];
32
34
  ```
33
35
 
34
- The helper initializes PostHog. Remove a separate `posthog-js` initializer,
35
- framework plugin or array snippet before using this setup.
36
+ The helper initializes PostHog itself. Remove any `posthog-js` initializer,
37
+ framework plugin or array snippet that also does, or follow
38
+ [use an existing PostHog SDK](#use-an-existing-posthog-sdk) instead.
36
39
 
37
40
  ## Register the scripts
38
41
 
39
42
  Complete your [framework quickstart](https://c15t.com/docs/frameworks) first. Keep its Inth
40
43
  endpoint, policy, styles and consent UI. Remove the vendor's original script,
41
- SDK initializer or tag-manager entry so c15t owns loading once.
44
+ SDK initializer or tag-manager entry, so the vendor loads only through c15t.
42
45
 
43
- The `scripts` export in `src/consent-scripts.ts` is a configuration, not an
44
- initializer. Add it to your existing consent owner using the registration point
45
- below. These are partial edits to that owner, not additional providers.
46
+ The vendor pages put the helper in `src/consent-scripts.ts`. If your framework
47
+ quickstart already created a scripts file, such as `lib/scripts.ts` in the
48
+ Next.js guide, add the helper to that array instead of creating a second file.
49
+ The `scripts` export is a configuration, not an initializer. Add it to the c15t provider you already have, at the registration
50
+ point for your framework below. These are edits to that provider, not a second
51
+ provider.
46
52
 
47
53
  **Next.js**
48
54
 
@@ -63,158 +69,106 @@ router guide. Its manifest, init and save URLs stay in effect. Add
63
69
  </ConsentRoot>
64
70
  ```
65
71
 
66
- For a Pages Router or static-export setup using `ConsentProvider`, add
67
- `scripts` to its existing `options` instead. Keep the router-specific setup
68
- from [Next.js script loading](../frameworks/next/script-loader.md).
72
+ App Router, Pages Router and static export all use this `ConsentRoot` in
73
+ the `'use client'` wrapper `components/consent.tsx`. Keep `scripts` there,
74
+ because a Server Component cannot pass script callbacks to it. See
75
+ [Next.js scripts and embeds](../frameworks/next/scripts.md).
69
76
 
70
77
  **TanStack Start**
71
78
 
72
- In your existing root route component, import the scripts alongside
73
- `ConsentRoot`. Keep the server loader from the [TanStack Start quickstart](https://c15t.com/docs/frameworks/tanstack-start/quickstart).
79
+ Import the configuration into your root route and pass it to the existing
80
+ `ConsentRoot` as a top-level prop. Keep the loader, `backendURL` and
81
+ `initRoute` from the [TanStack Start quickstart](https://c15t.com/docs/frameworks/tanstack-start/quickstart):
74
82
 
75
- ```tsx
76
- import { Outlet } from '@tanstack/react-router';
77
- import { ConsentRoot } from 'c15t/tanstack-start';
83
+ ```tsx title="src/routes/__root.tsx"
78
84
  import { scripts } from '../consent-scripts';
79
85
 
80
- function Root() {
81
- const state = Route.useLoaderData();
82
- return (
83
- <ConsentRoot state={state} backendURL={backendURL} initRoute={false} scripts={scripts}>
84
- <Outlet />
85
- {/* Keep your consent banner, dialog and preferences link here. */}
86
- </ConsentRoot>
87
- );
88
- }
86
+ <ConsentRoot
87
+ state={consent}
88
+ backendURL={backendURL}
89
+ initRoute={false}
90
+ scripts={scripts}
91
+ >
89
92
  ```
90
93
 
91
- This edits the existing route. `Route` and `backendURL` come from its setup;
92
- keep the document shell and head components if they are part of your root.
93
- `initRoute={false}` keeps the quickstart's direct-backend initialization.
94
- If your app mounts a consent server route, retain its existing `initRoute`
95
- instead. Do not return script callbacks from a server function or route loader.
94
+ Import vendor helpers in the root route module, not in a server function.
95
+ A server function's return value must be serializable, and script
96
+ configurations carry callbacks. See
97
+ [TanStack Start scripts](../frameworks/tanstack-start/scripts.md).
96
98
 
97
99
  **React**
98
100
 
99
- Import the scripts into your existing provider component:
101
+ Add the configuration to the existing `ConsentProvider` options, next to
102
+ `mode`:
100
103
 
101
- ```ts
102
- import { ConsentProvider } from 'c15t/react';
104
+ ```tsx title="src/consent.tsx"
103
105
  import { scripts } from './consent-scripts';
104
- ```
105
106
 
106
- Keep the existing options and add `scripts`:
107
-
108
- ```tsx
109
- <ConsentProvider options={{ ...consentOptions, scripts }}>
110
- {children}
111
- </ConsentProvider>
107
+ <ConsentProvider options={{ mode, scripts }}>
112
108
  ```
113
109
 
114
- Here `consentOptions` is your existing configuration, including
115
- `mode: hosted({ url: backendURL })`. Keep the banner, dialog and preferences
116
- link inside the provider. See [React script loading](../frameworks/react/script-loader.md).
110
+ `mode` is the `hosted({ url: 'https://your-project.inth.app' })` value
111
+ from the [React quickstart](https://c15t.com/docs/frameworks/react/quickstart). Keep the banner,
112
+ dialog and preferences link inside the provider. See
113
+ [React scripts and embeds](../frameworks/react/scripts.md).
117
114
 
118
115
  **Nuxt**
119
116
 
120
- Attach one loader from the root `app.vue`, after the Nuxt module has
121
- started its browser runtime. This keeps vendor callbacks in application code rather
122
- than serialized `nuxt.config.ts` runtime configuration.
117
+ Register the scripts under the `c15t` key in `app/app.config.ts`. Adjust the
118
+ relative import to where you created `consent-scripts.ts`:
123
119
 
124
- ```vue title="app/app.vue"
125
- <script setup lang="ts">
126
- import { onUnmounted } from 'vue';
127
- import { createScriptLoader } from 'c15t/modules/script-loader';
120
+ ```ts title="app/app.config.ts"
128
121
  import { scripts } from '../src/consent-scripts';
129
122
 
130
- const nuxtApp = useNuxtApp();
131
- const kernel = useConsentKernel();
132
- let loader: ReturnType<typeof createScriptLoader> | undefined;
133
-
134
- const removeMountedHook = nuxtApp.hook('app:mounted', () => {
135
- loader = createScriptLoader({ kernel, scripts });
123
+ export default defineAppConfig({
124
+ c15t: { scripts },
136
125
  });
137
- onUnmounted(() => {
138
- removeMountedHook();
139
- loader?.dispose();
140
- });
141
- </script>
142
-
143
- <template>
144
- <ConsentRoot />
145
- <NuxtPage />
146
- </template>
147
126
  ```
148
127
 
149
- Merge the setup code into your root and retain its footer and preferences
150
- link. `useConsentKernel` is auto-imported by the c15t Nuxt module. Adjust the
151
- relative script import if your `app.vue` is at the project root. This loader
152
- waits until the module has applied browser persistence and privacy signals,
153
- then reads the current snapshot and observes future changes. Do not also register these scripts
154
- in another loader. See the [Nuxt quickstart](https://c15t.com/docs/frameworks/nuxt/quickstart).
128
+ The Nuxt module merges this over its options in `nuxt.config.ts` and starts
129
+ one script loader in the browser after hydration, once it has applied the
130
+ visitor's stored choice and privacy signals. Keep `scripts` out of
131
+ `nuxt.config.ts`, which reaches the browser as JSON and drops the vendor
132
+ callbacks. Write the vendor IDs into `consent-scripts.ts`. See
133
+ [Nuxt scripts and embeds](../frameworks/nuxt/scripts.md).
155
134
 
156
135
  **Vue**
157
136
 
158
- Use the kernel already provided by the Vue plugin. Merge this setup into
159
- `App.vue`, whose lifetime covers the application:
137
+ Pass the scripts to the existing `c15tVue` plugin call in `src/main.ts`:
160
138
 
161
- ```vue title="src/App.vue"
162
- <script setup lang="ts">
163
- import { onMounted, onUnmounted } from 'vue';
164
- import { createScriptLoader } from 'c15t/modules/script-loader';
165
- import { useConsentKernel } from 'c15t/vue/vue-plugin';
166
- import ConsentRoot from 'c15t/vue/consent-root';
139
+ ```ts title="src/main.ts"
167
140
  import { scripts } from './consent-scripts';
168
141
 
169
- const kernel = useConsentKernel();
170
- let loader: ReturnType<typeof createScriptLoader> | undefined;
171
-
172
- onMounted(() => {
173
- loader = createScriptLoader({ kernel, scripts });
142
+ app.use(c15tVue, {
143
+ backendURL: 'https://your-project.inth.app',
144
+ scripts,
174
145
  });
175
- onUnmounted(() => loader?.dispose());
176
- </script>
177
-
178
- <template>
179
- <ConsentRoot />
180
- <main>Your application</main>
181
- </template>
182
146
  ```
183
147
 
184
- Keep your existing page content and preferences link. The plugin still owns
185
- the kernel and persistence; this component owns only the vendor loader.
186
- Do not register the same scripts in plugin configuration as well. See the
187
- [Vue quickstart](https://c15t.com/docs/frameworks/vue/quickstart).
148
+ Keep your existing backend URL and other options. The plugin starts one
149
+ script loader when the app mounts, after it has applied the visitor's stored
150
+ choice. Do not also call `createScriptLoader` from a component. See
151
+ [Vue scripts and embeds](../frameworks/vue/scripts.md).
188
152
 
189
153
  **Astro**
190
154
 
191
- Point the existing Astro integration at a client module. Keep its `mode`,
192
- `ui` and framework integration from the [Astro quickstart](https://c15t.com/docs/frameworks/astro/quickstart).
193
- Import `fileURLToPath` in your Astro configuration:
194
-
195
- ```js title="astro.config.mjs"
196
- import { fileURLToPath } from 'node:url';
197
- ```
198
-
199
- Add this option to the existing `c15t({ ... })` call. Resolve the path from
200
- the configuration file because Astro injects the import into a virtual module:
201
-
202
- ```js
203
- clientEntrypoint: fileURLToPath(new URL('./src/c15t.client.ts', import.meta.url)),
204
- ```
205
-
206
- Export the scripts from that module:
155
+ Add the scripts to the client entrypoint from the
156
+ [Astro quickstart](https://c15t.com/docs/frameworks/astro/quickstart), the module that the
157
+ integration's `clientEntrypoint` option names. Keep `mode`, `ui` and the
158
+ framework integration in `astro.config.mjs` as they are. If the module
159
+ already exports scripts, combine the two arrays.
207
160
 
208
- ```ts title="src/c15t.client.ts"
161
+ ```ts title="src/consent-client.ts"
209
162
  import type { C15tClientOptionsExtension } from 'c15t/astro';
210
163
  import { scripts } from './consent-scripts';
211
164
 
212
165
  export default { scripts } satisfies C15tClientOptionsExtension;
213
166
  ```
214
167
 
215
- The integration passes this extension to its shared browser runtime. Vendor
216
- helpers contain callbacks, so do not put them in the serialized `scripts`
217
- option in `astro.config.mjs`. Keep one runtime across consent islands and
168
+ Vendor helpers contain callbacks, and the integration options in
169
+ `astro.config.mjs` are serialized into the page, so do not put helpers in
170
+ the integration's `scripts` option. The integration passes the client
171
+ entrypoint to the one runtime every page shares, including across
218
172
  `ClientRouter` navigation.
219
173
 
220
174
  **Svelte**
@@ -227,9 +181,7 @@ pass them as a top-level prop:
227
181
  import { ConsentManagerProvider, hosted } from '@c15t/svelte';
228
182
  import { scripts } from './consent-scripts';
229
183
 
230
- const backendURL = import.meta.env.VITE_C15T_BACKEND_URL;
231
- if (!backendURL) throw new Error('Set VITE_C15T_BACKEND_URL');
232
- const mode = hosted({ url: backendURL });
184
+ const mode = hosted({ url: 'https://your-project.inth.app' });
233
185
  </script>
234
186
 
235
187
  <ConsentManagerProvider {mode} {scripts}>
@@ -251,7 +203,7 @@ and its serializable prefetch data from the [SvelteKit quickstart](https://c15t.
251
203
  import { scripts } from '../consent-scripts';
252
204
 
253
205
  let { children, data } = $props();
254
- const mode = hosted({ url: data.backendURL });
206
+ const mode = hosted({ url: 'https://your-project.inth.app' });
255
207
  </script>
256
208
 
257
209
  <ConsentManagerProvider {mode} {scripts} prefetch={data.prefetch}>
@@ -260,138 +212,259 @@ and its serializable prefetch data from the [SvelteKit quickstart](https://c15t.
260
212
  </ConsentManagerProvider>
261
213
  ```
262
214
 
263
- Import vendor helpers in the layout component, not in `+layout.server.ts`.
264
- For static hosting, keep your browser-only `mode` setup and omit request
265
- prefetch; the `scripts` prop stays the same. If you pass an externally owned
215
+ Import vendor helpers in the layout component, not in `+layout.server.ts`:
216
+ a server load cannot send functions to the browser. Prerendered, static and
217
+ SPA-mode pages use the same `scripts` prop. If you pass an externally owned
266
218
  `runtime` to the provider, register scripts when creating that runtime instead.
267
219
 
220
+ **HTML**
221
+
222
+ The helpers in `@c15t/integrations` are ES modules that need a bundler. On a
223
+ page that loads the c15t script tag, paste the vendor's own snippet instead
224
+ and keep it inert until its category is allowed:
225
+
226
+ ```html
227
+ <script type="text/plain" data-c15t-category="measurement">
228
+ // The vendor's snippet, unchanged
229
+ </script>
230
+ ```
231
+
232
+ Use the category this guide names for the vendor. c15t runs the snippet
233
+ once that category is allowed, and reloads the page when the visitor
234
+ withdraws it. Helper options on this page, such as `loadMode`, do not apply
235
+ to a pasted snippet. See [HTML scripts](../frameworks/html/scripts.md).
236
+
268
237
  **JavaScript**
269
238
 
270
- Attach the loader to your existing kernel before calling
271
- `kernel.commands.init()`:
239
+ Pass the scripts to `init()` from `@c15t/browser`, next to your backend
240
+ URL:
272
241
 
273
242
  ```ts
274
- import { createScriptLoader } from 'c15t/modules/script-loader';
243
+ import { init } from '@c15t/browser';
275
244
  import { scripts } from './consent-scripts';
276
245
 
277
- const loader = createScriptLoader({ kernel, scripts });
246
+ const consent = init({
247
+ backendURL: 'https://your-project.inth.app',
248
+ scripts,
249
+ });
278
250
  ```
279
251
 
280
- Call `loader.dispose()` when that application instance is destroyed.
281
- `kernel` is the hosted kernel from your quickstart. A provider-owned kernel
282
- already has a loader; do not attach a second one. See
283
- [JavaScript script loading](../frameworks/javascript/script-loader.md).
252
+ Keep the backend URL from your quickstart. With
253
+ `createConsentRuntime` from `c15t/runtime`, pass `scripts` to it instead.
254
+ A kernel you create yourself needs a loader from
255
+ `c15t/modules/script-loader`. Attach one loader per kernel. See
256
+ [JavaScript scripts](../frameworks/javascript/scripts.md).
257
+
258
+ ## Options
259
+
260
+ | Option | Default | Behavior |
261
+ | ----------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
262
+ | `id` | Required | Project token, starting with `phc_`. The helper trims it. Empty or whitespace-only values throw. |
263
+ | `region` | `'eu'` | `'eu'` or `'us'`. Picks the API, UI and loader hosts when you do not set them. |
264
+ | `apiHost` | `https://eu.i.posthog.com` | API host for a proxy or self-hosted PostHog. Without `scriptUrl`, the loader URL becomes `<apiHost>/static/array.js`. |
265
+ | `uiHost` | The region's UI host | UI host, for example `https://eu.posthog.com`. A custom `apiHost` with no `region` uses the API host. |
266
+ | `scriptUrl` | `https://eu-assets.i.posthog.com/static/array.js` | Loader URL override. A blank value falls back to the default. |
267
+ | `loadMode` | `'always'` | When the SDK loads. See the table below. |
268
+ | `features.surveys` | Unset | `false` sets `disable_surveys: true` and skips `surveys.js`. See [turn off features you do not use](#turn-off-features-you-do-not-use). |
269
+ | `features.heatmaps` | Unset, follows the project | Sets `capture_heatmaps`. |
270
+ | `features.deadClicks` | Unset, follows the project | Sets `capture_dead_clicks`. |
271
+ | `features.webVitals` | Unset, follows the project | Sets `capture_performance: { web_vitals }`. Replay network timing keeps following the project. |
272
+ | `features.featureFlags` | Unset, follows the project | `false` sets `advanced_disable_feature_flags: true` and stops `/flags` requests. |
273
+ | `initOptions` | `{ cookieless_mode: 'on_reject', defaults: '2026-01-30' }` | Options passed to `posthog.init`, merged over the defaults and `features`. The helper sets `api_host` and `ui_host` after your values, so change hosts with the options above. |
274
+
275
+ ## Loading and revocation
276
+
277
+ | `loadMode` | When PostHog loads | Consent sync |
278
+ | ----------------- | --------------------------------- | --------------------------------------------------------------------------- |
279
+ | `'always'` | On every page, before consent | Calls `opt_in_capturing` or `opt_out_capturing` at load and on every change |
280
+ | `'after-consent'` | Only while measurement is allowed | Calls `opt_in_capturing` at load and `opt_out_capturing` on revocation |
281
+ | `'disabled'` | Never | None. The helper returns an empty callback-only script |
282
+
283
+ `posthog` uses the `measurement` category. With the default
284
+ `cookieless_mode: 'on_reject'`, PostHog keeps capturing without cookies after a
285
+ refusal. That mode needs cookieless server hashing turned on in your PostHog
286
+ project; see
287
+ [PostHog's cookieless guide](https://posthog.com/tutorials/cookieless-tracking).
288
+ Set `cookieless_mode: 'never'`, as in the example, if a refusal must stop
289
+ capture.
284
290
 
285
- ## Choose loading and capture behavior separately
291
+ ## Turn off features you do not use
286
292
 
287
- | `loadMode` | SDK loading | Consent handling |
288
- | ------------------------------ | ------------------------------------- | --------------------------------------------------------------- |
289
- | `'after-consent'` | Waits for measurement permission | Calls PostHog opt-in and opt-out APIs after load and on changes |
290
- | `'always'`, the helper default | Loads even while permission is denied | Calls the same consent APIs |
291
- | `'disabled'` | Does not load PostHog | Does not synchronize consent with an SDK loaded elsewhere |
293
+ After `array.js` loads, PostHog reads your `posthog.init` options and the
294
+ project's remote config, then decides which extra modules to download and
295
+ whether to request `/flags`. Set a `features` switch to `false` for each
296
+ feature your site does not use:
292
297
 
293
- The helper defaults `initOptions.cookieless_mode` to `'on_reject'`. In that
294
- mode, PostHog can continue cookieless capture after denial. It requires the
295
- project's cookieless server hash setting. See
296
- [PostHog's cookieless guide](https://posthog.com/tutorials/cookieless-tracking).
298
+ ```ts
299
+ posthog({
300
+ id: 'phc_YOUR_PROJECT_TOKEN',
301
+ region: 'eu',
302
+ loadMode: 'after-consent',
303
+ features: {
304
+ surveys: false,
305
+ heatmaps: false,
306
+ deadClicks: false,
307
+ webVitals: false,
308
+ featureFlags: false,
309
+ },
310
+ });
311
+ ```
297
312
 
298
- The example overrides this with `'never'` so opting out is not a switch to
299
- cookieless capture. Loading after consent only controls the initial request;
300
- for later revocation, verify PostHog's opt-out behavior and stop application
301
- capture calls too. SDK code that already executed cannot be undone by removing
302
- its script element.
303
-
304
- ## Configure hosts and initialization
305
-
306
- | Option | Behavior |
307
- | ------------------------------ | ---------------------------------------------------------------------------------------- |
308
- | `id` | Browser project token. |
309
- | `region` | `'eu'` by default; use `'us'` for a US project. |
310
- | `apiHost / uiHost / scriptUrl` | Explicit overrides for proxy or self-hosted PostHog deployments. Keep all hosts aligned. |
311
- | `loadMode` | Defaults to `'always'`; choose deliberately. |
312
- | `initOptions` | Additional serializable SDK options, including the cookieless override. |
313
-
314
- The helper applies the resolved API and UI hosts after `initOptions`; use the
315
- top-level host fields to change them. A global `posthog` queue may exist before
316
- the SDK is ready. Neither API presence nor SDK readiness is a consent grant.
317
-
318
- ## Keep application events behind permission
319
-
320
- With the script helper registered, a React client component can guard an event
321
- using the current effective permission:
322
-
323
- ```tsx title="src/signup-event.tsx"
324
- 'use client';
325
-
326
- import { useConsent } from 'c15t/react';
327
-
328
- export function SignupEvent() {
329
- const allowed = useConsent('measurement');
330
-
331
- return (
332
- <button
333
- type="button"
334
- onClick={() => {
335
- if (allowed) window.posthog?.capture('signup_started');
336
- }}
337
- >
338
- Start signup
339
- </button>
340
- );
313
+ | Switch | `false` sets | What PostHog skips |
314
+ | -------------- | -------------------------------------------- | --------------------------------------------------------------------------- |
315
+ | `surveys` | `disable_surveys: true` | `surveys.js`, about 29 KB |
316
+ | `heatmaps` | `capture_heatmaps: false` | Heatmap capture. With `deadClicks: false` too, `dead-clicks-autocapture.js` |
317
+ | `deadClicks` | `capture_dead_clicks: false` | `dead-clicks-autocapture.js`, about 8 KB, once heatmaps are off too |
318
+ | `webVitals` | `capture_performance: { web_vitals: false }` | `web-vitals-with-attribution.js`, about 6 KB |
319
+ | `featureFlags` | `advanced_disable_feature_flags: true` | `/flags` requests. The remote config still loads |
320
+
321
+ Sizes are brotli-compressed, measured from posthog-js 1.436.1.
322
+
323
+ An unset switch adds nothing to `posthog.init`. For heatmaps, dead clicks, web
324
+ vitals and feature flags, PostHog then follows the setting in your PostHog
325
+ project. `true` sets the opposite value and overrides the project. For
326
+ `surveys` and `featureFlags`, `true` is PostHog's own default, so it behaves
327
+ the same as unset.
328
+
329
+ Surveys work differently. PostHog downloads `surveys.js` whenever the remote
330
+ config includes a `surveys` value, even when surveys are off in the project.
331
+ `surveys: false` is the only way to skip it.
332
+
333
+ `initOptions` wins over a switch that sets the same key. A
334
+ `capture_performance` value in `initOptions` replaces the whole object that
335
+ `webVitals` builds.
336
+
337
+ ### Avoid PostHog's option traps
338
+
339
+ These rules also apply when you pass PostHog options yourself, in
340
+ `initOptions` or in your own `posthog.init`:
341
+
342
+ * Use `advanced_disable_feature_flags: true` to stop `/flags`, not
343
+ `advanced_disable_flags: true`. The second also stops PostHog loading the
344
+ remote config, so session replay never starts and other features fall back to
345
+ local config.
346
+ * With feature flags off, surveys that target a feature flag never show.
347
+ PostHog logs a warning about it. If you need those surveys, leave
348
+ `featureFlags` unset and pass
349
+ `advanced_only_evaluate_survey_feature_flags: true` instead. PostHog still
350
+ requests `/flags`, but evaluates only survey flags.
351
+ * While heatmaps are on, in `posthog.init` or in the project, PostHog loads
352
+ `dead-clicks-autocapture.js` whatever `capture_dead_clicks` says. Turn off
353
+ both to skip it.
354
+ * `capture_performance: false` turns off web vitals and session replay network
355
+ timing. `{ web_vitals: false }`, which `webVitals: false` sets, leaves network
356
+ timing to the project. `capture_performance: true` forces both on.
357
+
358
+ Product tours (`product-tours.js`, about 36 KB) and exception autocapture
359
+ (`exception-autocapture.js`, about 6 KB) load only when the project turns them
360
+ on. To keep them off whatever the project says, pass
361
+ `disable_product_tours: true` or `capture_exceptions: false` in `initOptions`.
362
+
363
+ ## Guard your own capture calls
364
+
365
+ Events your code sends need their own permission check. The `posthog` global
366
+ exists before the SDK loads, so its presence does not mean measurement is
367
+ allowed:
368
+
369
+ ```ts title="src/track-signup.ts"
370
+ export function trackSignupStarted(measurementAllowed: boolean) {
371
+ if (!measurementAllowed) return;
372
+ window.posthog?.capture('signup_started');
341
373
  }
342
374
  ```
343
375
 
344
- This is an event-call example, not a signup implementation. Next.js client
345
- components can import `useConsent` from `c15t/next`.
376
+ Pass the current measurement permission from your framework, for example
377
+ `useConsent('measurement')` in React.
346
378
 
347
379
  ## Use an existing PostHog SDK
348
380
 
349
- If your app already initializes `posthog-js`, keep that SDK owner and attach a
350
- callback-only script instead of the loading helper. Initialize your SDK with
351
- `opt_out_capturing_by_default: true` and `cookieless_mode: 'never'` before
352
- mounting c15t when denied permission must stop capture.
381
+ If your app already initializes `posthog-js`, keep that setup and register a
382
+ callback-only script instead of the helper. Initialize the SDK with
383
+ `opt_out_capturing_by_default: true` and `cookieless_mode: 'never'` so it
384
+ captures nothing before c15t reports a permission.
353
385
 
354
386
  ```ts title="src/posthog-consent.ts"
355
387
  import type { Script, ScriptCallbackInfo } from 'c15t/modules/script-loader';
356
388
 
357
389
  type PostHogConsentApi = {
358
- opt_in_capturing: () => unknown;
359
- opt_out_capturing: () => unknown;
390
+ opt_in_capturing: () => unknown;
391
+ opt_out_capturing: () => unknown;
360
392
  };
361
393
 
362
394
  export function posthogConsent(instance: PostHogConsentApi): Script {
363
- const sync = ({ hasConsent }: ScriptCallbackInfo) => {
364
- if (hasConsent) instance.opt_in_capturing();
365
- else instance.opt_out_capturing();
366
- };
367
-
368
- return {
369
- id: 'posthog-sdk-consent',
370
- category: 'measurement',
371
- callbackOnly: true,
372
- alwaysLoad: true,
373
- onBeforeLoad: sync,
374
- onConsentChange: sync,
375
- };
395
+ const sync = ({ hasConsent }: ScriptCallbackInfo) => {
396
+ if (hasConsent) instance.opt_in_capturing();
397
+ else instance.opt_out_capturing();
398
+ };
399
+
400
+ return {
401
+ id: 'posthog-sdk-consent',
402
+ category: 'measurement',
403
+ callbackOnly: true,
404
+ alwaysLoad: true,
405
+ onBeforeLoad: sync,
406
+ onConsentChange: sync,
407
+ };
376
408
  }
377
409
  ```
378
410
 
379
- Pass `posthogConsent(posthog)` in the existing provider's `scripts` array, using
380
- your initialized SDK instance. The callback-only entry synchronizes initial
381
- and changed effective permissions without loading a second SDK. It does not
382
- block the SDK import or its initial request. `loadMode: 'disabled'` on the
383
- loading helper is not a substitute, because it performs no synchronization.
384
-
385
- Keep c15t as the source of truth for the banner and saved choices. Effective
386
- permission can come from policy defaults; a synchronization callback is not
387
- proof that the visitor explicitly accepted. Do not reuse v2
388
- `getOrCreateConsentRuntime` or `onBannerFetched` examples with v3.
389
-
390
- ## Verify the integration
391
-
392
- With the example above, a fresh opt-in session should make no PostHog SDK
393
- request until measurement is allowed. Grant, capture one test event, revoke,
394
- and confirm later application calls stop. Repeat with persisted consent and
395
- client navigation. If you choose cookieless capture, verify that behavior
396
- explicitly in the project rather than expecting silence after denial. See
397
- [consent verification](../guides/verify-consent.md).
411
+ Add `posthogConsent(posthog)` to the `scripts` you register, passing your
412
+ initialized SDK instance. `callbackOnly` means c15t inserts no script element.
413
+ `alwaysLoad` makes `onBeforeLoad` run on the first page load even while
414
+ measurement is denied, so the SDK is told to opt out. `onConsentChange` runs on
415
+ every later change. This does not delay the SDK import or its first request.
416
+ `loadMode: 'disabled'` is not a substitute, because it syncs nothing.
417
+
418
+ `features` belongs to the helper, so it does nothing here. To skip modules you
419
+ do not use, pass the PostHog options from
420
+ [turn off features you do not use](#turn-off-features-you-do-not-use) to your
421
+ own `posthog.init`, for example `disable_surveys: true`.
422
+
423
+ ## Measure opt-in rate
424
+
425
+ If you run a banner experiment, the backend already counts visitors and
426
+ choices per arm. To see the arm in PostHog as well, forward the `onSurfaceShown` and
427
+ `onChoiceRecorded` callbacks, which carry `experiment: { id, arm }`. See
428
+ [banner experiments](../guides/banner-experiments.md#send-the-events-to-your-own-analytics-too).
429
+
430
+ ## Verify PostHog
431
+
432
+ These checks assume `loadMode: 'after-consent'` from the example. After you
433
+ allow measurement, `array.js` loads and capture requests to your API host
434
+ follow. Trigger one guarded event and check that it is sent.
435
+
436
+ With `loadMode: 'always'`, `array.js` loads before a choice instead. Check that
437
+ no capture request is sent while measurement is denied, unless you chose
438
+ cookieless capture.
439
+
440
+ If you turned features off, allow measurement and filter the DevTools Network
441
+ panel by `posthog`. Reload the page. You should see `array.js`, the remote
442
+ config and capture requests, but no `/flags` request with `featureFlags: false`
443
+ and none of the modules you turned off, such as `surveys.js` or
444
+ `dead-clicks-autocapture.js`.
445
+
446
+ Test in a private window with an opt-in policy. Open DevTools Network, disable
447
+ the cache and filter by the vendor's domain:
448
+
449
+ 1. Load the page. No request goes to the vendor before you choose.
450
+ 2. Click Reject, then reload. There is still no vendor request.
451
+ 3. Open Privacy settings and allow the helper's category. The vendor script
452
+ loads without a page reload.
453
+ 4. Turn the category off again and save. c15t reloads the page, and the new
454
+ page makes no vendor request.
455
+
456
+ c15t reloads on revocation because removing a script element does not stop
457
+ code that already ran. The vendor's listeners, timers and queued events stay
458
+ alive until the page unloads. If you set `reloadOnConsentRevoked: false`, stop
459
+ the vendor yourself. Register a callback-only script whose `onConsentChange`
460
+ calls the vendor's opt-out API, as shown in
461
+ [custom integrations](./building-integrations.md), and check the
462
+ permission before each of your own event calls. The reload does not delete
463
+ cookies the vendor already set; see
464
+ [clear on revocation for your framework](./overview.md#vendor-switches-and-cookie-cleanup).
465
+
466
+ The helper sets `vendor` to its script ID, so once you declare that vendor a
467
+ visitor can turn it off inside an allowed category. See
468
+ [vendor consent for your framework](./overview.md#vendor-switches-and-cookie-cleanup). The
469
+ [consent verification guide](../guides/verify-consent.md) covers navigation,
470
+ expiry and hosting checks.