Components

Component reference

c15t/react exports the provider, the consent UI and the hooks from one import path. Every component except ConsentProvider and ConsentTheme reads the runtime the provider creates, so render them inside ConsentProvider.

Mount one ConsentProvider at the root of the app and keep it mounted across client navigation. The provider reads mode and its module options once, when it mounts.

Start with the provider, banner and dialog

Most apps start with four components. ConsentProvider holds the runtime, ConsentBanner and ConsentDialog ask for a choice, and a ConsentDialogLink lets visitors reopen their preferences. The quickstart puts them in one file:

import { posthog } from '@c15t/integrations/posthog';
import {
	ConsentBanner,
	ConsentDialog,
	ConsentDialogLink,
	ConsentProvider,
	manifest,
} from 'c15t/react';
import type { ReactNode } from 'react';

const options = {
	// The policy the build downloaded from VITE_C15T_BACKEND_URL.
	mode: manifest(),
	scripts: [
		posthog({
			id: 'phc_your_project_key',
			initOptions: { cookieless_mode: 'never' },
			loadMode: 'after-consent',
		}),
	],
};

export const Consent = ({ children }: { children: ReactNode }) => (
	<ConsentProvider options={options}>
		{children}
		<ConsentBanner />
		<ConsentDialog />
		<footer>
			<ConsentDialogLink>Privacy settings</ConsentDialogLink>
		</footer>
	</ConsentProvider>
);

Add ConsentWidget, ConsentDialogTrigger or ConsentGate later, where a page needs them. Keep ConsentDialog mounted even when you add a widget, because the banner's Customize button and every dialog link open it.

Server-rendered React apps

React Router framework mode, Remix and other server-rendered React apps use the same components. ConsentProvider renders on the server without touching browser APIs, and the banner mounts after hydration, once the browser has resolved the policy. Rendering explains the trade-off.

IAB TCF components

Import IABProvider, IABConsentBanner and IABConsentDialog from c15t/react/iab, render them inside ConsentProvider next to ConsentBanner and ConsentDialog, and load c15t/react/styles.css and c15t/react/iab/styles.css with styles: false. The stock banner and dialog stay closed under an IAB policy. See IAB TCF.

Other entry points

Check the components

Load the app in a private window under a policy that asks for a choice:

1. The banner shows, and DevTools Network has no requests to your vendors' hosts.
2. Click the footer's ConsentDialogLink. The dialog opens with every optional category off.
3. Allow one category and save. Its vendor requests appear, and a ConsentGate for that category mounts its children.
4. Reload. The banner stays closed, and the link still reopens the dialog.