包简介

A GDPR-compliant cookie consent solution for Laravel applications with fully customizable cookie banners, granular consent control, and enterprise-grade compliance features.

README 文档

README

A GDPR-compliant solution offering enterprise-grade compliance with fully customizable cookie banners for Laravel applications. Simplifies regulatory requirements while maintaining excellent user experience and complete customization capabilities.

Features

🔥 One-Click Implementation – Simple installation via Composer with auto-loaded assets
⚡ Zero Performance Impact – Lightweight with lazy-loaded components
🌍 RTL & i18n Support – Full right-to-left compatibility + multilingual translations
🌙 Dark Mode Support – Auto dark/light mode matching system preferences
🛡 Granular Consent Control – Category-level cookie management (necessary/analytics/marketing)
📦 Complete Customization – Override every color, text, and layout via config
📱 Responsive Design – Perfectly adapts to all devices (mobile/tablet/desktop)
🧩 No Frontend Dependencies – No jQuery, Bootstrap, or Tailwind required — works everywhere effortlessly

🚀 Live Demo

👉 Try the Live Demo

Installation

To get started with Cookie Consent, follow these simple steps:

Install the package via Composer:

composer require devrabiul/laravel-cookie-consent

Publish the package resources by running: (Normal publish)

php artisan vendor:publish --provider="Devrabiul\CookieConsent\CookieConsentServiceProvider"

Basic Usage

Include these components in your Blade templates:

Add styles in the <head> section:

{!! CookieConsent::styles() !!}

Add scripts before closing </body>:

{!! CookieConsent::scripts() !!}

Complete Example

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Your Page</title>
    {!! CookieConsent::styles() !!}
</head>
<body>

    <!-- Your content -->
    {!! CookieConsent::scripts() !!}
</body>
</html>

Advanced Configuration

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Your Page</title>
    {!! CookieConsent::styles() !!}
</head>
<body>

    <!-- Your content -->
    {!! CookieConsent::scripts(options: [
        'cookie_lifetime' => config('laravel-cookie-consent.cookie_lifetime', 7),
        'reject_lifetime' => config('laravel-cookie-consent.reject_lifetime', 1),
        'disable_page_interaction' => config('laravel-cookie-consent.disable_page_interaction', true),
        'preferences_modal_enabled' => config('laravel-cookie-consent.preferences_modal_enabled', true),
        'consent_modal_layout' => config('laravel-cookie-consent.consent_modal_layout', 'bar-inline'),
        'flip_button' => config('laravel-cookie-consent.flip_button', true),
        'theme' => config('laravel-cookie-consent.theme', 'default'),
        'cookie_prefix' => config('laravel-cookie-consent.cookie_prefix', 'Laravel_App'),
        'policy_links' => config('laravel-cookie-consent.policy_links', [
            ['text' => CookieConsent::translate('Privacy Policy'), 'link' => url('privacy-policy')],
            ['text' => CookieConsent::translate('Terms & Conditions'), 'link' => url('terms-and-conditions')],
        ]),
        'cookie_categories' => config('laravel-cookie-consent.cookie_categories', [
            'necessary' => [
                'enabled' => true,
                'locked' => true,
                'js_action' => 'loadGoogleAnalytics',
                'title' => CookieConsent::translate('Essential Cookies'),
                'description' => CookieConsent::translate('These cookies are essential for the website to function properly.'),
            ],
            'analytics' => [
                'enabled' => env('COOKIE_CONSENT_ANALYTICS', false),
                'locked' => false,
                'title' => CookieConsent::translate('Analytics Cookies'),
                'description' => CookieConsent::translate('These cookies help us understand how visitors interact with our website.'),
            ],
            'marketing' => [
                'enabled' => env('COOKIE_CONSENT_MARKETING', false),
                'locked' => false,
                'js_action' => 'loadFacebookPixel',
                'title' => CookieConsent::translate('Marketing Cookies'),
                'description' => CookieConsent::translate('These cookies are used for advertising and tracking purposes.'),
            ],
            'preferences' => [
                'enabled' => env('COOKIE_CONSENT_PREFERENCES', false),
                'locked' => false,
                'js_action' => 'loadPreferencesFunc',
                'title' => CookieConsent::translate('Preferences Cookies'),
                'description' => CookieConsent::translate('These cookies allow the website to remember user preferences.'),
            ],
        ]),
        'cookie_title' => CookieConsent::translate('Cookie Disclaimer'),
        'cookie_description' => CookieConsent::translate('This website uses cookies to enhance your browsing experience, analyze site traffic, and personalize content. By continuing to use this site, you consent to our use of cookies.'),
        'cookie_modal_title' => CookieConsent::translate('Cookie Preferences'),
        'cookie_modal_intro' => CookieConsent::translate('You can customize your cookie preferences below.'),
        'cookie_accept_btn_text' => CookieConsent::translate('Accept All'),
        'cookie_reject_btn_text' => CookieConsent::translate('Reject All'),
        'cookie_preferences_btn_text' => CookieConsent::translate('Manage Preferences'),
        'cookie_preferences_save_text' => CookieConsent::translate('Save Preferences'),
    ]) !!}

