/tarteaucitron.js

Example d'utilisation de la librairie Tarteaucitron.js et de l'ajout d'un service custom

Primary LanguageHTML

tarteaucitron.js

Utilisation de la librairie

  • Récupération de la librairie via GitHub : tarteaucitron.js
  • Ajout de la librairie dans le projet (ne pas la concaténer / uglifier)

Initialisation

<script type="text/javascript">
    tarteaucitron.init({
        "hashtag": "#tarteaucitron", /* Ouverture automatique du panel avec le hashtag */
        "highPrivacy": false, /* désactiver le consentement implicite (en naviguant) ? */
        "orientation": "bottom", /* le bandeau doit être en haut (top) ou en bas (bottom) ? */
        "adblocker": false, /* Afficher un message si un adblocker est détecté */
        "showAlertSmall": true, /* afficher le petit bandeau en bas à droite ? */
        "cookieslist": true, /* Afficher la liste des cookies installés ? */
        "removeCredit": false, /* supprimer le lien vers la source ? */
        "handleBrowserDNTRequest": false, /* Deny everything if DNT is on */
        //"cookieDomain": ".example.com" /* Nom de domaine sur lequel sera posé le cookie pour les sous-domaines */
    });
</script>

Ajout d'un service

  • Des services sont déjà disponibles de base avec la librairie, ils sont listés à cette adresse (étape 3) : tarteaucitron.js services

  • Après l'initialisation de la librairie, ajouter le job correspondant au service pour l'ajouter au site (pour certains services, ajouter un bout de code pour afficher le service à cet emplacement).

Création d'un service custom

  • Pour ajouter un service encore inexistant, il suffit de modifier le fichier tarteaucitron.service.js (voir l'exemple présent sur le repository).

  • Ajout du job correspondant à ce nouveau service.

  • (Optionnel) Ajout du bout de code permettant l'ajout du service à l'endroit souhaité.

Exemple

  • Partie tarteaucitron.service.js
    Chaque service possède une ligne "js": function () {..., le code contenu dans cette fonction est exécuté lorsque le job (voir index.html) est ajouté.
    Ainsi il est possible d'ajouter un fallback basé sur une classe spécifique (dans ce cas juicer) et d'exécuter une nouvelle fonction (ici retourner le social wall) lorsque cette classe est présente dans la page.

  • Partie index.html (optionnel)
    Il est possible d'ajouter un bout de code (à un endroit en particulier) possédant une classe utilisée par le fallback du service (dans ce cas juicer) et d'y passer des paramètres récupérables et utilisables par ce service (l'attribut data-user-id) dans la fonction.