Combobox

API reference › Bootstrap 6 › Combobox

class	`yii2\extensions\bootstrap6\Combobox`
Extends	`InputWidget` » `yii\widgets\InputWidget` » `yii\base\Widget` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\ViewContextInterface`, `yii\base\Configurable`
Uses traits	`AttributesTrait`, `BootstrapWidgetTrait`
Source	`src/Combobox.php`

Renders a Bootstrap combobox: a .combobox-toggle button followed by a .menu of selectable items.

The plugin submits the selection through a hidden input that it creates from data-bs-name, so the toggle carries the input name of the model attribute or $name. Multiple selections are submitted as a comma-separated list.

Properties

Property	Type	Description	Defined by
`$attribute`	`string\|null`	The model attribute that this widget is associated with. Default: `null`.	`yii\widgets\InputWidget`
`$autoIdPrefix` static	`string`	The prefix to the automatically generated widget IDs. Default: `'w'`.	`yii\base\Widget`
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$caretIcon`	`string\|Stringable\|null`	Caret rendered inside the toggle (not encoded). Default: `null`.	`Combobox`
`$check`	`bool`	Whether to render the `.menu-item-check` icon that marks the selected items. Default: `false`.	`Combobox`
`$checkIcon`	`string\|Stringable\|null`	Check mark rendered inside each item when `$check` is `true` (not encoded). Default: `null`.	`Combobox`
`$clientEvents`	`array<string,` `yii\web\JsExpression\|string>`	Event handlers attached to the widget element, as event name => JavaScript handler source. Default: `[]`.	`BootstrapWidgetTrait`
`$clientOptions`	`array<string, mixed>\|false`	Options passed to the plugin constructor, or `false` to skip the JavaScript initialization. Default: `[]`.	`BootstrapWidgetTrait`
`$encodeLabels`	`bool`	Whether to HTML-encode the item labels and `$placeholder`. Default: `true`.	`Combobox`
`$field`	`yii\widgets\ActiveField`	Active input field, which triggers this widget rendering. Default: `null`. Available since 2.0.11.	`yii\widgets\InputWidget`
`$id`	`string`	Id of the widget.	`yii\base\Widget`
`$items`	`array<int\|string, string>`	Selectable items as value => label. Default: `[]`.	`Combobox`
`$menuOptions`	`array<string, mixed>`	HTML attributes of the `.menu` container. Default: `[]`.	`Combobox`
`$model`	`yii\base\Model\|null`	The data model that this widget is associated with. Default: `null`.	`yii\widgets\InputWidget`
`$multiple`	`bool`	Whether to allow selecting several items. Default: `false`.	`Combobox`
`$name`	`string\|null`	The input name. Default: `null`.	`yii\widgets\InputWidget`
`$noResultsText`	`string\|Stringable`	Text of the `.combobox-no-results` element rendered when `$search` is `true`. Default: `'No results found'`.	`Combobox`
`$options`	`array`	The HTML attributes for the input tag. Default: `[]`.	`yii\widgets\InputWidget`
`$placeholder`	`string`	Text shown in the toggle when nothing is selected. Default: `''`.	`Combobox`
`$placement`	`yii2\extensions\bootstrap6\enum\Placement\|string\|null`	Menu placement, or `null` for the plugin default (`bottom-start`). Default: `null`.	`Combobox`
`$search`	`bool`	Whether to render the search field that filters the items. Default: `false`.	`Combobox`
`$searchPlaceholder`	`string\|Stringable`	Placeholder and accessible label of the search field. Default: `'Search...'`.	`Combobox`
`$value`	`string`	The input value. Default: `null`.	`yii\widgets\InputWidget`
`$view`	`yii\web\View`	The view object that can be used to render views or view files.	`yii\base\Widget`
`$viewPath` read-only	`string`	The directory containing the view files for this widget.	`yii\base\Widget`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\Component`
`__clone()`	This method is called after the object is created by cloning an existing one.	`yii\base\Component`
`__get()`	Returns the value of a component property.	`yii\base\Component`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\Component`
`__set()`	Sets the value of a component property.	`yii\base\Component`
`__unset()`	Sets a component property to be null.	`yii\base\Component`
`addAttributes()`	Adds a set of HTML attributes; attributes already set with the same name are replaced.	`AttributesTrait`
`addClass()`	Adds one or more CSS classes to the existing classes; duplicated classes are collapsed.	`AttributesTrait`
`addCssStyle()`	Adds CSS style properties to the `style` attribute.	`AttributesTrait`
`afterRun()`	This method is invoked right after a widget is executed.	`yii\base\Widget`
`attachBehavior()`	Attaches a behavior to this component.	`yii\base\Component`
`attachBehaviors()`	Attaches a list of behaviors to the component.	`yii\base\Component`
`attribute()`	Sets an HTML attribute value.	`AttributesTrait`
`beforeRun()`	This method is invoked right before the widget is executed.	`yii\base\Widget`
`begin()` static	Begins a widget.	`yii\base\Widget`
`behaviors()`	Returns a list of behaviors that this component should behave as.	`yii\base\Component`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\Component`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\Component`
`class()`	Replaces the existing CSS classes with the specified ones.	`AttributesTrait`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`detachBehavior()`	Detaches a behavior from the component.	`yii\base\Component`
`detachBehaviors()`	Detaches all behaviors from the component.	`yii\base\Component`
`end()` static	Ends a widget.	`yii\base\Widget`
`ensureBehaviors()`	Makes sure that the behaviors declared in `behaviors()` are attached to this component.	`yii\base\Component`
`getBehavior()`	Returns the named behavior object.	`yii\base\Component`
`getBehaviors()`	Returns all behaviors attached to this component.	`yii\base\Component`
`getId()`	Returns the ID of the widget.	`yii\base\Widget`
`getView()`	Returns the view object that can be used to render views or view files.	`yii\base\Widget`
`getViewPath()`	Returns the directory containing the view files for this widget.	`yii\base\Widget`
`hasEventHandlers()`	Returns a value indicating whether there is any handler attached to the named event.	`yii\base\Component`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\Component`
`hasProperty()`	Returns a value indicating whether a property is defined for this component.	`yii\base\Component`
`init()`	Initializes the widget and validates `$items` and `$placement`.	`Combobox`
`off()`	Detaches an existing event handler from this component.	`yii\base\Component`
`on()`	Attaches an event handler to an event.	`yii\base\Component`
`render()`	Renders a view.	`yii\base\Widget`
`renderFile()`	Renders a view file.	`yii\base\Widget`
`run()`		`Combobox`
`setId()`	Sets the ID of the widget.	`yii\base\Widget`
`setView()`	Sets the view object to be used by this widget.	`yii\base\Widget`
`trigger()`	Triggers an event.	`yii\base\Component`
`widget()` static	Creates a widget instance and runs it.	`yii\base\Widget`
`hasModel()` protected		`yii\widgets\InputWidget`
`pluginInitialization()` protected	Returns the JavaScript that initializes a plugin with its normalized constructor options.	`BootstrapWidgetTrait`
`registerClientEvents()` protected	Registers the JavaScript event handlers listed in `$clientEvents` at `View::POS_END`.	`BootstrapWidgetTrait`
`registerPlugin()` protected	Registers the plugin asset, the plugin initialization when needed, and the `$clientEvents`.	`BootstrapWidgetTrait`
`renderInputHtml()` protected	Render a HTML input tag.	`yii\widgets\InputWidget`
`renderItem()` protected	Renders a menu item.	`Combobox`
`renderMenu()` protected	Renders the `.menu` container with the search field and the items.	`Combobox`
`renderToggle()` protected	Renders the toggle button.	`Combobox`

Events

Event	Type	Description	Defined by
`EVENT_INIT`	`yii\base\Event`	An event that is triggered when the widget is initialized via `init()`. Event name: `'init'`. Available since 2.0.11.	`yii\base\Widget`
`EVENT_BEFORE_RUN`	`yii\base\WidgetEvent`	An event raised right before executing a widget. Event name: `'beforeRun'`. Available since 2.0.11.	`yii\base\Widget`
`EVENT_AFTER_RUN`	`yii\base\WidgetEvent`	An event raised right after executing a widget. Event name: `'afterRun'`. Available since 2.0.11.	`yii\base\Widget`

Property details

$caretIcon

public string|Stringable|null $caretIcon = null

Caret rendered inside the toggle (not encoded).

null renders the IconSet::$comboboxCaret default, and a \UIAwesome\Html\Svg\Svg instance receives the combobox-caret class automatically.

$checkIcon

public string|Stringable|null $checkIcon = null

Check mark rendered inside each item when $check is true (not encoded).

null renders the IconSet::$menuItemCheck default, and a \UIAwesome\Html\Svg\Svg instance receives the menu-item-check class automatically.

Method details

init()

public function init(): void

Initializes the widget and validates $items and $placement.

Throws

yii\base\InvalidConfigException: if $items is empty, or $placement is not a Placement value, optionally breakpoint-prefixed.

run()

public function run(): string

Returns

string

renderItem()

protected function renderItem(int|string $value, string $label, list<string> $selected): string

Renders a menu item.

Parameters

Parameter	Type	Description
`$value`	`int\|string`
`$label`	`string`
`$selected`	`list<string>`	Selected values.

Returns

string

renderMenu()

protected function renderMenu(list<string> $selected): string

Renders the .menu container with the search field and the items.

Parameters

Parameter	Type	Description
`$selected`	`list<string>`	Selected values.

Returns

string

renderToggle()

protected function renderToggle(list<string> $selected): string

Renders the toggle button.

Parameters

Parameter	Type	Description
`$selected`	`list<string>`	Selected values.

Returns

string