Selectize JS Widget for Yii2
Selectize is an extensible jQuery-based custom <select> UI control. It's useful for tagging, contact lists, country selectors, and so on. It clocks in at around ~7kb (gzipped). The goal is to provide a solid & usable experience with a clean and powerful API.
Installation
The preferred way to install this extension is through composer.
Either run
$ composer require 2amigos/yii2-selectize-widget:~1.0or add
"2amigos/yii2-selectize-widget": "~1.0"
to the require section of your composer.json file.
Usage
Selectize has lots of configuration options. For further information, please check the Selectize plugin website.
Text input widget
To use text input widget add the following to the view
use dosamigos\selectize\SelectizeTextInput;
echo SelectizeTextInput::widget([
'name' => 'tags',
'value' => 'love, this, game',
'clientOptions' => [
// ...
],
]);Dropdown list widget
To use dropdown list widget add the following to the view
use dosamigos\selectize\SelectizeDropDownList;
echo SelectizeDropDownList::widget([
'name' => 'tags',
'items' => ['love', 'this', 'game'],
'clientOptions' => [
// ...
],
]);Configuration
SelectizeDropDownList extends from InputWidget, but have additional properties that can be configured.
| Property | Type | Default | Description |
|---|---|---|---|
loadUrl |
string|array | null | Optional. This parameter will be passed to Url::to. If set, selectize plugin will be configured to send ajax requests to the defined url to retrieve options. Url must return a valid JSON response. |
queryParam |
string | 'query' | The name of the request parameter to use on ajax requests |
clientOptions |
array | null | Configuration of selectize plugin. This configuration is individual for each selectize instance. |
Testing
$ ./vendor/bin/phpunitContributing
Please see CONTRIBUTING for details.
Credits
License
The BSD License (BSD). Please see License File for more information.
web development has never been so fun
www.2amigos.us
