README.ru.md

FontAwesome PHP Helper

English

Описание

Пакет предназначен для генерации CSS-классов и HTML-кода иконок FontAwesome 6. Кроме того, доступны следующие функции:

• добавление цвета иконок
• изменение размера иконок
• поддержка как современных (fa-solid fa-), так и устаревших классов (fas fa-)
• использование фиксированной ширины иконок (fa-fw) для отображения в списках
• опциональное добавление атрибута aria-hidden="true" для скрытия иконок от программ чтения с экрана и т. п.
• получение CSS-класса случайной иконки
• коллекция CSS-классов всех иконок

Установка

composer require bugo/fa-php-helper

Использование

Если нужны только классы:

<?php

use Bugo\FontAwesome\Enums\Icon;

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

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

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

Расширенный пример:

<?php

use Bugo\FontAwesome\Enums\Icon;

$icon = Icon::V5->brand('windows');

// 'fab fa-windows fa-fw text-red-500'
var_dump(
    $icon
        ->fixedWidth()
        ->color('text-red-500')
        ->text()
);

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

// '<i class="fa-solid fa-user fa-2xl" style="color:red" title="Пользователь" aria-hidden="true"></i>'
var_dump(
    $icon
        ->color('red')
        ->size('2xl')
        ->title('Пользователь')
        ->ariaHidden()
        ->html()
);

Дополнительные классы можно передать через метод addClass:

<?php

use Bugo\FontAwesome\Enums\Icon;

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

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

Кроме того, доступно получение случайной иконки:

<?php

use Bugo\FontAwesome\Enums\Icon;

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

А так можно получить всю коллекцию со всеми классами сразу:

<?php

use Bugo\FontAwesome\Enums\Icon;

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