</body>
</html>

🌙 Enable Dark Mode

Add theme="dark" to your <body> tag to automatically enable dark mode.

<body theme="dark"></body>

Theme Preset Support

This package now supports preset color themes for cookie banners. You can choose from:

Preset	Description
`basic`	Default neutral theme, clean and simple.
`modern-blue`	Professional blue style, ideal for SaaS/web apps.
`trust-green`	Privacy-friendly green, promotes trust and eco-friendly vibes.
`soft-neutral`	Minimal soft gray, subtle and non-intrusive.
`dark`	Dark mode theme, low-light friendly.

How to configure

In config/cookie-consent.php:

/*
|--------------------------------------------------------------------------
| Theme Preset
|--------------------------------------------------------------------------
| basic        - Default neutral theme
| modern-blue  - Professional blue style
| trust-green  - Privacy-friendly green style
| soft-neutral - Minimal soft gray theme
| dark         - Dark theme
*/
'theme_preset' => env('COOKIE_CONSENT_THEME_PRESET', 'basic'),

🌐 Enable RTL Mode

Add dir="rtl" to your <body> tag to enable right-to-left layout for RTL languages.

<body dir="rtl"></body>

Layout Options

Config Status Control

COOKIE_CONSENT_ENABLED=true
COOKIE_CONSENT_PREFERENCES_ENABLED=true
COOKIE_CONSENT_ASSET_URL=https://your-domain.com // if you are in localhost, avoid this or put null

COOKIE_CONSENT_ANALYTICS=true
COOKIE_CONSENT_MARKETING=true
COOKIE_CONSENT_PREFERENCES=true

Consent Modal Styles

box - Compact floating dialog
box-inline - Inline positioned box
box-wide - Expanded floating dialog
cloud - Modern floating design
cloud-inline - Compact cloud variant
bar - Top/bottom banner
bar-inline - Compact banner

Default: box-wide

Preferences Modal Styles

bar - Full-width layout
box - Centered popup

Default: bar

Configuration

Edit config/cookie-consent.php to modify:

Cookie lifetimes
Custom asset URL
Visual styles
Text content
Category settings

Example service loader (replace with your actual implementation)

function loadGoogleAnalytics() {
    // Please put your GA script in loadGoogleAnalytics()
    // You can define function name from - {!! CookieConsent::scripts() !!}

    window.dataLayer = window.dataLayer || [];

    function gtag() {
        dataLayer.push(arguments);
    }

    gtag('js', new Date());
    gtag('config', 'YOUR_GA_ID');

    // Load the GA script
    const script = document.createElement('script');
    script.src = 'https://www.googletagmanager.com/gtag/js?id=YOUR_GA_ID';
    script.async = true;
    document.head.appendChild(script);
}

