cenotia/yii2-fa-icon-selector

Widgets to add fontAwesome icons to a model. For example, categories for posts.

dev-master 2017-01-03 09:43 UTC

This package is not auto-updated.

Last update: 2024-05-06 12:21:07 UTC


README

yii2-fa-icon-selector

This widget can be attached to a model attribute in order to associate a FontAwesome icon to it with optional orientation, size and color.

Prerequisite

This widget is a wrapper for Bootstrap IconPicker and concentrates only on the FontAwesome part and some of its helpers Font Awesome.

Installation

The preferred way to install FaiconSelector is through Composer. Either add the following to the require section of your composer.json file:

"cenotia/yii2-fa-icon-selector": "dev-master"

Or run:

$ php composer.phar require cenotia/yii2-fa-icon-selector "dev-master"

You can manually install FaiconSelector by downloading the source in ZIP-format.

Using FaiconSelector

FaiconSelector is a Yii 2.0 InputWidget. Like any other InputWidget it can be associated with a model and an attribute (or with a name and a value).

FaiconSelector is in namespace cenotia\components\faiconSelector.

For instance, to associate faiconSelector with the attribute 'cat_icon' in a form view, use code like this:

use cenotia\components\faiconSelector\FaiconSelector;
    
...
<?php echo $form->field($model, 'cat_icon')->widget(FaiconSelector::className()) ?>
...

//The class string is what will be stored. Example: fa fa-bank fa-2x
//So your field should be a varchar of 100 at least.
//So you will just to display like this for example.

...
<i class="<?= $model->cat_icon ?>"></i>
... 

options

De facto, InputWidget properties can also be used.

More options to be documented in coming versions.