README

Install and use any icon pack in your filament panel

This package allows you to generate enum classes for ANY blade icon set you have installed, making working with them a breeze!

In addition, you can easily install icon packs using an artisan command.

Version compatibility

This plugin is compatible with both filament 4.x and 5.x.

Installation

You can install the package via composer:

composer require guava/filament-icons

Usage

Using the package is dead simple! There are two commands that you can run.

Generate Icon Enum

php artisan filament-icons:generate

Simply run the command follow the instructions to generate a complete Enum class for any of your blade icon sets, even your custom ones!

Installing blade icon packs

If you do not have any blade icon packs installed, you can use the convenient install command which simply allows you to select and download one of the many blade icon packs found here.

php artisan filament-icons:install

It is not necessary to run this command if you already have some blade icon packs installed.

Icon packs list

The icon packs available for download are taken from the blade icons package here.

If you find that some of the icon packs available for installation are outdated, or if you know of an icon pack that is not available to download via the command and you would like to add it, feel free to PR an addition to the PACKAGES constant in the InstallIconPackCommand or create an issue with the composer package name and link to the github repository.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Lukas Frey
• All Contributors

License

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