rmrevin/yii2-fontawesome Asset Bundle for Yii2 with Font Awesome

fontawesomeassetbundle

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.

License Latest Stable Version Latest Unstable Version Total Downloads

Code Status

Scrutinizer Code Quality Code Coverage Travis CI Build Status Dependency Status

Support

Fontawesome version

Version of font Version of extension
4.* ~2.17
5.* ~3.0

Update to 3.2

Be careful in version 3.2 rmrevin\yii\fontawesome\AssetBundle package use cdn by default. More in the changelog.

Update to 3.0

Be careful in version 3.0 deprecated methods were removed. More in the changelog.

Update to 2.17

Be careful in version 2.17 deprecated methods were removed. More in the changelog.

Installation

The preferred way to install this extension is through composer.

Either run

composer require "rmrevin/yii2-fontawesome:~3.2"

or add

"rmrevin/yii2-fontawesome": "~3.2",

to the require section of your composer.json file.

Usage with fa pro version

CDN

Register your domain here - https://fontawesome.com/how-to-use/on-the-web/setup/getting-started

Add CdnProAssetBundle as depends of your app asset bundle:

class AppAsset extends AssetBundle
{
    // ...

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

Or inject CdnProAssetBundle in your view:

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

NPM

Install npm package of font:

npm install @fortawesome/fontawesome-pro

or

yarn add @fortawesome/fontawesome-pro

And add NpmProAssetBundle as depends of your app asset bundle:

class AppAsset extends AssetBundle
{
    // ...

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

Or inject NpmProAssetBundle in your view:

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

Usage with fa free version

CDN

Add CdnFreeAssetBundle as depends of your app asset bundle:

class AppAsset extends AssetBundle
{
    // ...

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

Or inject CdnFreeAssetBundle in your view:

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

NPM

Install npm package of font:

npm install @fortawesome/fontawesome-free

or

yarn add @fortawesome/fontawesome-free

And add NpmFreeAssetBundle as depends of your app asset bundle:

class AppAsset extends AssetBundle
{
    // ...

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

Or inject NpmFreeAssetBundle in your view:

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

Class reference

Namespace: rmrevin\yii\fontawesome;

Class FAB, FAL, FAR, FAS or FontAwesome

  • static FAR::icon($name, $options=[]) - Creates an component\Icon that can be used to FontAwesome html icon
    • $name - name of icon in font awesome set.
    • $options - additional attributes for i.fa html tag.
  • static FAR::stack($name, $options=[]) - Creates an component\Stack that can be used to FontAwesome html icon
    • $options - additional attributes for span.fa-stack html tag.

Class component\Icon

  • (string)$Icon - render icon
  • $Icon->addCssClass($value) - add to html tag css class in $value
    • $value - name of css class
  • $Icon->inverse() - add to html tag css class fa-inverse
  • $Icon->spin() - add to html tag css class fa-spin
  • $Icon->fixedWidth() - add to html tag css class fa-fw
  • $Icon->ul() - add to html tag css class fa-ul
  • $Icon->li() - add to html tag css class fa-li
  • $Icon->border() - add to html tag css class fa-border
  • $Icon->pullLeft() - add to html tag css class pull-left
  • $Icon->pullRight() - add to html tag css class pull-right
  • $Icon->size($value) - add to html tag css class with size
    • $value - size value (variants: FA::SIZE_LARGE, FA::SIZE_2X, FA::SIZE_3X, FA::SIZE_4X, FA::SIZE_5X)
  • $Icon->rotate($value) - add to html tag css class with rotate
    • $value - rotate value (variants: FA::ROTATE_90, FA::ROTATE_180, FA::ROTATE_270)
  • $Icon->flip($value) - add to html tag css class with rotate
    • $value - flip value (variants: FA::FLIP_HORIZONTAL, FA::FLIP_VERTICAL)

Class component\Stack

