rsmike/fa

The best Font Awesome helper library for PHP

PHP Font awesome

Awesome PHP Font Awesome library., _(*1)

Includes PHPDoc autocomplete supported by most IDEs., _(*2)

Usage

Icon only

echo FA::check(); generates <i class="fa fa-check>, _(*3)

Icon with wording

echo FA::check('Submit'); generates <i class="fa fa-check> Submit, _(*4)

Note a space between icon and wording., _(*5)

Caveat: if your wording is basically a number, you should explicitly convert it to string first, e.g. FA::briefcase((string)$id). Otherwise, number value will be parsed as options parameter., _(*6)

Icon with additional padding class

echo FA::check('Submit')->pad(); generates <i class="fa fa-check fa-pad>Submit, _(*7)

Instead of space between icon and wording, this adds a "fa-pad" padding class for the icon. This is especially useful inside links as the space character between icon and text shouldn't be underlined on hover. The class is non-standard and should be styled separately. Example:, _(*8)

.fa.fa-pad:after {
    content: " ";
    display: inline-block;
    width: 0.4em;
}

The pad() function can be replaced by FA::FA_PAD option., _(*9)

Icon with options

echo FA::check(FA::FA_BORDER | FA::FA_FLIP_H); generates <i class="fa fa-check fa-border fa-flip-horizontal>, _(*10)

Possible options are: FA_PULL_LEFT, FA_PULL_RIGHT, FA_SIZE_LG, FA_SIZE_2X, FA_SIZE_3X, FA_SIZE_4X, FA_SIZE_5X, FA_FIX_WIDTH, FA_INVERSE, FA_BORDER, FA_SPIN, FA_PULSE, FA_ROT90, FA_ROT180, FA_ROT270, FA_FLIP_V, FA_FLIP_H;, _(*11)

Icon with wording and options

echo FA::check('Submit', FA::FA_ROT90);, _(*12)

Options should go as a second parameter. If the first parameter is not a string, it considered to be options and the second parameter is ignored., _(*13)

Icon with additional custom class

echo FA::check('Submit', FA::FA_ROT90)->class('text-danger my-class'); generates <i class="fa fa-check fa-rotate-90 text-danger my-class"></i> Submit, _(*14)

Class applies to the icon itself (not the wording), _(*15)

Icon with Bootstrap-compatible tooltip

echo FA::exclamation_triangle()->tooltip('Data not verified'); generates <i class="fa fa-exclamation-triangle" data-toggle="tooltip" title="Data not verified"></i>, _(*16)

Icon with additional CSS style

echo FA::check()->css('margin-left: 20px'); generates <i class="fa fa-check" style="margin-left: 20px"></i>, _(*17)

Applying modifiers after construction

echo FA::check('Submit')->mod(FA::FA_ROT90); generates <i class="fa fa-check fa-rotate-90"></i> Submit, _(*18)

Using icon as an object

$ok = FA::check();
$ko = clone $ok;

$ok->class('text-danger');
$ko->mod(FA_FLIP_H);

echo $ok, $ko;

Installation

Either run, _(*19)

$ composer require rsmike/fa:~1.0

or add, _(*20)

"rsmike/fa": "~1.0"

to the require section of your composer.json file., _(*21)

"fortawesome/font-awesome" package is a dependency and will be installed automatically., _(*22)

Changelog

v1.4

• Setting any additional attribute via "att" method
• Custom tooltip position and container
• style() renamed to css()

v1.2

• Custom padding class for use inside links instead of space symbol

v1.1

• Bootstrap tooltip functionality

v1.0

• Initial public version
• FA icons 4.7

TODO

• stacking support
• list icons