anodyne / blade-keyline-icons
A package to easily make use of Keyline Icons in your Laravel Blade views.
Requires
- php: ^8.1
- blade-ui-kit/blade-icons: ^1.5
- illuminate/support: ^9.0|^10.0|^11.0|^12.0|^13.0
Requires (Dev)
- ext-dom: *
- laravel/pint: ^1.0
- orchestra/testbench: ^7.0|^8.0|^9.0|^10.0|^11.0
- pestphp/pest: ^1.23|^2.0|^3.0|^4.0
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
A package to easily make use of Keyline Icons in your Laravel Blade views.
For a full list of available icons see the SVG directory or preview them on the web.
Requirements
- PHP 8.1 or higher
- Laravel 9.0 or higher
Installation
composer require anodyne/blade-keyline-icons
Usage
Icons can be used a self-closing Blade components which will be compiled to SVG icons:
<x-keyline-abacus />
You can also pass classes to your icon components:
<x-keyline-abacus class="size-6 text-gray-500"/>
And even use inline styles:
<x-keyline-abacus style="color: #555"/>
Raw SVG Icons
If you want to use the raw SVG icons as assets, you can publish them using:
php artisan vendor:publish --tag=blade-keyline-icons --force
Then use them in your views like:
<img src="{{ asset('vendor/blade-keyline-icons/abacus.svg') }}" width="10" height="10"/>
Blade Icons
Blade Keyline Icons uses Blade Icons under the hood. Please refer to the Blade Icons readme for additional functionality.
Enum
Blade Keyline Icons includes an enum that maps every icon to an enum case. This allows for easily referencing specific icons from PHP. This is also helpful when using Keyline Icons with a system like Filament for referencing icons.
use Anodyne\KeylineIcons\KeylineIcon; svg(KeylineIcon::AlertCircle->value);
Changelog
Check out the CHANGELOG in this repository for all the recent changes.
Maintainers
Blade Keyline Icons was developed by Anodyne Productions.
License
Blade Keyline Icons is open-sourced software licensed under the MIT license.