clickfwd / blade-icons

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

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Blade Icons

Build Status Total Downloads Latest Stable Version License

Attention all users! I've recently taken over Adam's Blade SVG package and have rewritten it to be the new foundation for Blade Icons. Please read the PR here: blade-ui-kit/blade-icons#50

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

Heroicons and Zondicons originally made by Steve Schoger and Adam Wathan.

List of icons

Requirements

  • PHP 7.4 or higher
  • Laravel 7.0 or higher

Installation

composer require driesvints/blade-icons

Updating

General steps for every update:

  • Run php artisan view:clear
  • If you published the raw icons run php artisan vendor:publish --tag=blade-icons --force

When upgrading to a new major version of the library, remember to read the upgrade guide.

Usage

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

<x-heroicon-o-adjustments/>

You can also pass classes to your icon components:

<x-heroicon-o-adjustments class="w-6 h-6 text-gray-500"/>

And even use inline styles:

<x-heroicon-o-adjustments style="color: #555"/>

The solid icons can be referenced like this:

<x-heroicon-s-adjustments/>

Zondicon icons can be referenced like:

<x-zondicon-add-outline/>

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

Then use them in your views like:

<img src="{{ asset('vendor/blade-icons/heroicons/heroicon-o-adjustments.svg') }}" width="10" height="10"/>

And use zondicons like:

<img src="{{ asset('vendor/blade-icons/zondicons/zondicon-add-outline.svg') }}" width="10" height="10"/>

Changelog

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

License

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

About

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

License:MIT License


Languages

Language:HTML 92.6%Language:PHP 6.3%Language:Shell 1.2%