A color picker field for Filament Forms that uses preset color palettes.
You can install the package via composer:
composer require awcodes/palette
Important
If you have not set up a custom theme and are using Filament Panels 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/palette/resources/views/**/*.blade.php',
]
Rebuild your custom theme.
npm run build
Palette will store the selected color in your db as an array of data. Because of this you must cast the column in your model as array
or json
.
protected $casts = [
'content' => 'array', // or 'json'
];
The stored content will take the following shape:
[
'key' => 'primary',
'property' => '--primary-500',
'label' => 'Primary',
'type' => 'rgb',
'value' => '238, 246, 213',
]
Simply add the field to your form using the ColorPicker
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.
Note: Shades only work with Filament Color objects
use Awcodes\Palette\Forms\Components\ColorPicker;
use Filament\Support\Colors\Color;
ColorPicker::make('color')
->colors([
'indigo' => Color::Indigo
'badass' => Color::hex('#bada55'),
'salmon' => '#fa8072',
'bg-gradient-secondary' => 'bg-gradient-secondary'
])
->shades([
'badass' => 300
])
->size('sm') // optional 'xs', 'sm', 'md', 'lg', 'xl'
->withBlack(swap: '#111111')
->withWhite(swap: '#f5f5f5'),
Simply add the field to your form using the ColorPickerSelect
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.
Note: Shades only work with Filament Color objects
use Awcodes\Palette\Forms\Components\ColorPickerSelect;
use Filament\Support\Colors\Color;
ColorPickerSelect::make('color')
->colors([
'indigo' => Color::Indigo
'badass' => Color::hex('#bada55'),
'salmon' => '#fa8072',
'bg-gradient-secondary' => 'bg-gradient-secondary'
])
->shades([
'badass' => 300
])
->withBlack(swap: '#111111')
->withWhite(swap: '#f5f5f5'),
Simply add the ColorEntry
to your infolist schema.
use Awcodes\Palette\Infolists\Components\ColorEntry;
ColorEntry::make('color')
->size('sm') // optional 'xs', 'sm', 'md', 'lg', 'xl'
Available classes for css customizations on the ColorPicker:
- for the main container:
palette-color-picker
- for items:
palette-color-picker-item
- for active/selected item:
palette-color-picker-item-active
Available classes for css customizations on the ColorEntry:
- for the main container:
palette-entry-item
composer test
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.