README

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

For a full list of available icons see the SVG directory or preview them on the web.

Requirements

PHP 8.1 or higher
Laravel 9.0 or higher

Installation

composer require anodyne/blade-disarto-icons

Usage

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

<x-disarto-alert-triangle />

You can also pass classes to your icon components:

<x-disarto-alert-triangle class="size-6 text-gray-500"/>

And even use inline styles:

<x-disarto-alert-triangle 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-disarto-icons --force

Then use them in your views like:

<img src="{{ asset('vendor/blade-disarto-icons/alert-triangle.svg') }}" width="24" height="24"/>

Blade Icons

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

Enum

Blade Disarto Icons includes an enum that maps every icon to an enum case. This allows for easily referencing specific icons from PHP. This is also helpful when using Disarto Icons with a system like Filament for referencing icons.

use Anodyne\DisartoIcons\DisartoIcon;

svg(DisartoIcon::AlertTriangle->value);
svg(DisartoIcon::AlertTriangleSolid->value);

Testing

Install PHP and JavaScript development dependencies before running the Pest suite:

composer install
bun install
composer test

Tests cover the compiler in temporary directories, reproducibility of all generated assets, enum coverage, SVG validity, Blade rendering, and asset publishing.

Changelog

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

Maintainers

Blade Disarto Icons was developed by Anodyne Productions.

License

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

anodyne / blade-disarto-icons

Package info

Security

Statistics