anodyne/blade-mage-icons

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

0.7-beta 2023-10-30 00:26 UTC

Requires

• php: ~8.1.0|~8.2.0
• blade-ui-kit/blade-icons: ^1.4
• illuminate/support: ^9.0|^10.0

Requires (Dev)

• mage-icons/mage-icons: 0.7.0-beta
• orchestra/testbench: ^7.0|^8.0
• phpunit/phpunit: ^9.0

MIT

• Anodyne Productions

• laravel
• blade
• Mage Icons

README

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

For a full list of available icons see the website or the SVG directory.

Requirements

• PHP 8.1 or higher
• Laravel 9.0 or higher

Installation

composer require anodyne/blade-mage-icons

Blade Icons

Blade Mage 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 Mage 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-mage-icons.php config file:

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

Usage

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

<x-mage-s-check-circle/>

You can also pass classes to your icon components:

<x-mage-s-check-circle class="w-6 h-6 text-gray-500"/>

And even use inline styles:

<x-mage-s-check-circle style="color: #555"/>

The bulk (filled) icons can be referenced like this:

<x-mage-b-check-circle/>

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-mage-icons --force

Then use them in your views like:

<img src="{{ asset('vendor/blade-mage-icons/b-check-circle.svg') }}" width="10" height="10"/>
<img src="{{ asset('vendor/blade-mage-icons/s-check-circle.svg') }}" width="10" height="10"/>

Changelog

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

Maintainers

Blade Mage Icons is developed and maintained by Anodyne Productions.

License

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