code16 / cookie-consent-js
Cookie consent handled front-only
Installs: 12
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Language:Blade
Requires
- php: >=8.0
- illuminate/support: ^8.0
- illuminate/view: ^8.0
README
Setup
composer require code16/cookie-consent-js
Required: publish assets (add this in composer.json post-autoload-dump
scripts)
php artisan vendor:publish --provider='Code16\CookieConsent\CookieConsentServiceProvider' --tag=assets --force
You may publish the config file:
php artisan vendor:publish --provider="Code16\CookieConsent\CookieConsentServiceProvider" --tag=config
And the lang file:
php artisan vendor:publish --provider="Code16\CookieConsent\CookieConsentServiceProvider" --tag=lang
Usage
In your blade layout
<head> {{-- ... --}} <x-cokie-consent::styles /> <x-cookies-allowed category="analytics"> <script> {{-- some injected cookies --}} </script> </x-cookies-allowed> </head> <body> {{-- end of the body --}} <x-cookie-consent::scripts /> </body>
Also you must declare the cookie category in config/cookie-consent.php
as follow
[ 'cookie_categories' => [ 'system' => [ 'required' => true, 'cookies' => [] ], 'analytics' => [ 'cookies' => [ ['name' => '_ga', 'lifetime' => '2 years'], ], ], ] ];
Categories marked as required
are cannot be opt-out by the user.
To provide explanation texts in the manage dialog, add content to the lang file:
[ 'manage_modal' => [ 'title' => 'Manage cookies', 'description' => 'About cookies...', 'categories' => [ 'system' => [ 'title' => 'System cookies', 'description' => "Description text about system cookies", ], 'analytics' => [ 'title' => 'Analytics cookies', 'description' => "Description text about analytics cookies", ], ], ] ];
Show the manage modal from a link (e.g. cookies page)
In the page:
<a href="#" onclick="return cookieconsent.showSettings()">Open manage cookies modal</a>