spatie/laravel-cookie-consent

Make your Laravel app comply with the crazy EU cookie law

Simple, customizable cookie consent message for Laravel

, _(*1)

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., _(*2)

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"., _(*3)

For more advanced cookie consent options in Laravel, consider these alternatives., _(*4)

• whitecube/laravel-cookie-consent
• statikbe/laravel-cookie-consent

Support us

, _(*5)

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products., _(*6)

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. We publish all received postcards on our virtual postcard wall., _(*7)

Installation

You can install the package via composer:, _(*8)

``` bash composer require spatie/laravel-cookie-consent, <sub>(*9)</sub>

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:, <sub>(*10)</sub>

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., <sub>(*11)</sub>

Usage

To display the dialog all you have to do is include this view in your template:, <sub>(*12)</sub>

//in your blade template
@include('cookie-consent::index')

This will render the following dialog that, when styled, will look very much like this one., <sub>(*13)</sub>

, <sub>(*14)</sub>

The default styling provided by this package uses TailwindCSS v2 to provide a floating banner at the bottom of the page., <sub>(*15)</sub>

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, <sub>(*16)</sub>

Customising the dialog texts

If you want to modify the text shown in the dialog you can publish the lang-files with this command:, <sub>(*17)</sub>

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., <sub>(*18)</sub>

```php, <sub>(*19)</sub>

return [ 'message' => 'Please be informed that this site uses cookies.', 'agree' => 'Allow cookies', ]; ```, <sub>(*20)</sub>

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., <sub>(*21)</sub>

Customising the dialog contents

If you need full control over the contents of the dialog. You can publish the views of the package:, <sub>(*22)</sub>

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., <sub>(*23)</sub>

Using the middleware

Instead of including cookie-consent::index in your view you could opt to add the Spatie\CookieConsent\CookieConsentMiddleware to your kernel:, <sub>(*24)</sub>

// 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., <sub>(*25)</sub>

Notice

We are not lawyers and can't provide legal advice. Consult legal professionals what rules apply to your project., <sub>(*26)</sub>

Changelog

Please see CHANGELOG for more information what has changed recently., <sub>(*27)</sub>

Testing

bash composer test, <sub>(*28)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*29)</sub>

Security

If you discover any security-related issues, please email freek@spatie.be instead of using the issue tracker., <sub>(*30)</sub>

Credits

• Freek Van der Herten
• Willem Van Bockstal
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*31)</sub>