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.

ryangjchandler / filament-color-palette

Maintainers

Details