Blade Heroicons
A package to easily make use of Heroicons in your Laravel Blade views.
#Blade Heroicons
A package to easily make use of Heroicons in your Laravel Blade views.
For a full list of available icons see the SVG directory or preview them at heroicons.com. Heroicons are originally developed by Steve Schoger and Adam Wathan.
#Requirements
- PHP 8.0 or higher
- Laravel 9.0 or higher
#Installation
composer require blade-ui-kit/blade-heroicons
#Updating
Please refer to the upgrade guide when updating the library.
#Blade Icons
Blade Heroicons uses Blade Icons under the hood. Please refer to the Blade Icons readme for additional functionality. We also recommend to enable icon caching with this library.
#Configuration
Blade Heroicons also offers the ability to use features from Blade Icons like default classes, default attributes, etc. If you'd like to configure these, publish the blade-heroicons.php config file:
php artisan vendor:publish --tag=blade-heroicons-config
#Usage
Icons can be used as self-closing Blade components which will be compiled to SVG icons:
<x-heroicon-o-arrow-left/>
You can also pass classes to your icon components:
<x-heroicon-o-arrow-left class="w-6 h-6 text-gray-500"/>
And even use inline styles:
<x-heroicon-o-arrow-left style="color: #555"/>
Or use the @svg directive:
@svg('heroicon-o-arrow-left', 'w-6 h-6', ['style' => 'color: #555'])
The solid icons can be referenced like this:
<x-heroicon-s-arrow-left/>
The mini icons can be referenced like this:
<x-heroicon-m-arrow-left/>
And the micro icons can be referenced like this:
<x-heroicon-c-arrow-left/>
#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-heroicons --force
Then use them in your views like:
<img src="https://raw.githubusercontent.com/driesvints/blade-heroicons/main/{{ asset('vendor/blade-heroicons/o-arrow-left.svg') }}" width="10" height="10"/>
#Changelog
Check out the CHANGELOG in this repository for all the recent changes.
#Maintainers
Blade Heroicons is developed and maintained by Dries Vints.
#License
Blade Heroicons is open-sourced software licensed under the MIT license.