Skip to content

Latest commit

 

History

History
106 lines (69 loc) · 3.37 KB

README.md

File metadata and controls

106 lines (69 loc) · 3.37 KB
Raw

Blade Majestic Icons

Tests Latest Stable Version Total Downloads

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

For a full list of available icons see the SVG directory or preview them at majesticons.netlify.app.

Requirements

  • PHP 7.4 or higher
  • Laravel 8.0 or higher

Installation

composer require codeat3/blade-majestic-icons

Updating

Please refer to the upgrade guide when updating the library.

Note

When you upgrade to 2.0 of this package, most of the icons which were available in 1.0 won't be available. This is due to the deletion of icons in the original repository. Kindly make note of it. The commit can be found on the original repo at this link with the commit description as initial commit for v2

Blade Icons

Blade Majestic 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 Majestic 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-majestic-icons.php config file:

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

Usage

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

<x-majestic-cookie-line/>

You can also pass classes to your icon components:

<x-majestic-cookie-line class="w-6 h-6 text-gray-500"/>

And even use inline styles:

<x-majestic-cookie-line style="color: #555"/>

The solid icons can be referenced like this by using suffix -solid:

<x-majestic-cookie-solid/>

The line icons can be referenced like this by using suffix -line:

<x-majestic-cookie-line/>

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

Then use them in your views like:

<img src="{{ asset('vendor/blade-majestic-icons/cookie-line.svg') }}" width="10" height="10"/>

Changelog

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

Maintainers

Blade Majestic Icons is developed and maintained by Swapnil Sarwe.

License

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