mallardduck/blade-boxicons

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

2.3.0 2022-07-08 16:51 UTC

README

A package to easily make use of Boxicons in your Laravel Blade views. The current release is based on Boxicons 2.0.7.

For a full list of available icons see the SVG directory or preview them at boxicons.com. Boxicons are originally developed by Atisa.

A message to Russian 🇷🇺 people

If you currently live in Russia, please read this message.

Requirements

  • PHP 7.4 or higher
  • Laravel 8.0 or higher

Installation

composer require mallardduck/blade-boxicons

See on: Packagist

Usage

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

<x-bx-check-shield/>

You can also pass classes to your icon components:

<x-bx-check-shield class="w-6 h-6 text-gray-500"/>

And even use inline styles:

<x-bx-check-shield style="color: #555"/>

The solid icons can be referenced like this:

<x-bxs-check-shield/>

The logo icons can be referenced like this:

<x-bxl-github/>

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

Then use them in your views like:

<img src="{{ asset('vendor/blade-boxicons/regular/check-shield.svg') }}" width="10" height="10"/>

Blade Icons

Blade Boxicons uses Blade Icons under the hood. Please refer to the Blade Icons readme for additional functionality.

Changelog

Check out the CHANGELOG for all the recent changes.

Maintainers

This version of Blade Boxicons has been adopted by Dan Pock.
Tho the original Blade Boxicons was originally developed and maintained by João Oliveira.

Blade Icons is developed and maintained by Dries Vints.

License

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