function loadFacebookPixel() {
    // Please put your marketing script in loadFacebookPixel()
    // You can define function name from - {!! CookieConsent::scripts() !!}

    !function (f, b, e, v, n, t, s) {
        if (f.fbq) return;
        n = f.fbq = function () {
            n.callMethod ?
                n.callMethod.apply(n, arguments) : n.queue.push(arguments)
        };
        if (!f._fbq) f._fbq = n;
        n.push = n;
        n.loaded = !0;
        n.version = '2.0';
        n.queue = [];
        t = b.createElement(e);
        t.async = !0;
        t.src = v;
        s = b.getElementsByTagName(e)[0];
        s.parentNode.insertBefore(t, s)
    }(window, document, 'script',
        'https://connect.facebook.net/en_US/fbevents.js');
    fbq('init', 'YOUR_PIXEL_ID');
    fbq('track', 'PageView');
}

Change Cookie Preferences Link

To comply with UK ICO and GDPR regulations, users must be able to revisit and update their cookie preferences at any time. This package now supports that functionality out of the box.

You can add a link anywhere on your site to let users open the cookie preferences modal again and update their choices:

<a onclick="showHideToggleCookiePreferencesModal()">Change Cookie Preferences</a>

Or use the class-based approach (useful if you want to attach event handlers via JavaScript or multiple links):

<a class="showHideToggleCookiePreferencesModal">Change Cookie Preferences</a>

How It Works

Clicking the link will show the cookie preferences modal, allowing the user to change their settings.
This feature resets the consent banner/modal visibility so users can modify their choices in compliance with the ICO’s requirement.
The modal respects existing preferences but allows full customization and saving new preferences.

Compliance with UK ICO and GDPR

This package is designed to help your Laravel application meet the requirements of the UK Information Commissioner’s Office (ICO) and the GDPR by:

Providing explicit, granular cookie consent with customizable categories (e.g., necessary, analytics, marketing, preferences).
Allowing users to easily revisit and change their cookie preferences at any time using the “Change Cookie Preferences” link.
Supporting clear cookie banners and modals with translations and accessibility considerations.
Enabling consent logging and event dispatching for auditing and analytics purposes.

For more details, please review the UK ICO guidance on cookies: ICO Guide to Cookies and Similar Technologies

🎯 Get Started Today!

Experience the magic of CookieConsent and enhance your Laravel applications with Cookie Consent.

🔗 GitHub: Laravel Cookie Consent
🔗 **Packagist: ** https://packagist.org/packages/devrabiul/laravel-cookie-consent

Contributing

We welcome contributions to CookieConsent! If you would like to contribute, please fork the repository and submit a pull request. For any issues or feature requests, please open an issue on GitHub.

Please:

Fork the repository
Create your feature branch
Submit a pull request

License

This package is open-sourced software licensed under the MIT license.

🌱 Treeware

This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

Contact

For support or inquiries, please reach out to us at Send Mail.

devrabiul/laravel-cookie-consent 适用场景与选型建议

devrabiul/laravel-cookie-consent 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 53.18k 次下载、GitHub Stars 达 182，最近一次更新时间为 2025 年 04 月 03 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「laravel」「banner」「cookie」「privacy」「consent」「gdpr」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 devrabiul/laravel-cookie-consent 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 devrabiul/laravel-cookie-consent 我们能提供哪些服务？

定制开发 / 二次开发

基于 devrabiul/laravel-cookie-consent 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 devrabiul/laravel-cookie-consent 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

adigital/cookie-consent-banner 11

Add a configurable cookie consent banner to the website.

nzta/silverstripe-sitebanner 10

Site-wide banners activated through the CMS

logicbrush/silverstripe-herocontent 2

A module for the SilverStripe CMS which allows you to add a big block of important content at the top of the page.

geniv/nette-popup 0

Popup component for Nette Framework

avored/fixed-rate 4

AvoRed Laravel E commerce - Fixed Rate Shippung Module

dynamikaweb/yii2-cookieconsent-widget 0

Cookie Consent is a lightweight JavaScript plugin for alerting users about the use of cookies on your website.

devrabiul/laravel-cookie-consent

包简介

关键字：