From 007bda5e51bbe7d3a7f71a61485ebbe64239ae72 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Munsch?= Date: Mon, 22 May 2023 15:18:46 +0200 Subject: [PATCH] Update example + readme --- README.md | 24 ++++++++++++++++++--- examples/cn-cookies.blade.php | 40 ++++++++++++++++++----------------- 2 files changed, 42 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 695acc3..b314983 100644 --- a/README.md +++ b/README.md @@ -16,18 +16,21 @@ Ici pour l'instant seulement un exemple pour **Laravel**. ## Étape 1 : implémentation ### Ajouter le package avec npm -- https://docs.gitlab.com/ee/user/packages/npm_registry/ - https://lab.s-web.fr/ldc-web/projets/laravel-base-project/-/snippets/8 - `npm i @ldc-web/cookie-notice --save-dev` + [Lien doc Gitlab](https://docs.gitlab.com/ee/user/packages/npm_registry/) + ### Laravel - Ajouter dans le projet, les fichiers au bon endroit : - [`cn-cookies.blade.php`](./examples/cn-cookies.blade.php) dans le dossier `resources/view/vendor/` - [`standard.blade.php`](./examples/templates/standard.blade.php) dans le dossier `resources/view/vendor/cookie-notice-templates` -- Inclure dans le layout general `@include('vendor.cn-cookies')` +- Inclure dans le layout general `@include('vendor.cn-cookies')`. + **Cela doit être avant le stack('scripts')** +- **!! Ne pas oublier de modifier les configurations dans le blade `vendor.cn-cookies`**. - Ensuite inclure les éléments **style** et **script** - - SCSS + - **SCSS** @import "~@ldc-web/cookie-notice"; // ou @@ -36,10 +39,25 @@ Ici pour l'instant seulement un exemple pour **Laravel**. @import "~@ldc-web/cookie-notice/src/scss/themes/standard"; - **TS/JS** + // Dans fo.ts @import "@ldc-web/cookie-notice" import CookieNotice from "@ldc-web/cookie-notice"; window.WebCookieNotice = CookieNotice; + // Dans index.d.ts + ... + import type CookieNotice from "@ldc-web/cookie-notice"; + + declare global { + ... + + interface Window { + CookieNotice: typeof CookieNotice; + ... + } + } + + ### Wordpress **TODO: Add instructions for wordpress** diff --git a/examples/cn-cookies.blade.php b/examples/cn-cookies.blade.php index ee3a39c..567ad98 100644 --- a/examples/cn-cookies.blade.php +++ b/examples/cn-cookies.blade.php @@ -185,30 +185,32 @@ SCRIPT; {{-- INCLUDE TEMPLATE --}} -@include('vendor.cookie-notice-templates/standard', compact( +@include('vendor.cookie-notice-templates.standard', compact( 'site_name', 'logo_picture_url', 'logo_alt_text', 'confidentiality_page_url', 'strings' )) @push('scripts') @endpush