@novaway/tarte-a-la-praline

<a href="https://www.npmjs.com/package/@novaway/tarte-a-la-praline"><img src="https://img.shields.io/npm/v/@novaway/tarte-a-la-praline.svg" alt="npm Version"></a> <a href="https://npmcharts.com/compare/@novaway/tarte-a-la-praline?minimal=true"><img src="h

Usage no npm install needed!

<script type="module">
  import novawayTarteALaPraline from 'https://cdn.skypack.dev/@novaway/tarte-a-la-praline';
</script>

README

Tarte à la praline - User cookie management

npm Version npm Downloads

Tarte à la praline is a lightweight library that allow users to manage tracking cookies in a way that is compliant with the european Directive 2009/136/EC also refered to as "The cookie Law".

screenshot of the cookie banner with an alert box

Tarte à la praline is quite opinionated to ensure its lightness. If you are looking for a more complete implementation, we recommand you use tarteaucitron.js.

Features

  • Native configuration for Google Analytics and Hotjar
  • Ability to add custom configuration for other trackers
  • Color customisation (more advanced styling options to come)
  • HTML classes customisation
  • i18n management

🔷 Written in TypeScript

Install

Install the package using NPM or your favorite package manager :

npm i @novaway/tarte-a-la-praline

Then import the module in your application :

import '@novaway/tarte-a-la-praline/translations/en';
import initTALP from '@novaway/tarte-a-la-praline';

Basic Usage

Example

This module comes with EN, FR and DE translations that should be imported before the init function.

import '@novaway/tarte-a-la-praline/translations/en'; // en, fr or de
import initTALP from '@novaway/tarte-a-la-praline';

initTALP({
  defaultServices: {
      ga: {
        code: "gaCode",
        label: "google analitycs",
        description:
          "<div>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</div>"
      },
      hotjar: {
        code: "hotjarCode",
        label: "Hotjar"
      },
      gtm: {
        code: "gtmCode",
        label: "Google tag manager"
      }
    },
})

More examples with all features.

Browser compatibility

TALP work with evergreen browser.

Development

If you want to modify this library, you can run it with the following command.

npm start

You can also build it in a production compatible way.

npm run build-prod

Testing

TODO

TODO

  • Translations module
  • a11y
  • Adding possibility to customize default CSS
  • Zero dependencies
  • Verify browser compatibility
  • Tests

Contributing

If you want to contribute to this project, please refer to our Contributing Guidelines

Made in 🦁 with 🌰 and sugar