README

Installation

You can install the package via composer:

composer require erikgaal/blade-streamline-icons

You can publish the config file with:

php artisan vendor:publish --tag="blade-streamline-icons-config"

This is the contents of the published config file:

return [
    'prefix' => 'streamline',

    'path' => resource_path('icons/streamline'),

    /*
     * Define any aliases for families here.
     */
    'family_aliases' => [
        'core-line' => 'streamline-mini-line',
        'core' => 'core-free',
        'flex' => 'flex-free',
        'plump' => 'plump-free',
        'sharp' => 'sharp-free',
    ]
];

You must login to the Streamline API with:

php artisan streamline-icons:login

Usage

Retrieve icons from Streamline with:

php artisan streamline-icons:save core-line interface-home-1
#                                     ▲            ▲
#                                     │            └──── icon
#                                     └──── family                    

# Alternatively, output in terminal.
php artisan streamline-icons:get core-line interface-home-1

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

<x-streamline-core-line-interface-home-1/>

You can also pass classes to your icon components:

<x-streamline-core-line-interface-home-1 class="w-6 h-6 text-gray-500"/>

And even use inline styles:

<x-streamline-core-line-interface-home-1 style="color: #555"/>

Or use the @svg directive:

@svg('streamline-core-line-interface-home-1', 'w-6 h-6', ['style' => 'color: #555'])

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

License

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

erikgaal / blade-streamline-icons

Maintainers

Details