anodyne/blade-fluentui-icons

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

1.1.236 2024-04-22 02:31 UTC

README

Tests Latest Stable Version Total Downloads

A package to easily make use of Fluent UI icons in your Laravel Blade views.

For a full list of available icons see the SVG directory.

Requirements

  • PHP 8.1 or higher
  • Laravel 9.0 or higher

Installation

composer require anodyne/blade-fluentui-icons

Blade Icons

Blade FluentUI 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 FluentUI 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-fluentui-icons.php config file:

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

Usage

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

<x-fluentui-o-access-time/>

You can also pass classes to your icon components:

<x-fluentui-o-access-time class="w-6 h-6 text-gray-500"/>

And even use inline styles:

<x-fluentui-o-access-time style="color: #555"/>

The filled icons can be referenced like this:

<x-fluentui-f-access-time/>

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

Then use them in your views like:

<img src="{{ asset('vendor/blade-fluentui-icons/f-access-time.svg') }}" width="10" height="10"/>
<img src="{{ asset('vendor/blade-fluentui-icons/o-access-time.svg') }}" width="10" height="10"/>

Changelog

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

Maintainers

Blade FluentUI icons is developed and maintained by Anodyne Productions.

License

Blade FluentUI icons is open-sourced software licensed under the MIT license.