README

Renders a Font Awesome v5 Icon Picker widget for Yii2.

Note

If you want to support font avesome version 4 then use widget version 2

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require dominus77/yii2-fontawesome-iconpicker "^3.0"

or add

"dominus77/yii2-fontawesome-iconpicker": "^3.0"

to the require section of your composer.json file.

Usage

Once the extension is installed, simply use it in your code by :

<?php
...
use dominus77\iconpicker\IconPicker;
...
?>

<?= $form->field($model, 'icon')->widget(IconPicker::class, []) ?>

Client Options:

<?= $form->field($model, 'icon')->widget(IconPicker::class, [
    'clientOptions' => [
        'title' => 'Font Awesome Icon', // Popover title (optional) only if specified in the template
        'selected' => false, // use this value as the current item and ignore the original
        'defaultValue' => false, // use this value as the current item if input or element value is empty
        'placement' => 'bottom', // (has some issues with auto and CSS). auto, top, bottom, left, right
        'collision' => 'none', // If true, the popover will be repositioned to another position when collapses with the window borders
        'animation' => true, // fade in/out on show/hide ?
        //hide iconpicker automatically when a value is picked. it is ignored if mustAccept is not false and the accept button is visible
        'hideOnSelect' => false,
        'showFooter' => false,
        'searchInFooter' => false, // If true, the search will be added to the footer instead of the title'
        'mustAccept' => false, // only applicable when there's an iconpicker-btn-accept button in the popover footer
        'selectedCustomClass' => 'bg-primary', // Appends this class when to the selected item
        //'icons' => [], // list of icon classes (declared at the bottom of this script for maintainability)
        'fullClassFormatter' => new \yii\web\JsExpression("function(val){return val;}"),
        'input' => 'input,.iconpicker-input', // children input selector
        'inputSearch' => false, // use the input as a search box too?
        'container' => false, //  Appends the popover to a specific element. If not set, the selected element or element parent is used
        'component' => '.input-group-addon,.iconpicker-component', // children component jQuery selector or object, relative to the container element
        // Plugin templates:
        'templates' => [
            'popover' => '<div class="iconpicker-popover popover"><div class="arrow"></div><div class="popover-title"></div><div class="popover-content"></div></div>',
            'footer' => '<div class="popover-footer"></div>',
            'buttons' => '<button class="iconpicker-btn iconpicker-btn-cancel btn btn-default btn-sm">Cancel</button> <button class="iconpicker-btn iconpicker-btn-accept btn btn-primary btn-sm">Accept</button>',
            'search' => '<input type="search" class="form-control iconpicker-search" placeholder="Type to filter" />',
            'iconpicker' => '<div class="iconpicker"><div class="iconpicker-items"></div></div>',
            'iconpickerItem' => '<a role="button" href="#" class="iconpicker-item"><i></i></a>',
        ],
    ],
]) ?>

Code Sniffer

Check Style

composer check-style

Fix Style

composer fix-style

Testing

composer test

Resources

License

The MIT License (MIT). Please see License File for more information.

dominus77 / yii2-fontawesome-iconpicker

Maintainers

Details