Installation

On this page

/ 01 Requirements / 02 Installing the package / 03 Custom theme / 04 Livewire payload size / 05 Custom icon uploads

Requirements

PHP 8.2 or higher
Filament 5.x
blade-icons 1.8 or higher, which composer installs for you

Installing the package

You can install the package via composer:

composer require guava/filament-icon-picker

Next, publish the package assets:

php artisan filament:assets

Custom theme

A custom filament theme is required, otherwise the CSS of the picker is not built and the field will look broken.

If you don't have one yet, please read the filament documentation on how to create a custom theme.

Once you have a theme, add the following to your theme.css file:

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

IMPORTANTEvery panel that uses the icon picker needs a theme with this source path. It's up to you if you want to use the same theme for all panels or a separate one for each.

Livewire payload size

The picker loads the icons of your installed sets over livewire. If you have a lot of icon sets installed, you might hit livewire's payload limit, especially when you render the picker inline.

If that happens, increase the payloads.max_calls setting in your config/livewire.php.

Custom icon uploads

If you want your users to upload their own icons, you also need a public storage link, since uploaded icons are stored on the public disk:

php artisan storage:link

Everything else is covered in enabling uploads.

guava/filament-icon-picker 709K installs · 163 stars

GitHub Packagist Report an issue