/fa-php-helper

Helper for retrieving HTML code of Font Awesome icons

Primary LanguagePHPMIT LicenseMIT

FontAwesome PHP Helper

PHP Coverage

По-русски

Description

This package is designed to generate HTML code for FontAwesome 7 icons. The following features are available:

  • add icon colors
  • resize icons
  • support for both modern (fa-solid fa-) and deprecated (fas fa-) classes.
  • optionally add the aria-hidden="true" attribute to hide icons from screen readers, etc.
  • get CSS class of a random icon
  • collection of CSS classes of all icons

Installation

composer require bugo/fa-php-helper

Usage

If only CSS classes are needed:

<?php

use Bugo\FontAwesome\Enums\Icon;

// 'fa-solid fa-user'
echo Icon::V7->solid('user');

// 'fa-regular fa-user'
echo Icon::V7->regular('user');

// 'fa-brands fa-windows'
echo Icon::V7->brand('windows');

Advanced example:

<?php

use Bugo\FontAwesome\Enums\Icon;

$icon = Icon::V7->solid('user');

// '<i class="fa-solid fa-user fa-2xl" style="color:red" title="User" aria-hidden="true"></i>'
var_dump(
    $icon
        ->color('red')
        ->size('2xl')
        ->title('User')
        ->ariaHidden()
        ->html()
);

Additional classes can be passed through the addClass method:

<?php

use Bugo\FontAwesome\Enums\Icon;

$icon = Icon::V7->solid('heart');

// '<i class="fa-solid fa-heart fa-beat"></i>'
var_dump(
    $icon
        ->addClass('fa-beat')
        ->html()
);

You can also get a random icon:

<?php

use Bugo\FontAwesome\Enums\Icon;

var_dump(Icon::V7->random());

And so you can get the whole collection with all CSS classes at once:

<?php

use Bugo\FontAwesome\Enums\Icon;

var_dump(Icon::V7->collection());