  • (string)$Stack - render icon stack
  • $Stack->icon($icon, $options=[]) - set icon for stack
    • $icon - name of icon or component\Icon object
    • $options - additional attributes for icon html tag.
  • $Stack->icon($icon, $options=[]) - set background icon for stack
    • $icon - name of icon or component\Icon object
    • $options - additional attributes for icon html tag.

Helper examples

use rmrevin\yii\fontawesome\FAS;
// or (only in pro version https://fontawesome.com/pro)
// use rmrevin\yii\fontawesome\FAR;
// use rmrevin\yii\fontawesome\FAL;
// use rmrevin\yii\fontawesome\FAB;

// normal use
echo FAS::icon('home'); // <i class="fas fa-home"></i>

// shortcut
echo FAS::i('home'); // <i class="fas fa-home"></i>

// icon with additional attributes
echo FAS::icon(
    'arrow-left', 
    ['class' => 'big', 'data-role' => 'arrow']
); // <i class="big fas fa-arrow-left" data-role="arrow"></i>

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

// icon with additional methods
echo FAS::icon('cog')->inverse();    // <i class="fas fa-cog fa-inverse"></i>
echo FAS::icon('cog')->spin();       // <i class="fas fa-cog fa-spin"></i>
echo FAS::icon('cog')->fixedWidth(); // <i class="fas fa-cog fa-fw"></i>
echo FAS::icon('cog')->li();         // <i class="fas fa-cog fa-li"></i>
echo FAS::icon('cog')->border();     // <i class="fas fa-cog fa-border"></i>
echo FAS::icon('cog')->pullLeft();   // <i class="fas fa-cog pull-left"></i>
echo FAS::icon('cog')->pullRight();  // <i class="fas fa-cog pull-right"></i>

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

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

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

// icon with multiple methods
echo FAS::icon('cog')
        ->spin()
        ->fixedWidth()
        ->pullLeft()
        ->size(FAS::SIZE_LARGE);
// <i class="fas fa-cog fa-spin fa-fw pull-left fa-size-lg"></i>

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

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

// Stacking text and icons
echo FAS::stack()
     ->on(FAS::Icon('square'))
     ->text('1');
// <span class="fa-stack">
//   <i class="fas fa-square fa-stack-2x"></i>
//   <span class="fa-stack-1x">1</span>
// </span>

// Stacking text and icons with options
echo FAS::stack()
     ->on(FAS::Icon('square'))
     ->text('1', ['tag'=>'strong', 'class'=>'stacked-text']);
// <span class="fa-stack">
//   <i class="fas fa-square fa-stack-2x"></i>
//   <strong class="stacked-text fa-stack-1x">1</strong>
// </span>
// Now you can add some css for vertical text positioning:
.stacked-text { margin-top: .3em; }

// unordered list icons 
echo FAS::ul(['data-role' => 'unordered-list'])
     ->item('Bullet item', ['icon' => 'circle'])
     ->item('Checked item', ['icon' => 'check']);
// <ul class="fa-ul" data-role="unordered-list">
//   <li><i class="fas fa-circle fa-li"></i>Bullet item</li>
//   <li><i class="fas fa-check fa-li"></i>Checked Item</li>
// </span>

// autocomplete icons name in IDE
echo FAS::icon(FAS::_COG);
echo FAS::icon(FAS::_DESKTOP);
echo FAS::stack()
     ->on(FAS::_CIRCLE_O)
     ->icon(FAS::_TWITTER);

Changelog

2018-09-17 - 3.2.0

  • Font Awesome updated to version 5.3.1.
  • Add text stacking function.
  • Refactoring of asset bundles.
  • Remove bower-asset from composer.json
  • These classes are now deprecated:
    • rmrevin\yii\fontawesome\AssetBundle
    • rmrevin\yii\fontawesome\cdn\AssetBundle
  • Update readme.
  • Update tests.

2018-07-11 - 3.1.0

  • Remove static font awesome bundle and add composer bower-asset/font-awesome.
  • Font Awesome updated to version 5.1.

2018-04-01 - 3.0.0

  • Font Awesome updated to version 5.0.
  • These class are now deprecated:
    • rmrevin\yii\fontawesome\FA use ...\fontawesome\FAB, ...\fontawesome\FAL, ...\fontawesome\FAR, ...\fontawesome\FAS.
  • These deprecated properties and methods are now removed:
    • rmrevin\yii\fontawesome\component\Icon::$defaultTag
    • rmrevin\yii\fontawesome\component\Icon::$tag
    • rmrevin\yii\fontawesome\component\Icon::tag()
    • rmrevin\yii\fontawesome\component\Icon::render()
    • rmrevin\yii\fontawesome\component\Stack::$defaultTag
    • rmrevin\yii\fontawesome\component\Stack::$tag
    • rmrevin\yii\fontawesome\component\Stack::tag()
    • rmrevin\yii\fontawesome\component\Stack::render()
    • rmrevin\yii\fontawesome\component\UnorderedList::$defaultTag
    • rmrevin\yii\fontawesome\component\UnorderedList::$tag
    • rmrevin\yii\fontawesome\component\UnorderedList::tag()
    • rmrevin\yii\fontawesome\component\UnorderedList::render()
    • rmrevin\yii\fontawesome\FA::getConstants()

2017-01-11 - 2.17.1

  • Downgrade minimum php to 5.4

2016-10-25 - 2.17.0

