README

About

A simple and lightweight SVG icon package for Laravel.

Author

Sina Zangiband

Contact

Step 1: Install via Composer

Run the following command in your terminal:

composer require teksite/icon-laravel

Laravel 5.x and earlier

If you are using Laravel 5.x or earlier, register the service provider in the config/app.php file under the providers array:

'providers' => [
    // Other Service Providers
    Teksite\IconLaravel\IconLaravelServiceProvider::class,
];

Note: This step is not required for newer versions of Laravel (5.x and above).

Usage

Step 2: Create Blade Component

Create a blade component file named icon.blade.php in resources/views/components/ directory.

Add the following content:

<svg x="{{$x}}" y="{{$y}}" width="{{$width}}" height="{{$height}}" viewBox="{{$viewbox}}" {{$attributes->merge(['class'=>'tkicon '.$icon]) }} data-icon="{{$icon}}" stroke-width="{{$strokeWidth}}" stroke-linecap="{{$strokeLinecap}}" stroke-linejoin="{{$strokeLinejoin}}">
   {{ $title && strlen($title) ? "<title>$itlte</title>" : '' }}
    {!! $path !!}
</svg>

Step 3: Use in Blade Template

<x-icon icon="example" class="stroke-red-600 fill-none" />

Custom Icons

You can add your own SVG icons by creating a JSON file at:

storage_path('app/svg-icons/outline.json') --> for outline svg icons storage_path('app/svg-icons/solid.json') --> for solid svg icons

Tip: Only save the path tags inside the JSON file.

Example custom.json:

[ {"name": ""}, {"name": ""} ]

Configuration

You can change the default paths and settings by publishing the config file:

php artisan vendor:publish --provider="Teksite\IconLaravel\IconLaravelServiceProvider"

Then edit config/icon-laravel.php.

Support

Feel free to reach out if you have any questions or need assistance with this package.

teksite / icon-laravel

Maintainers

Package info

Statistics

Security