README

Awesome PHP Font Awesome library.

Includes PHPDoc autocomplete supported by most IDEs.

Usage

Icon only

echo FA::check(); generates 

Icon with wording

echo FA::check('Submit'); generates  Submit

Note a space between icon and wording.

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.

Icon with additional padding class

echo FA::check('Submit')->pad(); generates Submit

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:
.fa.fa-pad:after {
    content: " ";
    display: inline-block;
    width: 0.4em;
}

The pad() function can be replaced by FA::FA_PAD option.

Icon with options

echo FA::check(FA::FA_BORDER | FA::FA_FLIP_H); generates 

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;

Icon with wording and options

echo FA::check('Submit', FA::FA_ROT90);

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.

Icon with additional custom class

echo FA::check('Submit', FA::FA_ROT90)->class('text-danger my-class'); generates  Submit

Class applies to the icon itself (not the wording)

Icon with Bootstrap-compatible tooltip

echo FA::exclamation_triangle()->tooltip('Data not verified'); generates 

Icon with additional CSS style

echo FA::check()->css('margin-left: 20px'); generates 

Applying modifiers after construction

echo FA::check('Submit')->mod(FA::FA_ROT90); generates  Submit

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

$ composer require rsmike/fa:~1.0

or add

"rsmike/fa": "~1.0"

to the require section of your composer.json file.

"fortawesome/font-awesome" package is a dependency and will be installed automatically.

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

rsmike / fa

Maintainers

Details