README

Adds a icon select (via dropdown) column to your filament tables.

This plugin adds an Icon Select Column to your filament tables.

Version compatibility

Showcase

Support us

Your support is key to the continual advancement of our plugin. We appreciate every user who has contributed to our journey so far.

While our plugin is available for all to use, if you are utilizing it for commercial purposes and believe it adds significant value to your business, we kindly ask you to consider supporting us through GitHub Sponsors. This sponsorship will assist us in continuous development and maintenance to keep our plugin robust and up-to-date. Any amount you contribute will greatly help towards reaching our goals. Join us in making this plugin even better and driving further innovation.

Installation

You can install the package via composer:

composer require guava/filament-icon-select-column

Additionally, you need to have a custom filamen theme installed, otherwise you might encounter some styling issues.

Check the official filament documentation here to learn how to do that.

Then in your custom filament theme theme.css file, add the following line to build the CSS correctly:

@source '../../../../vendor/guava/filament-icon-select-column/resources/**/*';

Usage

In any filament table, simply use it like any other column.

The package works best in combination with backed enums, such as in the below example.

The enum should implement HasLabel, HasIcon and optionally HasColor as described in the filament documentation here.

use Guava\FilamentIconSelectColumn\Tables\Columns\IconSelectColumn;

$table->columns([
    IconSelectColumn::make('state')
        ->options(MyStateEnum::class)
]);

Alternatively, you can pass an array of options and icons directly to the column:

$table->columns([
    IconSelectColumn::make('state')
        ->options([
            'opt1' => 'Option 1',
            'opt2' => 'Option 2',
        ])
        ->icons([
            'opt1' => 'heroicon-o-check',
            'opt2' => 'heroicon-o-x-mark',
        ])
]);

Close on selection

If you want the dropdown to automatically close after you select an option, you can use the closeOnSelection method:

use Guava\FilamentIconSelectColumn\Tables\Columns\IconSelectColumn;

IconSelectColumn::make('state')
    ->closeOnSelection()
    // ...

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

• Lukas Frey
• All Contributors
• Spatie - Our package skeleton is a modified version of Spatie's Package Skeleton

License

The MIT License (MIT). Please see License File for more information.