README

Blade File Type Icons

A package to easily make use of file-icon-vectors by Daniel Hendricks in your Laravel Blade views.

This package focuses on the vivid and square-o variations of file-icon-vectors as they are able to be made monochrome.

For a full list of available icons, see the SVG directory or the original repo.

Requirements

PHP 8.0 or higher
Laravel 9.0 or higher

Installation

$ composer require log1x/blade-filetype-icons

Blade Icons

Blade File Type Icons 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 File Type Icons 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-filetype-icons.php config file:

php artisan vendor:publish --tag=blade-filetype-icons-config

Usage

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

<x-filetype-v-exe />

You can also pass classes to your icon components:

<x-filetype-v-exe class="w-6 h-6 text-gray-500" />

And even use inline styles:

<x-filetype-v-exe style="color: #555" />

Or use the @svg directive:

@svg('filetype-v-exe', 'w-6 h-6', ['style' => 'color: #555'])

The square-o icons can be referenced like this:

<x-filetype-s-exe />

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

Then use them in your views like:

<img src="{{ asset('vendor/blade-filetype-icons/v-exe.svg') }}" width="10" height="10"/>

Bug Reports

If you discover a bug in Blade File Type Icons, please open an issue.

Contributing

Contributing whether it be through PRs, reporting an issue, or suggesting an idea is encouraged and appreciated.

License

Blade File Type Icons is provided under the MIT License.

log1x / blade-filetype-icons

Maintainers

Details