README

A package to easily make use of Lets Icons in your Laravel Blade views.

For a full list of available icons see the SVG directory or preview them at icones.js.org/collection/lets-icons. Lets Icons are originally developed by Leonid Tsvetkov.

Requirements

PHP 8.0 or higher
Laravel 9.0 or higher

Installation

composer require mansoor/blade-lets-icons

Blade Icons

Blade Lets 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 Lets 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-lets-icons.php config file:

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

Usage

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

<x-letsicon-bell />

You can also pass classes to your icon components:

<x-letsicon-bell class="w-6 h-6 text-gray-500" />

And even use inline styles:

<x-letsicon-bell style="color: #555" />

Or use the @svg directive:

@svg('letsicon-bell', 'w-6 h-6', ['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-lets-icons --force

Then use them in your views like:

<img src="{{ asset('vendor/blade-lets-icons/letsicon-bell.svg') }}" width="10" height="10"/>

Acknowledgements

This project uses icons from Lets Icons which are licensed under the Creative Commons Attribution 4.0 International License. You can view the license here.

Icons by Leonid Tsvetkov from [Lets Icons].

Changelog

Check out the CHANGELOG in this repository for all the recent changes.

License

Blade Lets Icons is open-sourced software licensed under the MIT license.

mansoor / blade-lets-icons

Maintainers

Details