grupoperis/icons

A custom icon collection for internal usage.

v1.2.0 2024-02-15 12:55 UTC

Requires

• php: ^8.2
• blade-ui-kit/blade-icons: ^1.4
• illuminate/support: ^10.0

Requires (Dev)

• laravel/pint: ^1.13
• orchestra/testbench: ^8.0
• phpunit/phpunit: ^10.0

MIT

• Sergio Peris

• icons
• Grupo Peris

README

Requirements

• PHP 8.2 or higher
• Laravel 10.0 or higher

Installation

composer require grupoperis/icons

Blade Icons

Grupo Peris 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

Grupo Peris 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 icons.php config file:

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

Usage

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

<x-icon-home/>

You can also pass classes to your icon components:

<x-icon-home class="w-6 h-6 text-gray-500"/>

And even use inline styles:

<x-icon-home style="color: #555"/>

The solid icons can be referenced like this:

<x-icon-home/>