@c15t/react 3.0.0-alpha.3 → 3.0.0-alpha.4

package/docs/frameworks/react/quickstart.md

@@ -1,143 +1,181 @@
 ---
 title: Quickstart
-description: Connect a React application to Inth and add consent UI, persistence
-  and a preferences link.
+description: Add a consent banner, preferences dialog and consent-gated scripts
+  to a React single-page app built with Vite, using Inth as the consent backend.
 group: frameworks
 ---
 
-## Connect Inth
+## Before you start
 
-[Create an Inth project](https://inth.com), configure policy rules and the app's
-allowed origin, and copy its backend endpoint. This guide uses a client-rendered
-React app with Vite. Applications with a framework server should use that
-framework's adapter for request prefetch.
+This guide sets up a client-rendered React app built with Vite. The browser
+loads the page, asks the consent backend for the visitor's policy, then shows
+the banner or runs the scripts the visitor allowed.
 
-| Package manager | Command                          |
-| :-------------- | :------------------------------- |
-| npm             | `npm install c15t @c15t/scripts` |
-| pnpm            | `pnpm add c15t @c15t/scripts`    |
-| yarn            | `yarn add c15t @c15t/scripts`    |
-| bun             | `bun add c15t @c15t/scripts`     |
+* **Next.js or TanStack Start?** Use that framework's guide from the
+  [framework list](https://c15t.com/docs/frameworks). Their adapters resolve consent on the
+  server.
+* **React Router framework mode, Remix or another server-rendered React app?**
+  This guide still works. The server renders the page without consent state and
+  the browser resolves it after hydration. Read
+  [rendering](./rendering.md#react-router-remix-and-other-server-rendered-apps)
+  for what that means for the first paint.
 
-Set `VITE_C15T_BACKEND_URL` to the endpoint from Inth. Vite embeds public values
-at build time, so rebuild when changing it. Keep management credentials out of
-public variables.
+You need an [Inth](https://inth.com) project. In the project, set the policy
+rules for your regions, add your site's origin to the trusted origins, and copy
+the backend URL.
+[Choose your setup](../../concepts/choose-your-setup.md#decide-who-runs-the-consent-backend)
+covers self-hosting and offline mode.
 
-## Register consent-gated scripts
+## Install c15t
 
-Include measurement and marketing categories in your policy for these vendors.
-Remove any existing loaders for them so each script loads once.
+| Package manager | Command                                           |
+| :-------------- | :------------------------------------------------ |
+| npm             | `npm install c15t@alpha @c15t/integrations@alpha` |
+| pnpm            | `pnpm add c15t@alpha @c15t/integrations@alpha`    |
+| yarn            | `yarn add c15t@alpha @c15t/integrations@alpha`    |
+| bun             | `bun add c15t@alpha @c15t/integrations@alpha`     |
 
-This setup uses Vite's public environment variables. Set the Inth endpoint and
-add your PostHog project key, PostHog API host and X Pixel ID in `.env.local`:
+`c15t` contains the React adapter at `c15t/react`. `@c15t/integrations` holds the
+vendor loaders used below.
 
-```dotenv title=".env.local"
-VITE_C15T_BACKEND_URL=
-VITE_POSTHOG_KEY=
-VITE_POSTHOG_HOST=
-VITE_X_PIXEL_ID=
-```
-
-Copy the exact backend endpoint from Inth. The vendor IDs are optional: leaving
-an ID empty disables that integration. When enabling PostHog, fill in both its project key and the API host
-shown in your PostHog project. Restart Vite after editing these values and
-rebuild for deployment. Other bundlers need their own configuration mechanism.
+## Register your vendor scripts
 
-Create `src/scripts.ts`. PostHog waits for measurement permission with
-`loadMode: 'after-consent'` and disables cookieless capture with
-`cookieless_mode: 'never'`. X Pixel waits for marketing permission.
+Create `src/scripts.ts`. PostHog waits for measurement permission and X Pixel
+waits for marketing permission, so your policy must include both categories.
+Remove any other PostHog or X Pixel loader from your app so each vendor loads
+once.
 
 ```ts title="src/scripts.ts"
-import { posthog } from '@c15t/scripts/posthog';
-import { xPixel } from '@c15t/scripts/x-pixel';
-
-const posthogKey = import.meta.env.VITE_POSTHOG_KEY;
-const xPixelId = import.meta.env.VITE_X_PIXEL_ID;
+import { posthog } from '@c15t/integrations/posthog';
+import { xPixel } from '@c15t/integrations/x-pixel';
 
 export const scripts = [
-	...(posthogKey
-		? [
-				posthog({
-					apiHost: import.meta.env.VITE_POSTHOG_HOST,
-					id: posthogKey,
-					initOptions: { cookieless_mode: 'never' },
-					loadMode: 'after-consent',
-				}),
-			]
-		: []),
-	...(xPixelId ? [xPixel({ pixelId: xPixelId })] : []),
+	posthog({
+		id: 'phc_your_project_key',
+		initOptions: { cookieless_mode: 'never' },
+		loadMode: 'after-consent',
+	}),
+	xPixel({ pixelId: 'your-pixel-id' }),
 ];
 ```
 
-## Mount the provider and UI
+Replace `phc_your_project_key` with your PostHog project key and
+`your-pixel-id` with your X Pixel ID. PostHog uses its EU host; add
+`region: 'us'` for a US project. Remove the loader for a vendor you don't use.
+
+`loadMode: 'after-consent'` keeps the PostHog SDK off the page until the
+visitor allows measurement. `cookieless_mode: 'never'` turns off PostHog's
+cookieless capture. See [integrations](../../integrations/overview.md) for other
+vendors.
+
+## Mount the provider
+
+Create `src/consent.tsx`. `ConsentProvider` creates the consent runtime and
+loads the scripts. `ConsentBanner` and `ConsentDialog` render when the policy
+asks for them, and `ConsentDialogLink` keeps preferences reachable after the
+banner closes.
 
 ```tsx title="src/consent.tsx"
-import type { ReactNode } from 'react';
 import {
-  ConsentBanner,
-  ConsentDialog,
-  ConsentDialogLink,
-  ConsentProvider,
-  hosted,
+	ConsentBanner,
+	ConsentDialog,
+	ConsentDialogLink,
+	ConsentProvider,
+	hosted,
 } from 'c15t/react';
-import 'c15t/react/styles.css';
+import type { ReactNode } from 'react';
+
 import { scripts } from './scripts';
 
-const backendURL = import.meta.env.VITE_C15T_BACKEND_URL;
-if (!backendURL) throw new Error('Set VITE_C15T_BACKEND_URL');
-const mode = hosted({ url: backendURL });
-
-export function Consent({ children }: { children: ReactNode }) {
-  return (
-    <ConsentProvider options={{ mode, scripts }}>
-      {children}
-      <ConsentBanner />
-      <ConsentDialog />
-      <footer><ConsentDialogLink>Privacy settings</ConsentDialogLink></footer>
-    </ConsentProvider>
-  );
-}
+import 'c15t/react/styles.css';
+
+const mode = hosted({ url: 'https://your-project.inth.app' });
+
+export const Consent = ({ children }: { children: ReactNode }) => (
+	<ConsentProvider options={{ mode, scripts }}>
+		{children}
+		<ConsentBanner />
+		<ConsentDialog />
+		<footer>
+			<ConsentDialogLink>Privacy settings</ConsentDialogLink>
+		</footer>
+	</ConsentProvider>
+);
 ```
 
+Replace `https://your-project.inth.app` with your project's backend URL,
+exactly as Inth shows it, including any path prefix.
+
+Wrap your app with it in `src/main.tsx`:
+
 ```tsx title="src/main.tsx"
 import { createRoot } from 'react-dom/client';
-import App from './App';
+
+import { App } from './app';
 import { Consent } from './consent';
 
 const root = document.getElementById('root');
-if (!root) throw new Error('Missing #root element');
-createRoot(root).render(<Consent><App /></Consent>);
+if (!root) {
+	throw new Error('Missing #root element');
+}
+createRoot(root).render(
+	<Consent>
+		<App />
+	</Consent>
+);
 ```
 
-Keep `Consent` mounted across navigation. The banner appears when the resolved
-policy requires a prompt; not every region or returning visitor needs one.
-The dialog link keeps preferences reachable after the prompt closes.
+Keep `Consent` mounted for the life of the app. If you use a client-side
+router, render the router inside `Consent` so navigation does not remount the
+provider. The stylesheet import in `src/consent.tsx` styles the banner and
+dialog; import it once.
+
+## Gate your own features
 
-## Gate optional functionality
+Read a category's permission with `useConsent` inside the provider:
 
-```tsx
+```tsx title="src/marketing-banner.tsx"
 import { useConsent } from 'c15t/react';
 
-export function MarketingContent() {
-  return useConsent('marketing') ? <div>Optional marketing content</div> : null;
+export function MarketingBanner() {
+	return useConsent('marketing') ? <aside>Spring sale</aside> : null;
 }
 ```
 
-This controls the rendered component. Move vendor SDKs into the
-[script loader](./script-loader.md) too. An independently
-loaded analytics script does not wait merely because a consent provider exists.
-
-`useConsent` returns effective permission, not proof of an explicit grant.
-Read [consent state](../../guides/consent-state.md) when recording choice events.
-
-## Verify and customize
-
-Reject under an opt-in policy, reload and confirm optional requests stay blocked.
-Reopen preferences, save a different choice and test navigation. Follow
-[verification](../../guides/verify-consent.md), then
-[customization](../../customization/overview.md) to apply your design.
-
-## Run the complete example
-
-Try the [runnable example](https://c15t.com/docs/examples) with PostHog, X Pixel, a consent-gated
-YouTube video and a persistent preferences control. Use it to test rejection, permission changes and reloads.
+`useConsent` returns the permission right now. Under an opt-out policy it can be
+`true` before the visitor has chosen anything. Read
+[how consent works](../../concepts/how-consent-works.md#a-permission-is-not-a-recorded-choice)
+before you record or report choices. For iframes, use
+[`ConsentGate`](./components/consent-gate.md).
+
+## Check that it works
+
+Build and preview the production bundle with `vite build` and `vite preview`,
+then open the site in a private window with DevTools open on the Network tab.
+Test under a policy that asks for a choice, such as an EU opt-in policy.
+
+1. **Before a choice.** The banner shows. There are no requests to
+   `posthog.com` or `static.ads-twitter.com`.
+2. **Reject All.** The banner closes and the vendor requests stay absent.
+3. **Reload.** The banner stays closed and the vendor requests stay absent.
+4. **Privacy settings.** The footer link opens the dialog with **Analytics** (the
+   `measurement` category) and **Marketing** off. Turn on **Analytics** and save. PostHog's `array.js` loads and
+   X Pixel stays absent.
+5. **Turn Analytics off again.** The page reloads and PostHog does not load.
+
+If the banner never appears, check the Network tab for the request to
+`/init` on your backend URL. [Troubleshooting](./troubleshooting.md)
+covers the common causes. [Verify consent](../../guides/verify-consent.md) has the
+full release checklist.
+
+## Next steps
+
+* [Rendering](./rendering.md) for server-rendered React apps and
+  what the first paint contains.
+* [Scripts and embeds](./scripts.md) for more vendors, network
+  blocking and data cleanup.
+* [Customize](./customize.md) for colors, fonts, layout and copy.
+* [Components](./components/consent-provider.md) for
+  every provider option and component prop.
+* The runnable app in `examples/react` of the
+  [c15t repository](https://github.com/c15t/c15t) contains this setup.

package/docs/frameworks/react/rendering.md

@@ -0,0 +1,128 @@
+---
+title: Rendering and deployment
+description: How c15t resolves consent in client-rendered React apps, React
+  Router framework mode, Remix and other server-rendered React apps without a
+  c15t adapter.
+group: frameworks
+---
+
+## Pick your rendering path
+
+`c15t/react` resolves consent in the browser. That works for every React app,
+including server-rendered ones. What changes is what the first HTML contains.
+
+| Your app                                                                 | Where consent resolves          | Setup                                                                                                         |
+| ------------------------------------------------------------------------ | ------------------------------- | ------------------------------------------------------------------------------------------------------------- |
+| Vite, or another client-rendered single-page app                         | Browser, after the bundle loads | [Quickstart](./quickstart.md)                                                                                 |
+| Prerendered or static HTML                                               | Browser, after the page loads   | [Quickstart](./quickstart.md), see [static pages](#static-and-prerendered-pages)                              |
+| React Router framework mode, Remix, or another server-rendered React app | Browser, after hydration        | [Quickstart](./quickstart.md), see [server-rendered apps](#react-router-remix-and-other-server-rendered-apps) |
+| Next.js or TanStack Start                                                | Server, per request             | That framework's guide in the [framework list](https://c15t.com/docs/frameworks)                              |
+
+Pick the Next.js or TanStack Start adapter if you use those frameworks. They
+read the visitor's cookie and location on the server, so the banner can be in
+the first HTML. [Choose your setup](../../concepts/choose-your-setup.md#server-rendering-or-browser-rendering)
+explains the difference in general terms.
+
+## Client-rendered apps
+
+The [quickstart](./quickstart.md) setup runs entirely in the
+browser:
+
+1. The page loads with no consent state. Every optional category is denied.
+2. `ConsentProvider` requests `GET /init` from your backend URL. The backend
+   picks the visitor's policy from their location.
+3. The provider applies the policy and any stored choice. It shows the banner
+   if the policy asks for one, and loads the scripts the visitor allowed.
+
+Until step 3 finishes, gated scripts and `ConsentGate` embeds stay blocked. If
+the backend request fails, they stay blocked and no banner shows.
+
+## React Router, Remix and other server-rendered apps
+
+React Router framework mode, Remix and similar frameworks have no c15t adapter.
+Use the quickstart's `Consent` component and render it in your root component,
+around the outlet. In React Router framework mode that is `app/root.tsx`.
+
+`ConsentProvider` renders on the server without touching browser APIs, and the
+browser takes over after hydration:
+
+* The server HTML contains your page but no banner and no consent state.
+* After hydration the browser requests `/init`, then shows the banner if the
+  policy asks for one.
+* The server render and the first browser render agree, so hydration does not
+  warn or change a stored choice.
+
+One detail differs from the Vite setup: import `c15t/react/styles.css` where
+your framework loads global CSS, so the server HTML links it.
+
+### Skip the browser's first init request
+
+This is optional. `fetchSSRData` from `c15t/react/server` calls the backend's
+`/init` from your server loader, forwarding the visitor's location and
+language headers. Pass the result to the browser, wrap it in a promise and give
+it to `hosted({ url, initialData })`. The provider's first init then uses that
+response instead of a network request.
+
+Know its limits before you add it:
+
+* It saves the browser's round trip to the backend. It does not put the banner
+  in the server HTML; the banner still mounts after hydration.
+* Every page view makes a server-to-server `/init` request. Do not cache the
+  loader response, because it contains one visitor's policy.
+* It returns `undefined` when the request has no location or language headers,
+  and the browser then requests `/init` as usual.
+* `mode` is read once, when the provider mounts. Create the `hosted()` mode once
+  in the browser rather than on every render.
+* A relative `backendURL` resolves against the request's `host` header, over
+  `https` for a domain name and over `http` for `localhost`, an IP address or
+  a single-label host. `fetchSSRData` ignores `x-forwarded-host`,
+  `x-forwarded-proto` and `forwarded`, and does not send them to the backend.
+  Behind a proxy that overwrites those headers, pass
+  `trustForwardedHeaders: true` to use them.
+* If your server answers requests for any `Host` header, such as a Node server
+  exposed directly or a proxy that forwards `Host` from its default virtual
+  host, pass `fetchSSRData` an absolute `backendURL`. A relative one resolves
+  against whatever `Host` the request sent.
+
+### Render the banner in the server HTML
+
+c15t has no framework-neutral helper for this. `ConsentProvider` accepts a
+server-resolved `prefetch` state, but the Next.js and TanStack Start adapters
+build that state from the request's cookie, headers and a cached policy
+manifest. Building it by hand ties your app to internal shapes. If the banner
+must be part of the first paint, use one of those adapters. Otherwise keep the
+browser path.
+
+## Static and prerendered pages
+
+A prerendered page is the same HTML for every visitor, so it cannot contain one
+visitor's consent. Use the quickstart setup unchanged. The browser talks to the
+backend URL directly, so the static host needs no server route. Add the site's
+origin to the trusted origins in your Inth project.
+
+Do not cache a response that contains a visitor's consent in a CDN or a shared
+page cache. [Data fetching](../../concepts/data-fetching.md) covers what is safe to
+cache.
+
+## Where the browser sends requests
+
+With `hosted({ url })`, the browser calls two backend endpoints:
+
+| Request               | When                                       |
+| --------------------- | ------------------------------------------ |
+| `GET {url}/init`      | Once per page load, to resolve the policy  |
+| `POST {url}/subjects` | When the visitor accepts, rejects or saves |
+
+Both go to the backend's origin, so it must list your site as a trusted origin.
+[Data fetching](../../concepts/data-fetching.md) compares this with proxies and
+custom transports.
+
+## Check the rendering path
+
+1. Open the page in a private window and view the page source. In a
+   server-rendered app the HTML contains your content and no element with
+   `data-testid="consent-banner-root"`.
+2. In DevTools Network, filter by your backend URL. One `/init` request runs
+   after the JavaScript loads, or none if you pass `initialData`.
+3. The banner appears once that request finishes. Vendor requests stay absent
+   until you allow their category.

package/docs/frameworks/react/scripts.md

@@ -0,0 +1,115 @@
+---
+title: Scripts
+description: Load vendor scripts by consent category in a React app with
+  ConsentProvider, and clear stored data or reload the page when a visitor
+  withdraws consent.
+group: frameworks
+---
+
+## Register vendor scripts
+
+Pass vendor loaders to `ConsentProvider` through `options.scripts`. The
+provider loads each script when its category is allowed and removes it when
+the category is denied. The [quickstart](./quickstart.md)
+registers PostHog and X Pixel this way:
+
+```ts title="src/scripts.ts"
+import { posthog } from '@c15t/integrations/posthog';
+import { xPixel } from '@c15t/integrations/x-pixel';
+
+export const scripts = [
+	posthog({
+		id: 'phc_your_project_key',
+		initOptions: { cookieless_mode: 'never' },
+		loadMode: 'after-consent',
+	}),
+	xPixel({ pixelId: 'your-pixel-id' }),
+];
+```
+
+The provider in `src/consent.tsx` receives them:
+
+```tsx title="src/consent.tsx"
+import {
+	ConsentBanner,
+	ConsentDialog,
+	ConsentDialogLink,
+	ConsentProvider,
+	hosted,
+} from 'c15t/react';
+import type { ReactNode } from 'react';
+
+import { scripts } from './scripts';
+
+import 'c15t/react/styles.css';
+
+const mode = hosted({ url: 'https://your-project.inth.app' });
+
+export const Consent = ({ children }: { children: ReactNode }) => (
+	<ConsentProvider options={{ mode, scripts }}>
+		{children}
+		<ConsentBanner />
+		<ConsentDialog />
+		<footer>
+			<ConsentDialogLink>Privacy settings</ConsentDialogLink>
+		</footer>
+	</ConsentProvider>
+);
+```
+
+Each helper from `@c15t/integrations` sets its own category and a stable `id`.
+Remove every other loader for the same vendor, such as a `<script>` tag in
+`index.html` or an SDK you initialize at module level, so the vendor loads
+once and only through c15t. [Integrations](../../integrations/overview.md) lists
+every helper, and [building integrations](../../integrations/building-integrations.md)
+covers a vendor without one.
+
+## What happens when consent changes
+
+* **Allowed.** The script loads, or its SDK is started, the first time its
+  category is allowed.
+* **Denied later.** The provider removes the script element. Code that already
+  ran keeps running, so after the visitor turns off a category they had
+  allowed, the provider reloads the page once the save finishes. Set
+  `reloadOnConsentRevoked: false` only if every gated vendor stops itself.
+* **`alwaysLoad` helpers.** Some integrations, such as Google Consent Mode,
+  load before consent and pass the visitor's choice to the vendor. Read the
+  vendor's guide; a category on a script does not always mean zero requests.
+
+## Embeds and other requests
+
+Scripts cover vendor code c15t loads for you. For the rest:
+
+* [Embeds](./embeds.md) keeps iframes out of the page with
+  `ConsentGate` or the iframe blocker.
+* [Network blocker](./network-blocker.md) holds `fetch` and
+  XHR calls that match a rule until their category is allowed.
+
+## Clear stored data after revocation
+
+Removing a script does not delete the cookies or storage entries it wrote. Add
+`clearOnRevocation` to the provider options to delete the entries you list for
+each category when it is denied. The option is read once, when the provider
+mounts. [Clear on revocation](./clear-on-revocation.md) covers
+configuration and browser limits.
+
+## Let visitors turn off one vendor
+
+A visitor can allow marketing and still switch off one vendor in it. Pass
+`vendors` to the provider options. Helpers from `@c15t/integrations` already carry
+their vendor slug. See [vendor consent](./vendor-consent.md).
+
+To send your own events only to allowed integrations, see
+[send events only to allowed integrations](../../integrations/overview.md#send-events-only-to-allowed-integrations).
+
+## Check the scripts
+
+Open DevTools Network in a private window, filter by each vendor's domain and
+reload.
+
+1. Before a choice under an opt-in policy, no vendor script loads.
+2. Allow one category. Only that category's vendors load.
+3. Turn the category off. The page reloads and the vendor stays absent.
+4. Reload again. The rejection holds.
+
+[Verify consent](../../guides/verify-consent.md) has the full checklist.