guava / filament-icons
This package allows you to generate enum classes for ANY blade icon set you have installed, making working with them a breeze!
Maintainers
Fund package maintenance!
Requires
- php: ^8.2
- filament/filament: ^4.0|^5.0
- laravel/prompts: ^0.3.5
- spatie/laravel-package-tools: ^1.15.0
Requires (Dev)
- laravel/pint: ^1.0
- nunomaduro/collision: ^8
- nunomaduro/larastan: ^3.0
- orchestra/testbench: ^10.0
- pestphp/pest: ^3.0
- pestphp/pest-plugin-arch: ^3.0
- pestphp/pest-plugin-laravel: ^3.0
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^2.0
- phpstan/phpstan-phpunit: ^2.0
README
Enum classes for any blade icon set
This package generates typed enum classes for ANY blade icon set you have installed, making working with them a breeze. The generated enums implement filament's ScalableIcon contract, so you can use them anywhere filament accepts an icon, with full autocompletion.
In addition, it ships a command that lets you pick blade icon packs from a searchable list and installs them via composer.
Documentation
The full documentation is available at guava.cz.
Version compatibility
| Filament version | Plugin version |
|---|---|
| 4.x | 1.x |
| 5.x | 1.x |
Installation
You can install the package via composer:
composer require guava/filament-icons
Usage
Generate an enum for any installed icon set:
php artisan filament-icons:generate
Install icon packs from a searchable list:
php artisan filament-icons:install
Then use the generated enum anywhere filament accepts an icon:
use App\Enums\Icons\Feather; IconColumn::make('status') ->icon(Feather::Activity);
Everything else is covered in the documentation.
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.