robertboes / blade-selfhst-icons
A package to easily make use of selfh.st Icons in your Laravel Blade views.
Maintainers
Requires
- php: ^8.2
- blade-ui-kit/blade-icons: ^1.6
- illuminate/support: ^11.0 || ^12.0
Requires (Dev)
- orchestra/testbench: ^9.0 || ^10.0
- phpunit/phpunit: ^10.5 || ^11.0
README
A package to easily make use of selfh.st Icons in your Laravel Blade views.
For a full list of available icons see the SVG directory or preview them at selfh.st/icons.
Requirements
- PHP 8.2 or higher
- Laravel 11.0 or higher
Installation
composer require robertboes/blade-selfhst-icons
Updating
Please refer to the upgrade guide when updating the library.
Blade Icons
Blade selfh.st Icons 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 selfh.st Icons 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-selfhst-icons.php config file:
php artisan vendor:publish --tag=blade-selfhst-icons-config
Usage
Icons can be used as self-closing Blade components which will be compiled to SVG icons:
<x-selfhst-1panel/>
You can also pass classes to your icon components:
<x-selfhst-1panel class="w-6 h-6 text-gray-500"/>
And even use inline styles:
<x-selfhst-1panel style="color: #555"/>
Icons are available in three variants: default, light, and dark:
<x-selfhst-1panel/> <x-selfhst-1panel-light/> <x-selfhst-1panel-dark/>
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-selfhst-icons --force
Then use them in your views like:
<img src="{{ asset('vendor/blade-selfhst-icons/1panel.svg') }}" width="10" height="10"/>
Changelog
Check out the CHANGELOG in this repository for all the recent changes.
Maintainers
Blade selfh.st Icons is developed and maintained by Robert Boes.
License
Blade selfh.st Icons is open-sourced software licensed under the MIT license.