README

A searchable catalogue of the icons a Laravel application can draw, across Flux, Blade Icons and your own providers. Store an icon key, validate it, draw it, and let people find icons by the words they actually type.

Icons::search('dustbin');                    // tabler.trash, best match first

$request->validate(['icon' => ['nullable', new IconExists]]);

<x-registry-icon :icon="$item->icon" class="size-5" />

Features

• Providers for Flux (its own icons, your resources/views/flux/icon, and everything built there by ympact/flux-icons) and for every Blade Icons set. Both optional, and you can add your own.
• Scored search over names, labels, aliases, use cases and purposes, with typo tolerance.
• A metadata file for labels and aliases, which the doctor command prunes without losing your comments.
• Purposes: one icon and label per meaning (action.delete), so similar actions look the same across your app.
• An IconExists rule that suggests the closest icon.
• A cache that php artisan optimize builds. With opcache, drawing a few icons does not load the whole set.
• A VS Code extension that completes icon keys as you type. See Editor support.

Requirements

Installation

composer require ympact/laravel-icon-registry

See the documentation for configuration and usage.

Development

composer test           # Pest
composer test:browser   # the Browser suite (installs Playwright's Chromium first)
composer analyse        # PHPStan, level 8
composer lint           # Pint
composer serve          # the workbench application, at http://localhost:8000

License

MIT. See LICENSE.md.