hivedrops/hive-consent

This package has been designed to help you generate an RGPD (General Data Protection Regulation) compliant cookie banner. Using this package, you can easily integrate a cookie banner on your website, ensuring legal compliance with regard to the collection and management of users' personal data.

Maintainers

Details

github.com/hivedrops-re/hive-consent

Source

Issues

Installs: 25

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 0

Open Issues: 0

Language:Blade

1.2.1 2024-07-23 11:14 UTC

Requires

MIT 872049d6c020248d8929529ec16e97c0b8d25d7e

  • HIVEDROPS <contact.woop@hivedrops.re>

This package is auto-updated.

Last update: 2025-04-11 10:56:18 UTC

README

Hive Consent Banner

The Hive Consent package lets you add a cookie consent banner to your Laravel applications. The package is simple to use and easy to customize.

Features

  • Cookie consent banner
  • Customizable views
  • Customizable configuration
  • Customizable analytics tools (by default: Google Analytics)
  • Light and dark mode
  • Multi-language support (English and French)
  • Easy to use

How to upgrade

To upgrade to the latest version, just one command !

composer update hivedrops/hive-consent

Installation

Prerequisites

  • PHP >= 7.2
  • TAILWIND CSS >= 2.0

Step 1: Install the package via Composer

You can install the package via composer:

composer require hivedrops/hive-consent

Step 2: Use the package

You can use the package in your views by adding the following code:

    <head>
        @include('hive-consent::hive-consent-script')
    </head>
    <body>
        @include('hive-consent::hive-consent-banner')
        {{-- Your code here --}}
    </body>

Optional: Publish the views assets

If you want to customize the views, you can publish the views:

php artisan hive-consent:publish-views

A hive-consent directory will be created in your resources/views/vendor directory.

Optional: Publish the config file

You can edit url for privacy policy and cookie policy with a variable in the env file:

HIVE_CONSENT_URL="/cookie-policy" // You can change this to your own url
HIVE_CONSENT_LANGUAGE="en" // You can change this for "fr" if you want to use the french version
HIVE_CONSENT_GOOGLE_ANALYTICS="G-XXXXXXXXXX" // You can change this to your own Google Analytics ID

if you want to change the default configuration, you can publish the config file:

php artisan hive-consent:publish-config

Optional: Publish the languages assets

If you want to customize the languages, you can publish the languages:

php artisan hive-consent:publish-lang

A hive-consent directory will be created in your resources/lang/vendor directory.

Usage after installation

This package will enable you to generate cookies in your browser, so you'll need to adapt your codes to take account of the different user choices.

Here are the cookies that will be created automatically in the session:

  • cookies_accepted: This cookie will be created when the user accepts the cookies.
  • necessary_cookies: This cookie will be created when the user accepts the necessary cookies.
  • analytics_cookies: This cookie will be created when the user accepts the analytics cookies.
    • If user accepts the analytics cookies, the Google Analytics script will be added to the page. Make sure to add your Google Analytics ID in the .env file.
  • advertising_cookies: This cookie will be created when the user accepts the advertising cookies.

if you want to check if the user has accepted the cookies, you can use the following code:

    @if(request()->cookie('cookies_accepted') == true)
        {{-- Your code here --}}
    @endif

License

Hive Consent is open-sourced package licensed under the MIT License.

Credits