jeffersongoncalves / filament-ccpa-opt-out
Filament plugin for laravel-ccpa-opt-out: the CCPA opt-out ledger in your panel, read-only: who opted out of the sale or sharing of personal information or limited the use of sensitive personal information, and when a Global Privacy Control signal did it.
Package info
github.com/jeffersongoncalves/filament-ccpa-opt-out
pkg:composer/jeffersongoncalves/filament-ccpa-opt-out
Requires
- php: ^8.2
- filament/filament: ^5.3
- jeffersongoncalves/filament-plugin-core: ^3.0
- jeffersongoncalves/laravel-ccpa-opt-out: ^1.0
- spatie/laravel-package-tools: ^1.16
Requires (Dev)
- jeffersongoncalves/pest-plugin-database-migrations: ^1.0
- larastan/larastan: ^3.0
- laravel/pint: ^1.0
- orchestra/testbench: ^10.0|^11.0
- pestphp/pest: ^3.0|^4.0
- pestphp/pest-plugin-laravel: ^3.0|^4.0
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
Filament CCPA Opt-Out
Browse the opt-out ledger of laravel-ccpa-opt-out from your Filament panel. Each row is one choice: an opt-out of the sale or sharing of personal information (Cal. Civ. Code §1798.120), a request to limit the use of sensitive personal information (§1798.121), or an opt-in back. The record shows who chose, which right, when, from where (IP address, user agent, source) and its metadata.
Features
- Choices of users and of visitors without an account, including those a Global Privacy Control signal made (Regulations §7025).
- Filters by right, choice (opted out or opted in), visitors and Global Privacy Control.
- Read-only, like the ledger itself: there is no create, edit or delete.
- 19 languages.
Compatibility
| Plugin Version | Filament |
|---|---|
| 1.x | 3.x |
| 2.x | 4.x |
| 3.x | 5.x |
Installation
You can install the package via composer:
composer require jeffersongoncalves/filament-ccpa-opt-out:"^3.0" php artisan vendor:publish --tag="ccpa-opt-out-migrations" php artisan migrate
Usage
use JeffersonGoncalves\Filament\CcpaOptOut\CcpaOptOutPlugin; public function panel(Panel $panel): Panel { return $panel ->plugins([ CcpaOptOutPlugin::make() ->navigationGroup('CCPA') // default: no group ->navigationSort(20) ->navigationIcon('heroicon-o-hand-thumb-up') ->slug('opt-outs'), ]); }
All fluent methods are optional. Purposes and their current terms version are configured in laravel-ccpa-opt-out's ccpa-opt-out config.
The resource has no authorization of its own: register it only on panels whose users may see opt-out records, or add a policy for
JeffersonGoncalves\CcpaOptOut\Models\OptOutRecord.
Related plugins
- filament-ccpa: personal data inventory.
- filament-ccpa-dsar: data subject requests (Arts. 15 to 22).
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
License
The MIT License (MIT). Please see License File for more information.
