|
| 1 | +# tarteaucitron.js — Open-source cookie consent manager |
1 | 2 |
|
2 | | -[](https://www.jsdelivr.com/package/npm/tarteaucitronjs) |
3 | | -[](https://www.npmjs.com/package/tarteaucitronjs) [](https://github.com/AmauriC/tarteaucitron.js/graphs/contributors) [](https://github.com/sponsors/AmauriC) |
| 3 | +[](https://www.jsdelivr.com/package/npm/tarteaucitronjs) |
| 4 | +[](https://www.npmjs.com/package/tarteaucitronjs) |
| 5 | +[](https://github.com/AmauriC/tarteaucitron.js/graphs/contributors) |
| 6 | +[](https://github.com/sponsors/AmauriC) |
4 | 7 |
|
| 8 | +**Add a cookie consent banner to your website and let visitors control third-party services.** |
5 | 9 |
|
6 | | -👋 Hey, I'm Amauri, a french dev that build a GDPR friendly cookie manager. |
| 10 | +tarteaucitron.js is a free, open-source JavaScript consent manager created and maintained by [Amauri Champeaux](https://amauri.io/en/), an independent developer based in France. |
7 | 11 |
|
8 | | -tarteaucitron was initially a simple script for my personal blog (in 2013), a few months later, the Github repository is opened and tarteaucitron is now reliable and recognized. |
| 12 | +It provides the consent interface and service controls for your consent management platform (CMP) setup, helping you implement GDPR / RGPD consent requirements on your website. |
9 | 13 |
|
10 | | -The european cookie law regulates the management of cookies and you should ask your visitors their consent before exposing them to third party services. |
| 14 | +Use it to manage consent for analytics, advertising, embedded videos, social widgets and other supported third-party services. |
11 | 15 |
|
12 | | -Clearly this script will: |
13 | | -- Disable all services by default, |
14 | | -- Display a banner on the first page view and a small one on other pages, |
15 | | -- Display a panel to allow or deny each services one by one, |
16 | | -- Store the consent in a cookie for 365 days. |
| 16 | +[Installation guide](https://tarteaucitron.io/en/free-installation-open-source/) · [Website and Pro service](https://tarteaucitron.io/) · [Support the project](https://github.com/sponsors/AmauriC) |
17 | 17 |
|
18 | | -Bonus: |
19 | | -- Load service when user click on Allow (without reload of the page), |
20 | | -- Incorporate a fallback system (display a link instead of social button and a static banner instead of advertising). |
| 18 | +## Features |
21 | 19 |
|
| 20 | +- **Cookie consent banner:** offer visitors clear choices to accept, reject or customize their consent. |
| 21 | +- **Service-level preferences:** let visitors manage individual services from a dedicated panel. |
| 22 | +- **Consent-based loading:** keep configured services requiring consent blocked until permission is granted, with explicit consent enabled. |
| 23 | +- **Content placeholders:** display a fallback for supported embedded content while consent is pending or refused. |
| 24 | +- **Loading without a page refresh:** load supported services when visitors accept them. |
| 25 | +- **Customizable interface:** configure the banner layout, texts, colors and consent options. |
| 26 | +- **Accessibility options:** adjust the panel's position in the document and provide a way to reopen consent preferences. |
| 27 | +- **Consent Mode integrations:** support Google Consent Mode v2, Bing Consent Mode and Piano Analytics Consent Mode. |
22 | 28 |
|
| 29 | +## Open source or Pro? |
| 30 | + |
| 31 | +### tarteaucitron.js — manual integration |
| 32 | + |
| 33 | +Use this library to host and configure your consent manager yourself. |
| 34 | + |
| 35 | +Initialize tarteaucitron.js, add the services used on your website and adapt their integration so that tarteaucitron can manage their loading. |
| 36 | + |
| 37 | +**Initializing the banner alone does not automatically block scripts already loaded elsewhere on your website.** |
| 38 | + |
| 39 | +[Follow the open-source installation guide](https://tarteaucitron.io/en/free-installation-open-source/). |
| 40 | + |
| 41 | +### tarteaucitron.io Pro — managed service |
| 42 | + |
| 43 | +Choose the Pro service for automatic detection of supported services, an online configuration dashboard and consent statistics. |
| 44 | + |
| 45 | +The open-source library remains free. The Pro service is a separate paid offering. |
| 46 | + |
| 47 | +[Explore tarteaucitron.io Pro](https://tarteaucitron.io/). |
| 48 | + |
| 49 | +## Consent and configuration |
| 50 | + |
| 51 | +Your website's behavior depends on the services you integrate and the options you enable, including Consent Mode settings. |
| 52 | + |
| 53 | +Test your implementation before consent, after acceptance and after rejection. Check for third-party scripts loaded independently by your website, plugins or tag manager. |
| 54 | + |
| 55 | +tarteaucitron.js provides consent management tools; using it does not, by itself, guarantee that your entire website complies with the GDPR. |
| 56 | + |
| 57 | +## Maintainer and community |
| 58 | + |
| 59 | +Originally created for a personal blog, tarteaucitron.js is maintained by Amauri Champeaux with contributions from the community. |
| 60 | + |
| 61 | +Bug reports, integration improvements, translations and documentation contributions are welcome. |
| 62 | + |
| 63 | +[Meet the developer](https://amauri.io/en/amauri-champeaux/) · [Contributors](https://github.com/AmauriC/tarteaucitron.js/graphs/contributors) · [Sponsor development](https://github.com/sponsors/AmauriC) |
23 | 64 |
|
24 | 65 | # How to use |
25 | 66 |
|
|
0 commit comments