Yii 2 Font Awesome Asset Bundle

This extension provides a assets bundle with Font Awesome for Yii framework 2.0 applications and helper to use icons.

For license information check the LICENSE-file.

Code Status

Support

• GutHub issues
• Public chat

Installation

The preferred way to install this extension is through composer.

Either run

composer require "rmrevin/yii2-fontawesome:2.12.*"

or add

"rmrevin/yii2-fontawesome": "2.10.*",

to the require section of your composer.json file.

Usage

In view

rmrevin\yii\fontawesome\AssetBundle::register($this);

or as dependency in your main application asset bundle

class AppAsset extends AssetBundle
{
	// ...

	public $depends = [
		// ...
		'\rmrevin\yii\fontawesome\AssetBundle'
	];
}

Helper

use rmrevin\yii\fontawesome\FA;

echo FA::Icon('home'); // <i class="fa fa-home"></i>
echo FA::Icon(
    'arrow-left', 
    ['class' => 'big', 'data-role' => 'arrow']
); // <i class="big fa fa-arrow-left" data-role="arrow"></i>

echo Html::submitButton(
    Yii::t('app', '{icon} Save', ['icon' => FA::Icon('check')])
); // <button type="submit"><i class="fa fa-check"></i> Save</button>

echo FA::Icon('cog')->inverse();    // <i class="fa fa-cog fa-inverse"></i>
echo FA::Icon('cog')->spin();       // <i class="fa fa-cog fa-spin"></i>
echo FA::Icon('cog')->fixedWidth(); // <i class="fa fa-cog fa-fw"></i>
echo FA::Icon('cog')->ul();         // <i class="fa fa-cog fa-ul"></i>
echo FA::Icon('cog')->li();         // <i class="fa fa-cog fa-li"></i>
echo FA::Icon('cog')->border();     // <i class="fa fa-cog fa-border"></i>
echo FA::Icon('cog')->pullLeft();   // <i class="fa fa-cog pull-left"></i>
echo FA::Icon('cog')->pullRight();  // <i class="fa fa-cog pull-right"></i>

echo FA::Icon('cog')->size(FA::SIZE_3X);
// values: FA::SIZE_LARGE, FA::SIZE_2X, FA::SIZE_3X, FA::SIZE_4X, FA::SIZE_5X
// <i class="fa fa-cog fa-size-3x"></i>

echo FA::Icon('cog')->rotate(FA::ROTATE_90); 
// values: FA::ROTATE_90, FA::ROTATE_180, FA::ROTATE_180
// <i class="fa fa-cog fa-rotate-90"></i>

echo FA::Icon('cog')->flip(FA::FLIP_VERTICAL); 
// values: FA::FLIP_HORIZONTAL, FA::FLIP_VERTICAL
// <i class="fa fa-cog fa-flip-vertical"></i>

echo FA::Icon('cog')
        ->spin()
        ->fixedWidth()
        ->pullLeft()
        ->size(FA::SIZE_LARGE);
// <i class="fa fa-cog fa-spin fa-fw pull-left fa-size-lg"></i>

echo FA::stack()
        ->Icon('twitter')
        ->on('square-o');
// <span class="fa-stack">
//   <i class="fa fa-square-o fa-stack-2x"></i>
//   <i class="fa fa-twitter fa-stack-1x"></i>
// </span>

echo FA::stack(['data-role' => 'stacked-icon'])
     ->on(FA::Icon('square')->inverse())
     ->icon(FA::Icon('cog')->spin());
// <span class="fa-stack" data-role="stacked-icon">
//   <i class="fa fa-square-o fa-inverse fa-stack-2x"></i>
//   <i class="fa fa-cog fa-spin fa-stack-1x"></i>
// </span>

// autocomplete icons name in IDE
echo FA::Icon(FA::_COG);
echo FA::Icon(FA::_DESKTOP);
echo FA::stack()
     ->on(FA::Icon(FA::_SQUARE)->inverse())
     ->Icon(FA::Icon(FA::_COG)->spin());

Set another prefix

FA::$cssPrefix = 'awf';

echo FA::Icon('home');
// <i class="awf awf-home"></i>
echo FA::Icon('cog')->inverse();
// <i class="awf awf-cog awf-inverse"></i>