yii2-extension yii2-widget-easyautocomplete

gitrequests/yii2-widget-easyautocomplete

Yii2 widget for the EasyAutocomplete plugin (https://github.com/pawelczak/EasyAutocomplete).

yii2-widget-easyautocomplete

Yii2 widget for the EasyAutocomplete plugin (https://github.com/pawelczak/EasyAutocomplete)., _(*1)

Install

The preferred way to install this extension is through composer. Check the composer.json for this extension's requirements and dependencies., _(*2)

To install, either run, _(*3)

$ php composer.phar require gitrequests/yii2-widget-easyautocomplete "dev-master"

or add, _(*4)

"gitrequests/yii2-widget-easyautocomplete": "dev-master"

to the require section of your composer.json file., _(*5)

Usage

echo EasyAutocomplete::widget([
    'pluginOptions' => [
        'url' => Url::to('data/countries.json'),
        'getValue' => 'name'
    ]
]);

You can also use this widget in an [[ActiveForm]] using the [[ActiveField::widget()|widget()]] method, for example like this:, _(*6)

echo $form->field($model, 'address')->widget(EasyAutocomplete::className(), [
    'pluginOptions' => [
        'url' => Url::to('data/countries.json'),
        'getValue' => 'name'
    ]
]);

For use with list events||functions (custom match function for example):, _(*7)

echo $form->field($model, 'address')->widget(EasyAutocomplete::className(), [
    'pluginOptions' => [
        'url' => Url::to('data/countries.json'),
        'getValue' => 'name'
        'list' => [
            'maxNumberOfElements' => 10,
            'match' => [
                'enabled' => true,
                'method' => new JsExpression(<<<JavaScript
                    function(element, phrase) {

                        var searches = phrase.split(' ')
                        var count = 0;

                        for (var search of searches) {
                            if (element.search(search) > -1) {
                                count++;
                            }
                        }

                        return searches.length === count
                    }
                JavaScript
                )
            ]
        ]
    ]
]);