@c15t/react
v3.1.0
Published
React cookie consent banner, consent dialog and preference center, plus headless hooks. A GDPR consent management platform (CMP) with Google Consent Mode v2 and IAB TCF.
Keywords
Readme
@c15t/react: React cookie banner and cookie consent components
React cookie banner, consent dialog, and preference center for React 18 and 19. Each visitor's consent policy decides whether optional cookies wait for an opt-in, as EU cookie rules require, or load until the visitor opts out. Use headless hooks when you want your own design.
c15t is used by 2,100+ sites, including expo.dev, zed.dev, unkey.dev, mintlify.com, and sazabi.com.
Key Features
- Works with React 18 and 19, including React Server Components through 'use client' entry points
- Prebuilt cookie banner, consent dialog, and preference center with a theme system
- Headless hooks and compound components for a fully custom design
- Analytics, ads, and pixels follow each visitor's choice through @c15t/integrations: Google Tag Manager, Google Consent Mode v2, GA4, Meta Pixel, PostHog, and more
- IAB TCF 2.4 banner, dialog, and hooks through the @c15t/react/iab subpath
- Translations for 35 languages through @c15t/translations
Prerequisites
- React 18 or 19
- Node.js 20.19 or later
- An Inth project (free sign-up), a self-hosted backend, or offline mode for local development
Installation
pnpm add @c15t/reactThen add the prebuilt stylesheet to your app-level CSS entry point:
/* src/index.css */
@import "@c15t/react/styles.css";If you use the prebuilt IAB TCF UI, also import @c15t/react/iab/styles.css. It is published separately so apps without IAB do not ship those styles.
Using several c15t packages? Install c15t and import c15t/react instead. It is the same code.
Usage
- Wrap your app in
ConsentProviderwith the backend URL from your Inth project - Render
ConsentBanner,ConsentDialogandConsentDialogLinkinside the provider, and mount it once for the life of the app
// src/consent.tsx
import {
ConsentBanner,
ConsentDialog,
ConsentDialogLink,
ConsentProvider,
hosted,
} from '@c15t/react'
import type { ReactNode } from 'react'
const mode = hosted({ backendURL: 'https://your-project.inth.app' })
export const Consent = ({ children }: { children: ReactNode }) => (
<ConsentProvider options={{ mode }}>
{children}
<ConsentBanner />
<ConsentDialog />
<ConsentDialogLink>Privacy settings</ConsentDialogLink>
</ConsentProvider>
)- For the full setup, see the React quickstart
Hosting
c15t needs somewhere to keep policies and consent records. Pick one:
- Hosted on Inth: Inth runs the backend for you. You get policy storage, consent records, audit history, and a dashboard, with no database or server to run. Sign-up is free.
- Self-hosted: Run
@c15t/backendon your own server with PostgreSQL, MySQL, or SQLite. You own migrations, backups, and uptime. See the self-hosting guide. - Offline: Choices stay in the browser, with no consent records. Use it for local development, previews, and demos, not production.
The frontend code is the same for Inth and a self-hosted backend. Only the backend URL changes.
Documentation
See the documentation for guides, API reference, and examples.
Docs for AI Agents
This package ships its documentation as Markdown, matched to the installed version. After you install it, point your coding agent at node_modules/@c15t/react/AGENTS.md. It indexes every guide in node_modules/@c15t/react/docs/.
On the web, every page of the c15t docs has a Markdown version, and llms.txt lists them all. Install the c15t agent skills with npx skills add c15t/skills.
Support
- Join our Discord community
- Open an issue on our GitHub repository
- Visit inth.com and use the chat widget
- Contact our support team via email [email protected]
Contributing
- Read the contribution guidelines before you open a pull request
- Follow the code of conduct
Security
Do not open a public issue for a security vulnerability. Report it privately through GitHub's vulnerability reporting. We examine every valid report.
- Do not share the vulnerability in public forums, issues, or pull requests
- Give the steps to reproduce it and the versions it affects
- Give us time to release a fix before you disclose it
License
Built by Inth
