README

A color picker field for Filament Forms that uses preset color palettes.

Installation

You can install the package via composer:

composer require awcodes/preset-color-picker

Important

If you have not set up a custom theme and are using a Panel follow the instructions in the Filament Docs first. The following applies to both the Panels Package and the standalone Forms package.

Add the plugin's views to your tailwind.config.js file.

content: [
    './vendor/awcodes/preset-color-picker/resources/views/**/*.blade.php',
]

Rebuild your custom theme.

npm run build

Usage

Simply add the field to your form using the PresetColorPicker field and pass in an array of Filament Color objects.

Should you need to include black and white in your color palette, you can use the withWhite and withBlack methods. This will include black and white at the end of the color options.

You can also use the 'swap' argument to swap out the hex value used for black and white.

PresetColorPicker::make('color')
    ->colors([
        // array of Filament Color objects    
    ])
    ->size('sm') // optional 'xs', 'sm', 'md', 'lg'
    ->withBlack(swap: '#111111')
    ->withWhite(swap: '#f5f5f5'),

Hook Classes

These are the available classes for css coustmizations:

for the main container: pcp-preset-color-picker
for items: pcp-preset-color-picker-item
for active/selected item: pcp-preset-color-picker-item-active

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.

awcodes / preset-color-picker

Maintainers

Details