awcodes / light-switch
Plugin to add theme switching (light/dark/system) to the auth pages for Filament Panels
Fund package maintenance!
awcodes
Installs: 27 429
Dependents: 2
Suggesters: 0
Security: 0
Stars: 31
Watchers: 2
Forks: 2
Open Issues: 0
Requires
- php: ^8.1
- filament/filament: ^3.0
- spatie/laravel-package-tools: ^1.15.0
Requires (Dev)
- laravel/pint: ^1.0
- nunomaduro/collision: ^7.9
- orchestra/testbench: ^8.0
- pestphp/pest: ^2.0
- pestphp/pest-plugin-arch: ^2.0
- pestphp/pest-plugin-laravel: ^2.0
- spatie/laravel-ray: ^1.26
README
Plugin to add theme switching (light/dark/system) to the auth pages for Filament Panels
Requirements
- Filament v3
Installation
You can install the package via composer:
composer require awcodes/light-switch
Usage
use Awcodes\LightSwitch\LightSwitchPlugin; public function panel(Panel $panel): Panel { return $panel ->plugins([ LightSwitchPlugin::make(), ]); }
Position
By default, the switcher will be added to the top right of the auth pages. You can change this by passing one of the Alignment
enums cases to the position()
method.
use Awcodes\LightSwitch\LightSwitchPlugin; use Awcodes\LightSwitch\Enums\Alignment; public function panel(Panel $panel): Panel { return $panel ->plugins([ LightSwitchPlugin::make() ->position(Alignment::BottomCenter), ]); } // Available positions Alignment::TopLeft Alignment::TopCenter Alignment::TopRight Alignment::BottomLeft Alignment::BottomCenter Alignment::BottomRight
Disabling on specific pages
You can disable the switcher on specific pages by passing an array of route strings to the on()
method. Anything in this array will get evaluated as should be shown. Otherwise, it will be enabled on all auth pages available to your panel.
When determining if the switcher should be shown the Str::contains()
method is used to match the route name, so you can pass a partial route string to match multiple pages and not have to pass the complete route name. This is useful if you need to target routes containing a specific panel route, like admin.auth.email
or app.auth.email
.
use Awcodes\LightSwitch\LightSwitchPlugin; public function panel(Panel $panel): Panel { return $panel ->plugins([ LightSwitchPlugin::make() ->enabledOn([ 'auth.email', 'auth.login', 'auth.password', 'auth.profile', 'auth.register', ]), ]); }
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.