Skip to content

yii2-extensions/selectize

Repository files navigation

Selectize.


php-version PHPUnit PHPUnit Codecov Infection

Installation

The preferred way to install this extension is through composer.

Either run

composer require --prefer-dist yii2-extensions/selectize:^0.1

or add

"yii2-extensions/selectize": "^0.1"

to the require section of your composer.json file.

Usage

Dropdown list

use Yii2\Extension\Selectize\Selectize;

Selectize::widget(
    [
        'attribute' => 'tags',
        'items' => ['foo', 'bar'],
        'model' => new SelectizeModel(), // your model
    ],
);

Text input

use Yii2\Extension\Selectize\Selectize;

Selectize::widget(
    [
        'attribute' => 'tags',
        'items' => ['foo', 'bar'],
        'model' => new SelectizeModel(), // your model
        'type' => Selectize::TYPE_TEXT, // `Selectize::TYPE_SELECT`, `Selectize::TYPE_TEXT`
    ],
);

Properties of the widget

Property Type Description Default
attribute string The attribute associated with this widget. null
clientOptions array The options for the underlying Selectize JS plugin. []
items array Items to be displayed in the dropdown list. []
loadUrl string The URL that will return JSON data. null
model Model The data model that this widget is associated with. null
options array The HTML attributes for the widget container tag. []
queryParam string The name of the parameter that will be sent to the server with the search query. query
type string The type of the widget. Selectize::TYPE_SELECT

Quality code

static-analysis phpstan-level StyleCI

Support versions Yii2

Yii20 Yii22

Testing

Check the documentation testing to learn about testing.

Our social networks

Twitter

License

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