schmeits/filament-4-phosphor-icons

Phosphor icons for Filament 4 and 5

All Phosphor icons as a backed enum for Filament. The enum implements Filament's ScalableIcon contract, so every icon follows Filament's icon sizes, and you can pick any of the six Phosphor weights yourself.

The icons themselves come from codeat3/blade-phosphor-icons.

Compatibility

The minimum Filament versions are the first ones without known security advisories.

Installation

composer require schmeits/filament-4-phosphor-icons

Usage

use Filament\Forms\Components\TextInput;
use Schmeits\FilamentPhosphorIcons\Support\Icons\Phosphor;

TextInput::make('name')
    ->required()
    ->prefixIcon(Phosphor::Smiley);

Find the icon you need on phosphoricons.com. The enum case is the icon name in PascalCase: smiley-sticker becomes Phosphor::SmileySticker.

Sizes

When you pass the enum itself, Filament asks it for an icon per size. This package maps the sizes to a weight:

Weights

To use one weight everywhere, pick it explicitly:

use Schmeits\FilamentPhosphorIcons\Support\Icons\Phosphor;
use Schmeits\FilamentPhosphorIcons\Support\Icons\PhosphorWeight;

->prefixIcon(Phosphor::Smiley->getIconForWeight(PhosphorWeight::Duotone))

The available weights are Thin, Light, Regular, Bold, Fill and Duotone.

Updating the icons

The enum is generated from the installed version of codeat3/blade-phosphor-icons. After upgrading that package:

composer generate-enum

The test suite fails when the enum and the icon source no longer match, in either direction.

Testing

composer test
composer analyse

Changelog

Please see CHANGELOG for more information on what has changed recently.

Security

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

Credits

• Tally Schmeits
• Phosphor icons
• All Contributors

License

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