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

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.

package/docs/frameworks/react/translations.md

@@ -0,0 +1,155 @@
+---
+title: Translations
+description: Where c15t banner and dialog copy comes from in a React app, how
+  the browser picks the visitor's language, and how to override copy and switch
+  languages with the provider's i18n option and hooks.
+group: frameworks
+---
+
+## Where the copy comes from
+
+The banner, dialog, widget and gate placeholder read their text from one set
+of translations for the visitor's language. Which set depends on the
+provider's `mode`:
+
+| Mode        | Copy comes from                                                                                                                                                                                       |
+| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `hosted()`  | The backend's `/init` response for the visitor's language, from the translations in your Inth project or your self-hosted backend's configuration, with your `i18n` messages for that language on top |
+| `offline()` | Your `i18n` messages, merged over bundled English                                                                                                                                                     |
+
+With a backend, edit wording in your Inth project first, so it changes without
+a deploy. Code can override that copy in two places:
+
+* `i18n` in the `ConsentProvider` options changes a message everywhere it
+  appears.
+* Text props on `ConsentBanner` change one banner.
+
+[Copy and translations](../../customization/translations.md) lists the message
+keys and explains how code messages combine with the project's copy.
+
+## How c15t picks the language
+
+In `hosted()` mode the browser's `/init` request carries its own
+`Accept-Language` header, and the backend answers with copy in that language.
+When your project has no copy for it, the backend returns its fallback
+language. Set `overrides.language` in the provider options to request a
+specific language instead.
+
+In `offline()` mode, `i18n.locale` picks the language, `en` by default. The
+browser's language is not read.
+
+The banner, dialog and widget set `dir` from the active language. Right-to-left
+languages such as Arabic and Hebrew render with `dir="rtl"`, and a floating
+banner you did not position yourself moves to the opposite side.
+
+## Change the copy in code
+
+Keep the messages in their own module:
+
+```ts title="src/consent-i18n.ts"
+import type { ConsentProviderOptions } from 'c15t/react';
+
+// Keys you leave out keep the copy from your Inth project.
+export const i18n = {
+	messages: {
+		de: {
+			common: { rejectAll: 'Optionale ablehnen' },
+			cookieBanner: { title: 'Cookies auf dieser Website' },
+		},
+		en: {
+			common: { rejectAll: 'Reject optional' },
+			cookieBanner: { title: 'Cookies on this site' },
+		},
+	},
+} satisfies ConsentProviderOptions['i18n'];
+```
+
+Pass them to the provider in the file that renders it, such as
+`src/consent.tsx` from the [quickstart](./quickstart.md):
+
+```tsx title="src/consent.tsx"
+<ConsentProvider options={{ mode, scripts, i18n }}>
+```
+
+For the visitor's language, your messages replace the backend's copy key by
+key. Keys you leave out keep the project's wording, and messages for other
+languages are not applied. In `offline()` mode c15t bundles only English, so
+keys you leave out for another language show in English.
+
+The provider reads `i18n` once, when it mounts. In development it logs a
+warning if `i18n` changes later. Define the object at module level, as above,
+rather than inside a component.
+
+## Change one banner's copy
+
+`ConsentBanner` takes `title`, `description`, `acceptButtonText`,
+`rejectButtonText`, `customizeButtonText` and `dismissButtonText`. The props
+replace the text in every language, so pass values in the page's language:
+
+```tsx
+<ConsentBanner
+	title="Cookies on this site"
+	rejectButtonText="Reject optional"
+/>;
+```
+
+## Switch the language at runtime
+
+`useSetLanguage()` stores the new language, and `useInit()` resolves the policy
+again, which fetches the copy for that language. Call both from your language
+switcher:
+
+```tsx title="src/language-switcher.tsx"
+import { useInit, useSetLanguage, useSnapshot } from 'c15t/react';
+
+const languages = [
+	{ code: 'en', label: 'English' },
+	{ code: 'de', label: 'Deutsch' },
+];
+
+export const LanguageSwitcher = () => {
+	const setLanguage = useSetLanguage();
+	const init = useInit();
+	const language = useSnapshot().translations?.language ?? 'en';
+
+	return (
+		<select
+			aria-label="Consent language"
+			value={language}
+			onChange={(event) => {
+				setLanguage(event.target.value);
+				// Setting the language alone keeps the current copy. Init fetches
+				// the policy and copy for the new language.
+				void init();
+			}}
+		>
+			{languages.map(({ code, label }) => (
+				<option key={code} value={code}>
+					{label}
+				</option>
+			))}
+		</select>
+	);
+};
+```
+
+Setting the language without calling `init()` changes nothing on screen. Your
+`i18n` messages for the new language apply on top of the copy that arrives.
+Render the switcher anywhere inside `ConsentProvider`.
+
+Switching needs a backend. In `offline()` mode the copy stays in the
+`i18n.locale` language.
+
+If your site changes language through its own i18n library, you can instead
+pass its locale as `overrides.language` in the provider options. When that
+value changes, the provider resolves the policy again in the new language.
+
+## Verify
+
+1. Set your browser language to one your project translates, clear site data
+   and reload under a policy that shows a banner. DevTools Network shows the
+   `/init` request with that `Accept-Language` header, and the banner uses
+   that language.
+2. Check that a message you set in `i18n` shows in the banner.
+3. Switch the language with your switcher. A new `/init` request runs, and the
+   banner and dialog text change without a reload.

