{"$schema":"https://yii2-framework.github.io/docs/reference/reference.schema.json","schemaVersion":1,"package":"selectize","title":"Selectize","repository":"https://github.com/yii2-extensions/selectize","ref":"main","commit":"051c551e7b6f194fde84277adbbf9886e1b39251","generatedAt":"2026-10-24","url":"https://yii2-framework.github.io/docs/extensions/selectize/reference/","types":{"yii2\\extensions\\selectize\\RegisterClientScript":{"kind":"trait","url":"https://yii2-framework.github.io/docs/extensions/selectize/reference/registerclientscript/","summary":"Registers per-widget client settings and the optional remote loader.","properties":{"clientOptions":{"type":"array","default":"[]","description":"The client options for the Selectize widget."},"loadUrl":{"type":"array","default":"[]","description":"The URL for loading remote data for the Selectize widget."},"queryParam":{"type":"string","default":"'query'","description":"Name of the request parameter that carries the search text when loading remote data."}},"methods":{"registerClientScript":{"signature":"public function registerClientScript(): void","summary":"Registers the integration asset and initializes Selectize on the widget input.","return":{"type":"void"}}}},"yii2\\extensions\\selectize\\Selectize":{"kind":"class","url":"https://yii2-framework.github.io/docs/extensions/selectize/reference/selectize/","summary":"Renders model-bound or standalone Selectize selects and text inputs.","extends":"yii\\widgets\\InputWidget","implements":["yii\\base\\ViewContextInterface","yii\\base\\Configurable"],"traits":["yii2\\extensions\\selectize\\RegisterClientScript"],"properties":{"items":{"type":"array","default":"[]","description":"The items for the Selectize dropdown list."},"type":{"type":"string","default":"self::TYPE_SELECT","description":"The type of the Selectize widget."}},"methods":{"run":{"signature":"public function run(): string","summary":"Renders the input for the configured type and registers the client script.","return":{"type":"string","description":"Rendered input HTML."},"throws":[{"type":"yii\\base\\InvalidArgumentException","description":"if `$type` is neither `TYPE_SELECT` nor `TYPE_TEXT`."}]}},"constants":{"TYPE_SELECT":{"value":"'select'","description":"The type of the Selectize widget."},"TYPE_TEXT":{"value":"'text'","description":"The type of the Selectize widget for text inputs."}},"inherited":{"properties":{"attribute":"yii\\widgets\\InputWidget","autoIdPrefix":"yii\\base\\Widget","behaviors":"yii\\base\\Component","clientOptions":"yii2\\extensions\\selectize\\RegisterClientScript","field":"yii\\widgets\\InputWidget","id":"yii\\base\\Widget","loadUrl":"yii2\\extensions\\selectize\\RegisterClientScript","model":"yii\\widgets\\InputWidget","name":"yii\\widgets\\InputWidget","options":"yii\\widgets\\InputWidget","queryParam":"yii2\\extensions\\selectize\\RegisterClientScript","value":"yii\\widgets\\InputWidget","view":"yii\\base\\Widget","viewPath":"yii\\base\\Widget"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","afterRun":"yii\\base\\Widget","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","beforeRun":"yii\\base\\Widget","begin":"yii\\base\\Widget","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","end":"yii\\base\\Widget","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getId":"yii\\base\\Widget","getView":"yii\\base\\Widget","getViewPath":"yii\\base\\Widget","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasModel":"yii\\widgets\\InputWidget","hasProperty":"yii\\base\\Component","init":"yii\\widgets\\InputWidget","off":"yii\\base\\Component","on":"yii\\base\\Component","registerClientScript":"yii2\\extensions\\selectize\\RegisterClientScript","render":"yii\\base\\Widget","renderFile":"yii\\base\\Widget","renderInputHtml":"yii\\widgets\\InputWidget","setId":"yii\\base\\Widget","setView":"yii\\base\\Widget","trigger":"yii\\base\\Component","widget":"yii\\base\\Widget"},"events":{"EVENT_INIT":"yii\\base\\Widget","EVENT_BEFORE_RUN":"yii\\base\\Widget","EVENT_AFTER_RUN":"yii\\base\\Widget"}}},"yii2\\extensions\\selectize\\asset\\BootstrapAsset":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/selectize/reference/asset/bootstrapasset/","summary":"Publishes the prebuilt Bootstrap 5 theme dependencies.","extends":"yii\\web\\AssetBundle","implements":["yii\\base\\Configurable"],"properties":{"css":{"default":"['css/bootstrap.css']","description":"Bootstrap stylesheet required by the Selectize Bootstrap 5 theme."},"js":{"default":"['js/bootstrap.bundle.js']","description":"Bootstrap script bundle, including Popper."},"sourcePath":{"default":"'@npm/bootstrap/dist'","description":"Published distribution directory of the Bootstrap npm package."}},"inherited":{"properties":{"basePath":"yii\\web\\AssetBundle","baseUrl":"yii\\web\\AssetBundle","cssOptions":"yii\\web\\AssetBundle","depends":"yii\\web\\AssetBundle","jsOptions":"yii\\web\\AssetBundle","publishOptions":"yii\\web\\AssetBundle"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\web\\AssetBundle","publish":"yii\\web\\AssetBundle","register":"yii\\web\\AssetBundle","registerAssetFiles":"yii\\web\\AssetBundle"}}},"yii2\\extensions\\selectize\\asset\\SelectizeAsset":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/selectize/reference/asset/selectizeasset/","summary":"Publishes the Selectize Bootstrap 5 theme and compatible runtime.","extends":"yii\\web\\AssetBundle","implements":["yii\\base\\Configurable"],"properties":{"css":{"default":"['css/selectize.bootstrap5.css']","description":"Selectize Bootstrap 5 theme stylesheet."},"depends":{"default":"[\\yii2\\extensions\\selectize\\asset\\BootstrapAsset::class, \\yii\\web\\JqueryAsset::class, \\yii2\\extensions\\selectize\\asset\\SelectizeRuntimeAsset::class]","description":"Bootstrap, jQuery and the packaged Selectize runtime that the theme styles."},"sourcePath":{"default":"'@npm/@selectize/selectize/dist'","description":"Published distribution directory of the Selectize npm package."}},"inherited":{"properties":{"basePath":"yii\\web\\AssetBundle","baseUrl":"yii\\web\\AssetBundle","cssOptions":"yii\\web\\AssetBundle","js":"yii\\web\\AssetBundle","jsOptions":"yii\\web\\AssetBundle","publishOptions":"yii\\web\\AssetBundle"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\web\\AssetBundle","publish":"yii\\web\\AssetBundle","register":"yii\\web\\AssetBundle","registerAssetFiles":"yii\\web\\AssetBundle"}}},"yii2\\extensions\\selectize\\asset\\SelectizeIntegrationAsset":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/selectize/reference/asset/selectizeintegrationasset/","summary":"Adds accessible input attributes and repeatable widget initialization.","extends":"yii\\web\\AssetBundle","implements":["yii\\base\\Configurable"],"properties":{"depends":{"default":"[\\yii2\\extensions\\selectize\\asset\\SelectizeAsset::class]","description":"Selectize theme and runtime required by the integration script."},"js":{"default":"['selectize.yii.js']","description":"Integration script that provides the `yiiSelectize` jQuery plugin."},"sourcePath":{"default":"__DIR__ . '/js'","description":"Published source directory of the packaged scripts."}},"inherited":{"properties":{"basePath":"yii\\web\\AssetBundle","baseUrl":"yii\\web\\AssetBundle","css":"yii\\web\\AssetBundle","cssOptions":"yii\\web\\AssetBundle","jsOptions":"yii\\web\\AssetBundle","publishOptions":"yii\\web\\AssetBundle"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\web\\AssetBundle","publish":"yii\\web\\AssetBundle","register":"yii\\web\\AssetBundle","registerAssetFiles":"yii\\web\\AssetBundle"}}},"yii2\\extensions\\selectize\\asset\\SelectizeRuntimeAsset":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/selectize/reference/asset/selectizeruntimeasset/","summary":"Publishes Selectize with selector-safe labels and collision-safe option maps.","extends":"yii\\web\\AssetBundle","implements":["yii\\base\\Configurable"],"properties":{"depends":{"default":"[\\yii\\web\\JqueryAsset::class]","description":"JQuery, required by the Selectize runtime."},"js":{"default":"['selectize/selectize.js']","description":"Packaged Selectize 0.15.2 runtime with the local compatibility changes."},"sourcePath":{"default":"__DIR__ . '/js'","description":"Published source directory of the packaged scripts."}},"inherited":{"properties":{"basePath":"yii\\web\\AssetBundle","baseUrl":"yii\\web\\AssetBundle","css":"yii\\web\\AssetBundle","cssOptions":"yii\\web\\AssetBundle","jsOptions":"yii\\web\\AssetBundle","publishOptions":"yii\\web\\AssetBundle"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","init":"yii\\web\\AssetBundle","publish":"yii\\web\\AssetBundle","register":"yii\\web\\AssetBundle","registerAssetFiles":"yii\\web\\AssetBundle"}}},"yii2\\extensions\\selectize\\exception\\Message":{"kind":"enum","url":"https://yii2-framework.github.io/docs/extensions/selectize/reference/exception/message/","summary":"Defines widget exception message templates.","backingType":"string","cases":{"INVALID_TYPE":{"value":"'Invalid type \"%s\".'","description":"Error when the widget type is not supported."}},"methods":{"getMessage":{"signature":"public function getMessage(int|string ...$argument): string","summary":"Returns the formatted message string for the error case.","params":[{"name":"$argument","type":"int|string","optional":true,"variadic":true,"description":"Values to insert into the message template."}],"return":{"type":"string","description":"Formatted error message with interpolated arguments."}}}}}}