README

A Laravel package for easy use of the wonderful iconic.app icon set in blade, svg, or png.

Requirements

• PHP 7.4 or higher
• Laravel 7.0 or higher

Installation

You can install the package via composer, this will give you access to the blade components:

composer require adzchappers/iconicapp-for-laravel

If you want to use the SVG or PNG files directly, you'll need to publis them directly.

All Files

php artisan vendor:publish --provider="AdzChappers\IconicappForLaravel\ServiceProvider" --force

SVG Files

php artisan vendor:publish --provider="AdzChappers\IconicappForLaravel\ServiceProvider" --tag=iconic-svg --force

All PNG Files

php artisan vendor:publish --provider="AdzChappers\IconicappForLaravel\ServiceProvider" --tag=iconic-png --force

Black PNG Files

php artisan vendor:publish --provider="AdzChappers\IconicappForLaravel\ServiceProvider" --tag=iconic-png-black --force

White PNG Files

php artisan vendor:publish --provider="AdzChappers\IconicappForLaravel\ServiceProvider" --tag=iconic-png-white --force

Updating

General steps for every update:

• Run php artisan view:clear
• If you published the raw icons run one of the above installations commands, eg php artisan vendor:publish --provider="AdzChappers\IconicappForLaravel\ServiceProvider" --force

Usage

Iconic icons can be used with a self-closing Blade component, which will be compiled to an SVG:

<x-iconic-announcement />

You can also pass a class, style, or stroke color (any or all) into the component:

<x-iconic-announcement class="w-6 h-6" style="margin-bottom: 10px" stroke="#555"/>

The icons can also be used in their raw format (svg, or png)

<img src="{{ asset('vendor/iconic/svg/announcement.svg') }}" width="24" height="24"/>

<img src="{{ asset('vendor/iconic/png/white/announcement.png') }}" width="24" height="24"/>

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• AdzChappers
• All Contributors

License

The MIT License (MIT). Please see License File for more information.