  • Font Awesome updated to version 4.7.
  • Update minimum php to 5.5
  • These deprecated classes are now removed:
    • rmrevin\yii\fontawesome\CDNAssetBundle
  • These deprecated methods are now removed:
    • rmrevin\yii\fontawesome\component\Icon::ul
    • rmrevin\yii\fontawesome\component\Icon::fixed_width
    • rmrevin\yii\fontawesome\component\Icon::pull_left
    • rmrevin\yii\fontawesome\component\Icon::pull_right
  • In method rmrevin\yii\fontawesome\component\UnorderedList::item changed interface (removed $icon param).
  • These directories are now deprecated:
    • ./assets
  • These fields and methods are now deprecated:
    • rmrevin\yii\fontawesome\component\Icon::$defaultTag
    • rmrevin\yii\fontawesome\component\Icon::$tag
    • rmrevin\yii\fontawesome\component\Icon::tag()
    • rmrevin\yii\fontawesome\component\Icon::render()
    • rmrevin\yii\fontawesome\component\Stack::$defaultTag
    • rmrevin\yii\fontawesome\component\Stack::$tag
    • rmrevin\yii\fontawesome\component\Stack::tag()
    • rmrevin\yii\fontawesome\component\Stack::render()
    • rmrevin\yii\fontawesome\component\UnorderedList::$defaultTag
    • rmrevin\yii\fontawesome\component\UnorderedList::$tag
    • rmrevin\yii\fontawesome\component\UnorderedList::tag()
    • rmrevin\yii\fontawesome\component\UnorderedList::render()
  • Refactoring class rmrevin\yii\fontawesome\component\UnorderedList.

2016-08-31 - 2.16.1

  • Fix options in li item.
  • Update readme.

2016-08-31 - 2.16.0

  • Enh #22: Added FA:ul() method.
  • Refactoring.

2016-08-19 - 2.15.2

  • Update icon name constants to version 4.6.3.

2016-05-29 - 2.15.1

  • Added option to skip the icon.
  • Added option to change the order of icons in the stack.

2016-05-22 - 2.15.0

  • Remove bower package.

2016-04-16 - 2.14.0

  • Font Awesome updated to version 4.6.

2015-11-26 - 2.13.0

  • Font Awesome updated to version 4.5.

2015-11-20 - 2.12.2

  • Add shortcuts methods i() for FA::icon() and FA::s() for FA::stack()
  • Update readme

2015-11-09 - 2.12.1

  • Variable FA::$cssPrefix transferred to the class FontAwesome.
  • Refactoring.
  • Update tests.

2015-08-15 - 2.12.0

  • Font Awesome updated to version 4.4.

2015-06-29 - 2.11.0

  • Added the ability to change the tag for icons.

2015-06-23 - 2.10.3

  • Change cnd url to cloudflare.

2015-06-19 - 2.10.2

  • CDNAssetBundle is now deprecated. Use rmrevin\yii\fontawesome\cdn\AssetBundle.
  • Refactoring.

2015-05-09 - 2.10.1

  • Fix bug in tests.

2015-05-09 - 2.10.0

  • Add CDN asset bundle CDNAssetBundle.
  • Composer package fortawesome/font-awesome replaced on bower package bower-asset/fontawesome.
  • Adding warning messages in deprecated methods.
  • Add changelog.
  • Refactoring.
  • Update readme.

2015-04-28 - 2.9.2

  • Method icon()->fixed_width() is deprecated. Use instead icon()->fixedWidth().
  • Method icon()->pull_left() is deprecated. Use instead icon()->pullLeft().
  • Method icon()->pull_right() is deprecated. Use instead icon()->pullRight().
  • Updated tests.

2015-04-08 - 2.9.1

  • Fix asset bundle publish bug on windows.

2015-03-31 - 2.9.0

  • In asset bundle added init method for filtering publising assets.

2015-03-17 - 2.8.2

  • Refactoring.

2015-03-16 - 2.8.1

  • Update readme.

2015-03-16 - 2.8.0

  • In class FA add static property cssPrefix for customizing css class.
  • Refactoring.
  • Update readme.

2015-02-08 - 2.7.1

  • Update travisCI config.

2015-01-26 - 2.7.0

  • Font Awesome updated to version 4.3.
  • Update icons constants list.
  • Update readme.

Until 2015-03-04

  • Implementation of extension.

Statistics

Downloads
GitHub Stars
GitHub Forks

Releases

Comments



3.2.0 is the latest of 52 releases



MIT license
Stats
139 github stars & 40 github forks
1173 downloads in the last day
26241 downloads in the last 30 days
666123 total downloads