Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/novaway/tarte-a-la-praline
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".
https://github.com/novaway/tarte-a-la-praline
Last synced: about 5 hours ago
JSON representation
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".
- Host: GitHub
- URL: https://github.com/novaway/tarte-a-la-praline
- Owner: novaway
- License: mit
- Created: 2020-06-30T14:17:27.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2023-06-06T13:13:45.000Z (over 1 year ago)
- Last Synced: 2024-04-24T16:38:07.112Z (7 months ago)
- Language: TypeScript
- Homepage: https://novaway.github.io/tarte-a-la-praline
- Size: 8.88 MB
- Stars: 3
- Watchers: 5
- Forks: 6
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Tarte à la praline - User cookie management
_**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](https://eur-lex.europa.eu/LexUriServ/LexUriServ.do?uri=OJ:L:2009:337:0011:0036:en:PDF) also refered to as _"The cookie Law"_.
_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](https://github.com/AmauriC/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:
"
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."
},
hotjar: {
id: "hotjarId",
sv: "hotjarSv",
label: "Hotjar"
},
gtm: {
code: "gtmCode",
label: "Google tag manager"
}
},
})
```
[More examples with all features](https://novaway.github.io/tarte-a-la-praline/#/./examples/README).
## 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
- [x] Translations module
- [x] a11y
- [x] Adding possibility to customize default CSS
- [ ] Zero dependencies
- [x] Verify browser compatibility
- [ ] Tests
## Contributing
If you want to contribute to this project, please refer to our [Contributing Guidelines](CONTRIBUTING.md)
Made in 🦁 with 🌰 and sugar