package/docs/frameworks/react/troubleshooting.md

@@ -1,67 +1,112 @@
 ---
-title: Troubleshoot React consent
-description: Diagnose policy resolution, early scripts, storage and rendering problems.
+title: Troubleshooting
+description: Fix a missing banner, early vendor requests, unstyled components
+  and theme warnings in a React app that uses c15t/react.
 group: frameworks
 ---
 
-## Why is there no banner?
+## The /init request goes to your-project.inth.app
 
-Inspect `resolution` and `promptRequirement` before changing styles. Pending or
-failed initialization, no matching rule, a valid stored choice and a rule that
-requires no prompt can all produce no banner for different reasons. A missing
-stylesheet can also make rendered controls appear incorrectly.
+**Check.** In DevTools Network, the `GET` request to `/init` goes to
+`your-project.inth.app` and fails.
 
-Check the backend URL and Network response, then confirm the active policy for
-the visitor's location. Do not solve missing UI by granting every category or
-setting `enabled: false`: disabling the runtime permits optional loading.
+**Fix.** Replace the placeholder URL in `hosted({ url })` in `src/consent.tsx`
+with the backend URL from your Inth project, exactly as Inth shows it, then
+rebuild.
 
-## Why does the UI disappear with a content blocker?
+## There is no banner
 
-Check the browser Network panel for `ERR_BLOCKED_BY_CLIENT` or a failed dynamic
-import. Older c15t builds used component filenames such as
-`consent-dialog-*.js`, which some cookie-annoyance lists block. Update the c15t
-packages and rebuild the app. Current component modules use neutral filenames;
-public component imports stay the same. This also covers Vite development
-requests used by TanStack Start and other Vite integrations.
+**Check.** In DevTools Network, find the `GET` request to `/init` on your
+backend URL.
 
-Extensions can separately hide elements with cosmetic filters or block a
-configured backend URL. Check the failed request or hidden element to distinguish
-those cases from a missing component module.
+| What you see                    | Cause                                                                                  | Fix                                                                                                           |
+| ------------------------------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
+| No `/init` request              | `ConsentProvider` is not mounted, or an error stopped `src/consent.tsx` from rendering | Check the console for errors and render one provider at the app root, as in the [quickstart](./quickstart.md) |
+| `/init` fails with a CORS error | Your site's origin is not trusted                                                      | Add the exact origin, including port in development, to the trusted origins in your Inth project              |
+| `/init` returns 200             | The policy for this visitor asks for no banner, or a stored choice is still valid      | Inspect the active policy with the component below, or clear site data                                        |
 
-## Why does analytics run before a choice?
+A policy with `prompt: 'none'` shows no banner by design, and so does a
+returning visitor with a valid stored choice. [Policies](../../concepts/policies.md)
+explains why a region may not show one.
 
-Check effective permission under the selected policy, then find every loader
-for that vendor. Remove unconditional script tags, framework analytics plugins
-and duplicate tag-manager entries. c15t's script registration only controls the
-scripts registered with it.
+## Inspect the active policy
 
