eduard9969/blade-polaris-icons

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

2.6.0 2024-04-08 14:57 UTC

Requires

• php: ^7.4|^8.0|^8.1|^8.2|^8.3
• 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.0

MIT

• Eduard Samoilenko

• shopify
• laravel
• blade
• polaris

README

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

For a full list of available icons see the SVG directory or preview them at shopify.com. Polaris Icons are originally developed by Shopify Team.

Requirements

• PHP 7.4 or higher
• Laravel 8.0 or higher

Installation

composer require eduard9969/blade-polaris-icons

Updating

Please refer to the upgrade guide when updating the library.

Blade Icons

Blade Polaris 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 Polaris 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-polaris-icons.php config file:

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

Usage

Icon name skeleton:

{icon-name}-icon.svg

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

<x-polaris-cart-abandoned-icon/>

You can also pass classes to your icon components:

<x-polaris-cart-abandoned-icon class="w-6 h-6 text-gray-500"/>

And even use inline styles:

<x-polaris-cart-abandoned-icon style="color: #555"/>

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

Then use them in your views like:

<img src="{{ asset('vendor/blade-polaris-icons/cart-abandoned-icon.svg') }}" width="10" height="10"/>

Changelog

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

Maintainers

Blade Polaris Icons is developed and maintained by Eduard Samoilenko.

License

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