2zt/blade-cssgg

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

1.0.1 2021-09-30 09:12 UTC

This package is auto-updated.

Last update: 2024-10-29 06:12:54 UTC


README

Blade css.gg Icons

Tests GitHub license Latest Stable Version Total Downloads Twitter

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

If you don't know css.gg, it is a set of 700+ Pure CSS, SVG & Figma UI Icons Available in SVG Sprite, styled-components, NPM & API. For a complete list of the 700+ available icons included in this package, see the SVG directory or preview them at css.gg.

Requirements

  • PHP 7.4 or higher
  • Laravel 8.0 or higher

Installation

composer require 2zt/blade-cssgg

Updating

Please refer to the upgrade guide when updating the library.

Blade Icons

Blade css.gg 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 css.gg 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-cssgg.php config file:

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

Usage

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

<x-gg-globe/>

You can also pass classes to your icon components:

<x-gg-globe class="w-6 h-6 text-gray-500"/>

And even use inline styles:

<x-gg-globe style="color: #555"/>

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

Then use them in your views like:

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

Changelog

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

Maintainers

Blade css.gg is developed and maintained by 2zt.

Credit

css.gg is originally made by Astrit Malsia.

Support the author of css.gg :

License

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