mazurva/yii2-fontawesome-iconpicker

Font Awesome Icon Picker is a fully customizable plugin for Twitter Bootstrap, with a powerful base API, based on fontawesome-iconpicker

dev-master 2017-09-26 08:19 UTC

This package is auto-updated.

Last update: 2022-09-14 22:00:15 UTC


README

Font Awesome Icon Picker is a fully customizable plugin for Twitter Bootstrap, with a powerful base API, based on fontawesome-iconpicker

You can use Font Awesome or another font icon set of your choice (icon list is totally customizable).

View demos

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist mazurva/yii2-fontawesome-iconpicker "*"

or add

"mazurva/yii2-fontawesome-iconpicker": "*"

to the require section of your composer.json file.

Usage

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

<?php
...
use mazurva\widgets\iconpicker\IconPicker;
...
?>

Default

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

As a component

<?= $form->field($model, 'icon', 
        [
            'inputTemplate' => '<div class="input-group  iconpicker-container">{input}<span class="input-group-addon"></span></div>',
        ])->widget(IconPicker::className(), []); ?>

Client Options:

<?= $form->field($model, 'icon')->widget(IconPicker::className(), [
    '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 'fa ' + 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>',
        ],
    ],
]); ?>