2023-04-11 14:55:04 +00:00
# Web Cookie Notice
2022-09-21 15:43:04 +02:00
< div style = "text-align: center;" >
2023-11-27 18:03:13 +01:00
<!-- Link for icons : https://github.com/Ileriayo/markdown - badges -->
2022-09-21 15:43:04 +02:00




2023-11-27 18:03:13 +01:00




2022-09-21 15:43:04 +02:00
< / div >
2023-04-11 14:55:04 +00:00
## Exemples :
2023-11-27 18:03:13 +01:00
Voir dans le dossier `examples` pour **Laravel** et **Wordpress** .
2022-09-21 15:43:04 +02:00
## Étape 1 : implémentation
2023-04-11 14:55:04 +00:00
### Ajouter le package avec npm
- https://lab.s-web.fr/ldc-web/projets/laravel-base-project/-/snippets/8
- `npm i @ldc-web/cookie-notice --save-dev`
2023-05-22 15:18:46 +02:00
[Lien doc Gitlab ](https://docs.gitlab.com/ee/user/packages/npm_registry/ )
2023-06-01 14:51:39 +02:00
## Browser
- Pour inclure directement dans le navigateur, les fichiers compilés sont dans `dist/browser` .
2023-04-11 14:55:04 +00:00
### Laravel
2022-09-21 15:43:04 +02:00
- Ajouter dans le projet, les fichiers au bon endroit :
2023-11-27 18:03:13 +01:00
- [`cn-cookies.blade.php` ](./examples/laravel/cn-cookies.blade.php ) dans le dossier `resources/view/vendor/`
- [`standard.blade.php` ](./examples/laravel/templates/standard.blade.php ) dans le dossier `resources/view/vendor/cookie-notice-templates`
- Inclure dans le layout général `@include('vendor.cn-cookies')` .
2023-05-22 15:18:46 +02:00
**Cela doit être avant le stack('scripts')**
- **!! Ne pas oublier de modifier les configurations dans le blade `vendor.cn-cookies` **.
2023-04-11 14:55:04 +00:00
- Ensuite inclure les éléments **style** et **script**
2023-05-22 15:18:46 +02:00
- **SCSS**
2023-04-11 14:55:04 +00:00
@import "~@ldc -web/cookie-notice";
// ou
@import "~@ldc -web/cookie-notice/dist/css/cookie-notice-standard.css";
// ou
@import "~@ldc -web/cookie-notice/src/scss/themes/standard";
- **TS/JS**
2023-05-22 15:18:46 +02:00
// Dans fo.ts
2023-06-02 10:05:50 +02:00
import type CookieNotice from "@ldc -web/cookie-notice";
window.CookieNotice = CookieNotice;
2023-04-11 14:55:04 +00:00
2023-05-22 15:18:46 +02:00
// Dans index.d.ts
...
2023-06-02 10:05:50 +02:00
import CookieNotice from "@ldc -web/cookie-notice";
2023-05-22 15:18:46 +02:00
declare global {
...
interface Window {
CookieNotice: typeof CookieNotice;
...
}
}
2023-04-11 14:55:04 +00:00
### Wordpress
2023-11-27 18:03:13 +01:00
- Ajouter dans le projet, les fichiers au bon endroit :
- [`cn-cookies.php` ](./examples/wordpress/cn-cookies.php ) dans le dossier `resources/view/vendor/`
- [`standard.php` ](./examples/wordpress/templates/standard.php ) dans le dossier `resources/view/vendor/cookie-notice-templates`
- Inclure dans le footer général `<?php include('resources/views/vendor/cn-cookies.php'); ?>` .
- **!! Ne pas oublier de modifier les configurations dans le fichier `resources/views/vendor/cn-cookies` **.
- Ensuite inclure les éléments **style** et **script**
- **SCSS**
@import '../../node_modules/@ldc -web/cookie-notice';
## OU ##
- **CSS**
inclure directement le fichier compilé `cookie-cn.css` présent dans `dist/browser` dans le fichier css du projet
- **JS**
ajouter directement le fichier compilé `cookie-cn.js` présent dans `dist/browser` dans le fichier js du projet
2023-04-11 14:55:04 +00:00
2022-09-21 15:43:04 +02:00
## Étape 2 : customisation
2023-04-11 14:55:04 +00:00
- Couleurs : Pour l'instant les variables **SASS** sont personalisables. Elle se trouvent ici [`node_modules/@ldc-web/cookie-notice/src/scss/variables.scss` ](./src/scss/variables.scss )
2022-09-21 15:43:04 +02:00
## Étape 3 : finalisation
2023-04-11 14:55:04 +00:00
- Ajouter un bouton `Gestion des cookies` dans le footer et lui attribuer la classe `cn-cookie-link` .
- Si des vidéos sont présentes, attribuer aux `<div>` la classe `cn-youtube` pour Youtube, et/ou `cn-vimeo` pour Viméo.