README

GDPR cookie-consent banner and content blocking for Laravel — server-rendered Blade on top of the framework-agnostic consent-control JavaScript runtime.

This is the Laravel layer of a three-package stack:

Package	Role
`consent-control` (npm)	Framework-agnostic runtime + CSS (plain HTML, WordPress, any framework).
`laravel-consent-control` (this package)	Blade components, config, drivers, translations, server helpers.
`filament-consent-control`	Optional Filament admin UI (settings form + RichEditor iframe plugin).

A single config file is all you need — no database, no admin panel required.

Features

Server-rendered banner (no flash, SEO-friendly) wired by the shared JS runtime
Configurable consent categories with declarative scripts / inline JS on consent
Iframe & custom-content blocking via <x-consent-control-message>
Conditional rendering via <x-consent-control-gate> (server-side + reactive)
config or eloquent driver — store settings in a file or on your own model
Multilingual (DE/EN, extensible) category labels resolved through __()
Server-side ConsentControl::granted('analytics') helper
Cookie format compatible with the consent-control npm package: consentcontrol=necessary|analytics

Requirements

PHP 8.2+
Laravel 11.28+ / 12

Installation

composer require mmoollllee/laravel-consent-control

Publish the config and the runtime assets:

php artisan vendor:publish --tag=consent-control-config
php artisan vendor:publish --tag=consent-control-assets

Optionally publish the translations to customise them:

php artisan vendor:publish --tag=consent-control-translations

Frontend usage

Render the banner and load the runtime (once per page, e.g. before </body>):

<x-consent-control-banner />
<x-consent-control-scripts />

<x-consent-control-scripts /> ships a standalone stylesheet by default. If you bundle the CSS yourself (see Assets) disable it with :standalone-css="false".

Block an iframe until consent

<x-consent-control-message
    consent="functional"
    src="https://www.youtube-nocookie.com/embed/dQw4w9WgXcQ"
    src-name="YouTube"
    :width="560"
    :height="315"
/>

Block custom content until consent

<x-consent-control-message consent="functional" type="custom" src-name="OpenStreetMap">
    <div id="map" style="height: 400px"></div>
</x-consent-control-message>

Conditional content

<x-consent-control-gate consent="analytics">
    <p>Only rendered/visible when analytics consent is granted.</p>
</x-consent-control-gate>

{{-- Or server-side only: --}}
@consent('analytics')
    <x-analytics-widget />
@endconsent

Re-open the banner

<button class="consent-control--open">Cookie settings</button>

Configuration

Everything lives in config/consent-control.php. Labels and descriptions may be plain strings or translation keys — both are resolved through __(), so the shipped defaults are multilingual out of the box.

Declare the scripts/JS to run when a category is granted:

'analytics' => [
    'label' => 'Analytics',
    'scripts' => [
        ['src' => 'https://www.googletagmanager.com/gtag/js?id=G-XXXX', 'async' => true],
    ],
    'inline_script' => "window.dataLayer = window.dataLayer || [];",
],

Consent versioning

Bump version whenever your categories or privacy policy change — visitors whose stored version differs are re-prompted (their consent is reset):

'version' => env('CONSENT_CONTROL_VERSION', 1), // set null to disable

Block your own scripts

Render inert scripts that activate only on consent:

<x-consent-control-script consent="analytics" src="https://www.googletagmanager.com/gtag/js?id=G-XXXX" />

<x-consent-control-script consent="analytics">
    window.dataLayer = window.dataLayer || [];
</x-consent-control-script>

Eloquent driver (opt-in)

Store settings as JSON on one of your own models instead of the config file:

CONSENT_CONTROL_DRIVER=eloquent

// config/consent-control.php
'eloquent' => [
    'model' => App\Models\Setting::class,
    'field' => 'consent_settings',
    'record_id' => 1,
],

// The model needs a JSON cast:
protected $casts = ['consent_settings' => 'array'];

Editing that JSON with a ready-made Filament form is what filament-consent-control adds.

Assets

Two ways to ship the runtime:

A) Vendored (default, no build step). vendor:publish --tag=consent-control-assets copies the prebuilt JS/CSS to public/vendor/consent-control. <x-consent-control-scripts /> references them.

B) Vite / your own bundler. Install the runtime and import it:

npm i consent-control

// resources/js/app.js
import 'consent-control';
import 'consent-control/dist/consentcontrol.main.css';

Then render <x-consent-control-scripts :standalone-css="false" /> (it still emits the ConsentControl.init(...) boot config; just skip the duplicate <script>/CSS by including only the inline boot — or call ConsentControl.init() yourself).

Components & directives

Component / directive	Description
`<x-consent-control-banner />` / `@consentBanner`	Consent banner
`<x-consent-control-message consent="…" src="…" />`	Iframe/content with consent overlay
`<x-consent-control-gate consent="…">`	Slot shown only on consent
`<x-consent-control-script consent="…" src="…" />`	Consent-gated `<script>` tag
`<x-consent-control-scripts />` / `@consentScripts`	Runtime + boot config
`@consent('analytics') … @endconsent`	Server-side conditional

JavaScript events

window receives a consent-updated event whenever consent changes:

window.addEventListener('consent-updated', (e) => console.log(e.detail.consents));

License

MIT. See LICENSE.md.

mmoollllee / laravel-consent-control

Maintainers

Package info

Statistics

Security