codeat3/blade-phosphor-icons

A package to easily make use of "Phosphor Icons" in your Laravel Blade views.

2.2.0 2024-04-08 19:02 UTC

Requires

• php: ^7.4|^8.0
• blade-ui-kit/blade-icons: ^1.1
• illuminate/support: ^8.0|^9.0|^10.0|^11.0

Requires (Dev)

• codeat3/blade-icon-generation-helpers: ^0.8
• codeat3/phpcs-styles: ^1.0
• orchestra/testbench: ^6.0|^7.0|^8.0|^9.0
• phpunit/phpunit: ^9.0|^10.5|^11.0

MIT

• Swapnil Sarwe
• Dries Vints

• laravel
• blade
• phosphor-icons

README

Blade Phosphor Icons v2

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

For a full list of available icons see the SVG directory or preview them at phosphoricons.com.

Requirements

• PHP 7.4 or higher
• Laravel 8.0 or higher

Installation

For Phosphor Icons v1

composer require codeat3/blade-phosphor-icons:^1.0

For Phosphor Icons v2

composer require codeat3/blade-phosphor-icons:^2.0

Updating

Please refer to the upgrade guide when updating the library.

Blade Icons

Blade Phosphor 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 Phosphor 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-phosphor-icons.php config file:

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

Usage

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

<x-phosphor-alarm/>

You can also pass classes to your icon components:

<x-phosphor-alarm class="w-6 h-6 text-gray-500"/>

And even use inline styles:

<x-phosphor-alarm style="color: #555"/>

Or use the @svg directive:

@svg('phosphor-alarm', 'w-6 h-6', ['style' => 'color: #555'])

The 6 weights can be referenced like this:

<x-phosphor-alarm/>         <!-- Regular svg -->
<x-phosphor-alarm-bold/>    <!-- For bold svg icon add `-bold` suffix -->
<x-phosphor-alarm-duotone/> <!-- For duotone svg icon add `-duotone` suffix -->
<x-phosphor-alarm-fill/>    <!-- For fill svg icon add `-fill` suffix -->
<x-phosphor-alarm-light/>   <!-- For light svg icon add `-light` suffix -->
<x-phosphor-alarm-thin/>    <!-- For thin svg icon add `-thin` suffix -->

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

Then use them in your views like:

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

Blade Icons

Blade Phosphor Icons uses Blade Icons under the hood. Please refer to the Blade Icons readme for additional functionality.

Changelog

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

Maintainers

Blade Phosphor Icons is developed and maintained by Swapnil Sarwe.

License

Blade Phosphor Icons is open-sourced software licensed under the MIT license.