README

Blade Icons - Sertxu's Collection

This package provides a collection of custom icons for Laravel Blade. It is based on Blade Icons from Blade UI Kit.

Requirements

PHP 8.2 or higher
Laravel 11.x or higher

Installation

composer require sertxudeveloper/blade-icons

Blade Icons

Blade Icons - Sertxu's Collection uses Blade Icons from Blade UI Kit 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 Icons - Sertxu's Collection 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 icons.php config file:

php artisan vendor:publish --tag=icons-config

Usage

Icons can be used as self-closing Blade components which will be compiled to SVG icons:

<x-icon-home/>

You can also pass classes to your icon components:

<x-icon-home class="w-6 h-6 text-gray-500"/>

And even use inline styles:

<x-icon-home style="color: #555"/>

The solid icons can be referenced like this:

<x-icon-home/>

Testing

This package contains tests, you can run them using the following command:

composer test

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

sertxudeveloper / blade-icons

Maintainers

Details