aleex1848 / blade-hwkicons
A package to easily make use of Hwkicons in your Laravel Blade views.
Requires
- php: ~8.1.0|~8.2.0
- blade-ui-kit/blade-icons: ^1.4
- illuminate/support: ^9.0|^10.0
Requires (Dev)
- orchestra/testbench: ^7.0|^8.0
- phpunit/phpunit: ^9.0
This package is not auto-updated.
Last update: 2024-04-23 15:14:48 UTC
README
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.
Requirements
- PHP 8.1 or higher
- Laravel 9.0 or higher
Installation
composer require blade-organization/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-adjustments/>
You can also pass classes to your icon components:
<x-heroicon-o-adjustments class="w-6 h-6 text-gray-500"/>
And even use inline styles:
<x-heroicon-o-adjustments style="color: #555"/>
The solid icons can be referenced like this:
<x-heroicon-s-adjustments/>
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="{{ asset('vendor/blade-heroicons/o-adjustments.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 Blade Developer.
License
Blade Heroicons is open-sourced software licensed under the MIT license.