Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spatie/laravel-cookie-consent
Make your Laravel app comply with the crazy EU cookie law
https://github.com/spatie/laravel-cookie-consent
cookie eu javascript laravel php
Last synced: 4 days ago
JSON representation
Make your Laravel app comply with the crazy EU cookie law
- Host: GitHub
- URL: https://github.com/spatie/laravel-cookie-consent
- Owner: spatie
- License: mit
- Created: 2016-06-27T12:42:31.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-12-24T00:11:11.000Z (18 days ago)
- Last Synced: 2024-12-31T04:05:30.269Z (11 days ago)
- Topics: cookie, eu, javascript, laravel, php
- Language: PHP
- Homepage: https://freek.dev/503-make-your-laravel-app-comply-with-the-crazy-eu-cookie-law
- Size: 184 KB
- Stars: 1,412
- Watchers: 26
- Forks: 142
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- awesome-laravel-framework - Laravel Cookie Consent - Make your Laravel app comply with the crazy EU cookie law (Popular Packages)
- laravel-awesome - Laravel Cookie Consent - Make your Laravel app comply with the crazy EU cookie law (Popular Packages)
- awesome-laravel - Laravel Cookie Consent - Make your Laravel app comply with the crazy EU cookie law (Popular Packages)
README
# Simple, customizable cookie consent message for Laravel
[](https://packagist.org/packages/spatie/laravel-cookie-consent)
[](LICENSE.md)
[](https://github.com/spatie/laravel-cookie-consent/actions/workflows/run-tests.yml)
[](https://packagist.org/packages/spatie/laravel-cookie-consent)
This package adds a simple, customizable cookie consent message to your site. When the site loads, the banner appears and lets users consent to cookies. Once consent is given, the banner hides and stays hidden.
**What this package does not:**
- Include an option to 'Decline' all cookies, which might be required.
- Block trackers and cookies before consent. You need to handle this yourself.
- Include options for different consent categories like "Necessary" or "Marketing".
For more advanced cookie consent options in Laravel, consider these alternatives.
- [whitecube/laravel-cookie-consent](https://github.com/whitecube/laravel-cookie-consent)
- [statikbe/laravel-cookie-consent](https://github.com/statikbe/laravel-cookie-consent)
If you need an implementation of cookie consent for [Filament](https://github.com/filamentphp/filament) you can evaluate this plugin:
- [marcogermani87/filament-cookie-consent](https://github.com/marcogermani87/filament-cookie-consent)
## Support us
[
](https://spatie.be/github-ad-click/laravel-cookie-consent)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Installation
You can install the package via composer:
``` bash
composer require spatie/laravel-cookie-consent
```
The package will automatically register itself.
Optionally you can publish the config-file:
```bash
php artisan vendor:publish --provider="Spatie\CookieConsent\CookieConsentServiceProvider" --tag="cookie-consent-config"
```
This is the contents of the published config-file:
```php
return [
/*
* Use this setting to enable the cookie consent dialog.
*/
'enabled' => env('COOKIE_CONSENT_ENABLED', true),
/*
* The name of the cookie in which we store if the user
* has agreed to accept the conditions.
*/
'cookie_name' => 'laravel_cookie_consent',
/*
* Set the cookie duration in days. Default is 365 * 20.
*/
'cookie_lifetime' => 365 * 20,
];
```
The cookie domain is set by the 'domain' key in config/session.php, make sure you add a value in your .env for SESSION_DOMAIN. If you are using a domain with a port in the url such as 'localhost:3000', this package will not work until you do so.
## Usage
To display the dialog all you have to do is include this view in your template:
```blade
//in your blade template
@include('cookie-consent::index')
```
This will render the following dialog that, when styled, will look very much like this one.
The default styling provided by this package uses TailwindCSS v2 to provide a floating banner at the bottom of the page.
When the user clicks "Allow cookies" a `laravel_cookie_consent` cookie will be set and the dialog will be removed from the DOM. On the next request, Laravel will notice that the `laravel_cookie_consent` has been set and will not display the dialog again
## Customising the dialog texts
If you want to modify the text shown in the dialog you can publish the lang-files with this command:
```bash
php artisan vendor:publish --provider="Spatie\CookieConsent\CookieConsentServiceProvider" --tag="cookie-consent-translations"
```
This will publish this file to `resources/lang/vendor/cookie-consent/en/texts.php`.
```php
return [
'message' => 'Please be informed that this site uses cookies.',
'agree' => 'Allow cookies',
];
```
If you want to translate the values to, for example, French, just copy that file over to `resources/lang/vendor/cookie-consent/fr/texts.php` and fill in the French translations.
### Customising the dialog contents
If you need full control over the contents of the dialog. You can publish the views of the package:
```bash
php artisan vendor:publish --provider="Spatie\CookieConsent\CookieConsentServiceProvider" --tag="cookie-consent-views"
```
This will copy the `index` and `dialogContents` view files over to `resources/views/vendor/cookie-consent`. You probably only want to modify the `dialogContents` view. If you need to modify the JavaScript code of this package you can do so in the `index` view file.
## Using the middleware
Instead of including `cookie-consent::index` in your view you could opt to add the `Spatie\CookieConsent\CookieConsentMiddleware` to your kernel:
In Laravel 11 open /bootstrap/app.php and register them there:
```php
->withMiddleware(function (Middleware $middleware) {
$middleware->append(\Spatie\CookieConsent\CookieConsentMiddleware::class);
})
```
In Laravel 9 and 10 you can add them in app/Http/Kernel.php:
```php
// app/Http/Kernel.php
class Kernel extends HttpKernel
{
protected $middleware = [
// ...
\Spatie\CookieConsent\CookieConsentMiddleware::class,
];
// ...
}
```
This will automatically add `cookie-consent::index` to the content of your response right before the closing body tag.
## Notice
We are not lawyers and can't provide legal advice. Consult legal professionals what rules apply to your project.
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Testing
``` bash
composer test
```
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
## Security
If you discover any security-related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Freek Van der Herten](https://github.com/freekmurze)
- [Willem Van Bockstal](https://github.com/willemvb)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.