RGPD friendly cookie manager
Go to file
Amauri CHAMPEAUX 28cff26d20
Merge pull request #766 from jmfrouin/745
[Evol/#745] Service Marketo
2021-08-14 16:30:58 +02:00
.github Create codeql-analysis.yml 2021-03-30 09:32:51 +02:00
css Move the allowed/denied indicator near the cookie information 2021-05-09 14:40:41 +02:00
lang Update tarteaucitron.oc.js 2021-06-23 22:17:58 +02:00
.gitignore Update .gitignore 2020-05-21 14:33:54 +02:00
LICENSE Initial commit 2014-09-14 13:00:55 +02:00
README.md Update README.md 2021-06-22 17:10:48 +02:00
advertising.js New option: show a message if an adblocker is detected 2015-03-06 16:50:15 +01:00
package.json Update npm version 2021-06-22 17:09:10 +02:00
tarteaucitron.js Event loaded should be sent after js script is executed in order to be able to manipulate result of the script after loaded event is sent 2021-07-29 11:48:44 +02:00
tarteaucitron.services.js Merge pull request #766 from jmfrouin/745 2021-08-14 16:30:58 +02:00

README.md

npm GitHub contributors Sponsor

tarteaucitron.js

Comply to the european cookie law is simple with the french tarte au citron.

What is this script?

The european cookie law regulates the management of cookies and you should ask your visitors their consent before exposing them to third party services.

Clearly this script will:

  • Disable all services by default,
  • Display a banner on the first page view and a small one on other pages,
  • Display a panel to allow or deny each services one by one,
  • Activate services on the second page view if not denied,
  • Store the consent in a cookie for 365 days.

Bonus:

  • Load service when user click on Allow (without reload of the page),
  • Incorporate a fallback system (display a link instead of social button and a static banner instead of advertising).

Installation guide

Visit tarteaucitron.io

How to use

<script src="/tarteaucitron/tarteaucitron.js"></script>

<script>
tarteaucitron.init({
    "privacyUrl": "", /* Privacy policy url */

    "hashtag": "#tarteaucitron", /* Open the panel with this hashtag */
    "cookieName": "tarteaucitron", /* Cookie name */

    "orientation": "middle", /* Banner position (top - bottom - middle - popup) */

    "groupServices": false, /* Group services by category */

    "showAlertSmall": false, /* Show the small banner on bottom right */
    "cookieslist": false, /* Show the cookie list */
    
    "showIcon": true, /* Show cookie icon to manage cookies */
    // "iconSrc": "", /* Optionnal: URL or base64 encoded image */
    "iconPosition": "BottomRight", /* Position of the icon between BottomRight, BottomLeft, TopRight and TopLeft */

    "adblocker": false, /* Show a Warning if an adblocker is detected */

    "DenyAllCta" : true, /* Show the deny all button */
    "AcceptAllCta" : true, /* Show the accept all button when highPrivacy on */
    "highPrivacy": true, /* HIGHLY RECOMMANDED Disable auto consent */

    "handleBrowserDNTRequest": false, /* If Do Not Track == 1, disallow all */

    "removeCredit": false, /* Remove credit link */
    "moreInfoLink": true, /* Show more info link */
    "useExternalCss": false, /* If false, the tarteaucitron.css file will be loaded */

    //"cookieDomain": ".my-multisite-domaine.fr", /* Shared cookie for subdomain website */

    "readmoreLink": "", /* Change the default readmore link pointing to tarteaucitron.io */
    
    "mandatory": true /* Show a message about mandatory cookies */
});
</script>

Create custom service

tarteaucitron.services.mycustomservice = {
  "key": "mycustomservice",
  "type": "ads|analytic|api|comment|other|social|support|video",
  "name": "MyCustomService",
  "needConsent": true,
  "cookies": ['cookie', 'cookie2'],
  "readmoreLink": "/custom_read_more", // If you want to change readmore link
  "js": function () {
    "use strict";
    // When user allow cookie
  },
  "fallback": function () {
    "use strict";
    // when use deny cookie
  }
};

Thanks to the sponsors 😊

Be the first sponsor!