README

Version Compatibility

• Create and edit consent options
• Apply them to user models
• Include a consent form during registration
• Email a copy of the consents to the user
• Users already accepted can be asked to accept the updated consent
• Provide users with My Consents page allowing review of their given consents
• Provide admin panel users with a list of consents provided by all users

Installation

You can install the package via composer:

# For Filament 5.x
composer require visualbuilder/user-consent:^5.0

# For Filament 4.x
composer require visualbuilder/user-consent:^4.0

You can publish and run the migrations with:

php artisan vendor:publish --tag="user-consent-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="user-consent-config"

Optionally, you can publish the views using

php artisan vendor:publish --tag="user-consent-views"

This is the contents of the published config file:

return [
];

Customising the consent page

The page that users are sent to when consent is required (consent-option-request) is resolved from config, so you can register your own subclass without having to redefine the route — useful when you want to customise the page chrome, layout or behaviour:

// config/filament-user-consent.php
'pages' => [
    'consent_option_form_builder' => \App\Livewire\ConsentOptionFormBuilder::class,
],

// app/Livewire/ConsentOptionFormBuilder.php
use Visualbuilder\FilamentUserConsent\Livewire\ConsentOptionFormBuilder as BaseConsentOptionFormBuilder;

class ConsentOptionFormBuilder extends BaseConsentOptionFormBuilder
{
    // e.g. expose a logo + theme switcher, tweak the max width, etc.
}

When the option is omitted it defaults to the package's own Visualbuilder\FilamentUserConsent\Livewire\ConsentOptionFormBuilder.

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

• Lee Evans
• All Contributors

License

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