-Google helpers intentionally load with Consent Mode defaults. A Google request
-is not by itself proof that its storage consent was granted. If your requirement
-is no request at all, do not use an always-loaded helper unchanged.
+Render this component inside `ConsentProvider`. It reads state and records no
+choice:
 
-## Why does a choice disappear on reload?
+```tsx title="src/consent-policy-debug.tsx"
+import { useSnapshot } from 'c15t/react';
 
-Check whether persistence is disabled, browser storage is blocked, the origin
-changed, or the receipt expired or no longer matches the current policy.
-A development example with `persistence: false` deliberately resets on reload.
-Do not "repair" persistence by saving permissions automatically on mount.
+export function ConsentPolicyDebug() {
+	const snapshot = useSnapshot();
+	const resolution = snapshot.resolution;
 
-## Why does hydration differ from server HTML?
+	return (
+		<pre>
+			{JSON.stringify(
+				{
+					status: resolution.status,
+					policy: resolution.status === 'matched' ? resolution.policy.id : null,
+					prompt: snapshot.promptRequirement,
+					permissions: snapshot.effectivePermissions,
+					location: snapshot.location,
+					privacySignals: snapshot.privacySignals,
+				},
+				null,
+				2
+			)}
+		</pre>
+	);
+}
+```
 
-Use the adapter's request helper and pass the returned configuration unchanged
-to its boundary. Check that server and browser use the same backend and policy
-inputs. A module-level mutable runtime on a server can share one visitor's state
-with another request; create request-owned state instead.
+The component re-renders on every consent change. Remove it after you finish.
+For a feature gate, use `useConsent('marketing')` or the category you need.
 
-## Why does static hosting fail when development works?
+## A vendor loads before the visitor chooses
 
-A static host has no app server for init routes, proxies or server functions.
-Use absolute external consent URLs or an explicitly local policy. Test the
-production output with a static file server, not the framework dev server.
+**Check.** Search `index.html`, your entry module and any tag manager for the
+vendor's script or SDK initializer.
 
-## Why does customization do nothing?
+**Fix.** Remove every loader except the one in `options.scripts`. c15t only
+gates scripts registered with it, and the network blocker cannot stop code that
+runs before the provider renders. [Scripts and embeds](./scripts.md)
+covers the options.
 
-Check the imported stylesheet, the correct token or slot, and which element
-carries the state attribute. `data-variant` on a banner root is not a matching
-attribute on its child card. Check cascade layers and the Tailwind version
-before adding specificity. See [customization](../../customization/overview.md).
+## The banner has no styles
+
+**Check.** In DevTools Elements, the banner has classes but no rules apply.
+
+**Fix.** Import `c15t/react/styles.css` once in the module that renders the
+provider. With Tailwind 3, keep that import above the `@tailwind` directives
+and add `c15t/postcss-tailwind3` before `tailwindcss` in your PostCSS
+config. Without the plugin, Tailwind 3 drops c15t's rules or fails the build
+with `` `@layer components` is used but no matching `@tailwind components` directive is present ``.
+See [Tailwind CSS](../../customization/tailwind.md#set-up-tailwind-css-3).
+
+## The console warns that theme tokens are no longer turned into CSS
+
+**Check.** `options.theme` holds colors, radius or other tokens, and the page
+has no `c15t-theme` style element. The provider only reads `consentActions`
+and slot styles from `theme`.
+
+**Fix.** Move the tokens to your CSS or render `ConsentTheme`, as shown in
+[customize](./customize.md#change-colors-fonts-and-radius).
+
+## The banner is missing from server-rendered HTML
+
+**Check.** Your app uses React Router framework mode, Remix or another
+server-rendered setup without a c15t adapter. There this is expected: the
+browser resolves consent after hydration.
+
+**Fix.** None is needed for consent to work.
+[Rendering](./rendering.md#react-router-remix-and-other-server-rendered-apps)
+explains the options.
+
+## More help
+
+[Troubleshoot consent](../../guides/troubleshooting.md) covers problems shared by
+every framework, such as a missing banner, analytics that load before a choice,
+imports that fail because npm installed c15t v2, choices that disappear on
+reload, server HTML that differs from the browser, static builds that fail and
+content blockers that hide the consent UI.