Skip to content

Latest commit

 

History

History
86 lines (55 loc) · 2.58 KB

README.md

File metadata and controls

86 lines (55 loc) · 2.58 KB
Raw

Blade Iconic

run-tests Latest Stable Version Total Downloads

A package to easily make use of Iconic icons in your Laravel Blade views.

For a full list of available icons see the SVG directory. Iconic icons are originally developed by Make Lemonade.

Requirements

  • PHP 7.4 or higher
  • Laravel 8.0 or higher

Installation

composer require itsmalikjones/blade-iconic

Blade Icons

Blade Iconic 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 Iconic 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-iconic.php config file:

php artisan vendor:publish --tag=blade-iconic-config

Usage

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

<x-iconic-star/>

You can also pass classes to your icon components:

<x-iconic-star class="w-6 h-6 text-gray-500"/>

And even use inline styles:

<x-iconic-star 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-iconic --force

Then use them in your views like:

<img src="{{ asset('vendor/blade-iconic/star.svg') }}" width="10" height="10"/>

Changelog

Please see CHANGELOG for more information on what has changed recently.

Maintainers

Blade Iconic is developed and maintained by Malik Alleyne-Jones.

License

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