awcodes / dimmer
Dimmer is a simple package to easily add a light/dark/system mode switcher to your Laravel app.
Fund package maintenance!
Awcodes
Installs: 22
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 0
Language:Blade
Requires
- php: ^8.1
- illuminate/contracts: ^10.0|^11.0
- spatie/laravel-package-tools: ^1.14.0
Requires (Dev)
- laravel/pint: ^1.0
- nunomaduro/collision: ^7.8|^8.0
- orchestra/testbench: ^8.8|^9.0
- pestphp/pest: ^2.20
- pestphp/pest-plugin-arch: ^2.0
- pestphp/pest-plugin-laravel: ^2.0
- spatie/laravel-ray: ^1.26
README
Dimmer is a simple package to easily add a light/dark/system mode switcher to your Laravel app.
Requirements
- Alpine JS
- Tailwind CSS
Installation
You can install the package via composer:
composer require awcodes/dimmer
Next, you need to add the views to your tailwind.config.js
file:
content: [ './vendor/awcodes/dimmer/resources/views/**/*.blade.php', ]
Optionally (not recommended), you can publish the views using
php artisan vendor:publish --tag="dimmer-views"
You can also update the translations by publishing the lang files:
php artisan vendor:publish --tag="dimmer-translations"
Usage
Just include the dimmer
component in your layout or anywhere you would to use it.
<x-dimmer::controls />
Forcing a default mode
Should you wish to force a default mode for when a user first visits the site, you can do so by setting the force-mode
attribute on the dimmer
component. Without this attribute set, the default mode will be determined by the user's system preferences.
<x-dimmer::controls force-mode="dark" />
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.