@c15t/svelte
v3.2.2
Published
Svelte cookie consent banner for Svelte and SvelteKit, with a consent dialog and preference center. The Svelte package for c15t.
Keywords
Readme
@c15t/svelte: Svelte and SvelteKit cookie banner and cookie consent components
Cookie banner, consent dialog, and preference center for Svelte 5 and SvelteKit. Configure location-based consent policies, such as GDPR opt-in for EU visitors. Use headless state 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 Svelte 5.20 and later, and SvelteKit 2 and 3
- On SvelteKit,
loadConsentresolves the policy on the server, so the banner is in the first HTML - Prebuilt cookie banner, consent dialog, and preference center with a theme system
- Headless state 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
- Translations for 53 languages through @c15t/translations
Prerequisites
- Svelte 5.20 or later, or SvelteKit 2 or 3
- Node.js 20.19 or later
- An Inth project (free sign-up). For development and tests, local mode needs no backend
Installation
pnpm add c15tInstall c15t and import the Svelte components from c15t/svelte.
To manually install, follow the quickstart.
Usage
- Add
consentManifest()fromc15t/svelte/vitetovite.config.ts. It downloads your policy fromVITE_C15T_BACKEND_URL(SvelteKit:PUBLIC_C15T_BACKEND_URL) - Wrap your app with
ConsentProviderinmanifest()mode - Add
ConsentBannerandConsentDialognear the root - In SvelteKit, render
ConsentRootwith the stateloadConsentfromc15t/svelte/kitreturns; see the SvelteKit quickstart - For the full setup, see the Svelte quickstart docs
<!-- src/App.svelte -->
<script lang="ts">
import {
ConsentBanner,
ConsentDialog,
ConsentDialogLink,
ConsentProvider,
manifest,
} from 'c15t/svelte';
</script>
<ConsentProvider mode={manifest()}>
<main>Your app goes here.</main>
<ConsentBanner />
<ConsentDialog />
<ConsentDialogLink>Privacy settings</ConsentDialogLink>
</ConsentProvider>Run c15t on Inth
c15t needs a backend to serve policies and keep consent records. Inth runs it for you. It stores every choice with its region and policy version, audits your live site and pull requests for privacy risk, and on Pro and above keeps each region's consent rules current with managed policy packs. You don't run the consent database, geo lookups, uptime, or upgrades.
Sign-up is free. Run npx @inth/cli c15t to create a project and set up c15t, or create one by hand and copy its backend URL.
For development and tests, local mode keeps choices in the browser and keeps no consent records. Don't ship it to production. Its factory is local(). The old name, offline(), still works and goes away in v4.
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/svelte/AGENTS.md. It indexes every guide in node_modules/@c15t/svelte/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
