Download the PHP package guava/filament-icon-picker without Composer
On this page you can find all versions of the php package guava/filament-icon-picker. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download guava/filament-icon-picker
More information about guava/filament-icon-picker
Files in guava/filament-icon-picker
Package filament-icon-picker
Short Description A filament plugin that adds an icon picker field.
License MIT
Informations about the package filament-icon-picker
Filament Icon Picker
This plugin adds a new icon picker form field and a corresponding table column. You can use it to select from any blade-icons kit that you have installed. By default, heroicons are supported since it is shipped with Filament.
This can be useful for when you want to customize icons rendered on your frontend, if you want your users to be able to customize navigation icons, add small icons to their models for easy recognition and similar.
Installation
You can install the package via composer:
Filament v3:
Filament v2:
You can publish the config file with:
This is the contents of the published config file:
Usage
Basic Usage
Usage in Admin Panel:
Usage in Livewire Component:
Usage in Tables:
The field's state returns the selected identifier of the icon.
Assuming we saved the icon on our $category
model under $icon
, you can render it in your blade view using:
More information on rendering the icon on the blade-icons github.
Options
Columns
By default, a single-column icon picker will be displayed.
You can customize the amount of columns via the icon-picker.columns
configuration or using the ->columns()
option like this:
1 Column | 3 Columns |
---|---|
Sets
By default, the plugin will use all available blade icon sets installed. If you want to use only specific icon sets, you can change the default via the icon-picker.sets
configuration or on a case-by-case basis:
When installing new sets, please make sure to clear your cache, if you can't find your icons in the icon picker.
Allow/Disallow icons
For detailed control over the icons, there are two options available to allow and disallow certain icons.
Layout
The icon picker comes with two layouts. The default, Layout::FLOATING
is the standard layout used in Filament Selects. The search results will appear in a pop over window.
The Layout::ON_TOP
will render the search results always on the page.
Custom Item Template
Out of the box, the search results render a preview of the icon and their identifier.
You are free to customize this using the ->itemTemplate()
option:
Caching
Depending on how many icon packs you use and their size, the loading time for getting the search results can be high. In order to mitigate this issue a bit, search results are by default cached (for 7 days).
You can configure the default caching options for all icon pickers in the configuration file.
To configure a specific IconPicker, these methods are available:
//: # () //: # ()
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
License
The MIT License (MIT). Please see License File for more information.
Other packages
All versions of filament-icon-picker with dependencies
filament/filament Version ^3.0@stable
illuminate/contracts Version ^9.0|^10.0|^11.0