README

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

This package contains the 1,100+ free Iconsax V2 icons in up to 6 different styles, a total of 6,900+ icons. For a full list of available icons see the SVG directory or browse them at https://iconsax.io.

Requirements

PHP 8.0 or higher
Laravel 9.0 or higher

Installation

composer require saade/blade-iconsax

Updating

The major version of this package follows the major version of Iconsax. Version 2 ships the Iconsax V2 set, which renamed and removed icons from V1: the CHANGELOG lists every one of them.

Blade Icons

Blade Iconsax 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 Iconsax 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-iconsax.php config file:

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

Usage

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

<x-iconsax-bol-airdrop/>

You can also pass classes to your icon components:

<x-iconsax-bol-airdrop class="w-6 h-6 text-gray-500"/>

And even use inline styles:

<x-iconsax-bol-airdrop style="color: #555"/>

Most icons have 6 variants:

Bold icons

<x-iconsax-bol-airdrop/>

Broken icons

<x-iconsax-bro-airdrop/>

Bulk icons

<x-iconsax-bul-airdrop/>

Linear icons

<x-iconsax-lin-airdrop/>

Outline icons

<x-iconsax-out-airdrop/>

Twotone icons

<x-iconsax-two-airdrop/>

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-iconsax --force

Then use them in your views like:

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

Syncing icons

The icons are generated from the official iconsax npm package. A scheduled workflow opens a pull request whenever a new version changes them. To run it locally:

npm install --save-dev --save-exact iconsax@latest
npm run sync

Changelog

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

Maintainers

Blade Iconsax is developed and maintained by Saade.

License

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

saade / blade-iconsax

Package info

Security

Fund package maintenance!

Statistics