ryangjchandler / filament-color-palette
Let users pick a color from a fixed list of options.
Fund package maintenance!
ryangjchandler
Requires
- php: ^8.0
- filament/filament: ^2.0
- illuminate/contracts: ^9.0
- spatie/laravel-package-tools: ^1.13.5
Requires (Dev)
- laravel/pint: ^1.0
- nunomaduro/collision: ^6.0
- nunomaduro/larastan: ^2.0.1
- orchestra/testbench: ^7.0
- pestphp/pest: ^1.21
- pestphp/pest-plugin-laravel: ^1.1
- pestphp/pest-plugin-livewire: ^1.0
- pestphp/pest-plugin-parallel: ^0.3
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- phpunit/phpunit: ^9.5
- spatie/laravel-ray: ^1.26
This package is auto-updated.
Last update: 2024-10-09 06:43:48 UTC
README
This packages implements a new ColorPalette
field as described in the mini-series on my blog.
It gives users a fixed set of color options to choose from and the option to choose an arbitrary custom color.
Installation
You can install the package via Composer:
composer require ryangjchandler/filament-color-palette
Usage
Add the field to your form like so:
use RyanChandler\FilamentColorPalette\ColorPalette; ColorPalette::make('color') ->options([ '#ffffff' => 'White', '#ff0000' => 'Red', '#000000' => 'Black', ]),
Store color name instead of code
You may wish to store the name (label) of a color instead of the color code. This can be achieved by calling the storeColorName()
method on the field.
ColorPalette::make('color') ->storeColorName() ->options([ '#ffffff' => 'White', '#ff0000' => 'Red', '#000000' => 'Black', ]),
Now instead of the hex codes being stored, the name from the options array will be used instead.
Custom colors
If you want your users to have some more freedom, you can allow them to choose custom colors. Call the ->allowCustomColors()
method on the field and a custom color picker will appear in the options.
ColorPalette::make('color') ->allowCustomColors() ->options([ '#ffffff' => 'White', '#ff0000' => 'Red', '#000000' => 'Black', ]),
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.