README

A customizable cookie consent plugin for Filament panels. It displays a modal to users to accept or refuse cookies, and provides a middleware to enforce consent if required.

Features

• Customizable Schema: Define your own content and fields for the cookie consent modal.
• Middleware Support: Automatically redirect users to the dashboard or show the modal if consent is not yet given.
• Notifications: Show success notifications upon acceptance or rejection.
• Easy Integration: Simple registration via Filament Panel provider.
• Flexible Configuration: Control modal heading, description, icon, buttons, and more.

Installation

You can install the package via composer:

composer require slimani/filament-cookie-consent

Usage

Registering the Plugin

Register the plugin in your Panel Provider:

use Slimani\CookieConsent\CookieConsentPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugin(CookieConsentPlugin::make());
}

Customizing the Plugin

You can customize the plugin's behavior using the following methods:

CookieConsentPlugin::make()
    ->modalHeading('We value your privacy')
    ->modalDescription('We use cookies to enhance your browsing experience.')
    ->modalSubmitActionLabel('Accept All')
    ->modalCancelActionLabel('Reject All')
    ->modalWidth('4xl')
    ->cookiesRequired() // Enforce consent via middleware
    ->showAcceptedNotification(false)
    ->schema([
        // Your custom Filament schema components here
    ])

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Mohamed Slimani
• All Contributors

License

The MIT License (MIT). Please see License File for more information.