# Combobox

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

[API reference](/docs/api/index.md) › [Bootstrap 6](/docs/extensions/bootstrap6/reference/index.md) › Combobox

| class | `yii2\extensions\bootstrap6\Combobox` |
| --- | --- |
| Extends | [`InputWidget`](/docs/extensions/bootstrap6/reference/inputwidget/index.md) » [`yii\widgets\InputWidget`](/docs/api/yii/widgets/inputwidget/index.md) » [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) » [`yii\base\Component`](/docs/api/yii/base/component/index.md) » [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| Implements | [`yii\base\ViewContextInterface`](/docs/api/yii/base/viewcontextinterface/index.md), [`yii\base\Configurable`](/docs/api/yii/base/configurable/index.md) |
| Uses traits | [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/index.md), [`BootstrapWidgetTrait`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md) |
| Source | [`src/Combobox.php`](https://github.com/yii2-extensions/bootstrap6/blob/main/src/Combobox.php#L31) |

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`](/docs/api/yii/widgets/inputwidget/index.md#property-name). Multiple selections are submitted as a
comma-separated list.

See also: <https://getbootstrap.com/docs/6.0/forms/combobox/>.

## Properties

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

## Methods

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

## Events

| Event | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="event-EVENT_INIT"></span>[`EVENT_INIT`](/docs/api/yii/base/widget/index.md#event-EVENT_INIT) | [`yii\base\Event`](/docs/api/yii/base/event/index.md) | An event that is triggered when the widget is initialized via [`init()`](/docs/api/yii/base/widget/index.md#method-init). Event name: `'init'`. Available since 2.0.11. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="event-EVENT_BEFORE_RUN"></span>[`EVENT_BEFORE_RUN`](/docs/api/yii/base/widget/index.md#event-EVENT_BEFORE_RUN) | [`yii\base\WidgetEvent`](/docs/api/yii/base/widgetevent/index.md) | An event raised right before executing a widget. Event name: `'beforeRun'`. Available since 2.0.11. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="event-EVENT_AFTER_RUN"></span>[`EVENT_AFTER_RUN`](/docs/api/yii/base/widget/index.md#event-EVENT_AFTER_RUN) | [`yii\base\WidgetEvent`](/docs/api/yii/base/widgetevent/index.md) | An event raised right after executing a widget. Event name: `'afterRun'`. Available since 2.0.11. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |

## Property details

### $caretIcon <span id="property-caretIcon"></span>

```php
public string|Stringable|null $caretIcon = null
```

Caret rendered inside the toggle (not encoded).

`null` renders the [`IconSet::$comboboxCaret`](/docs/extensions/bootstrap6/reference/iconset/index.md#property-comboboxCaret) default, and a `\UIAwesome\Html\Svg\Svg` instance
receives the `combobox-caret` class automatically.

### $checkIcon <span id="property-checkIcon"></span>

```php
public string|Stringable|null $checkIcon = null
```

Check mark rendered inside each item when [`$check`](/docs/extensions/bootstrap6/reference/combobox/index.md#property-check) is `true` (not encoded).

`null` renders the [`IconSet::$menuItemCheck`](/docs/extensions/bootstrap6/reference/iconset/index.md#property-menuItemCheck) default, and a `\UIAwesome\Html\Svg\Svg` instance
receives the `menu-item-check` class automatically.

## Method details

### init() <span id="method-init"></span>

```php
public function init(): void
```

Initializes the widget and validates [`$items`](/docs/extensions/bootstrap6/reference/combobox/index.md#property-items) and [`$placement`](/docs/extensions/bootstrap6/reference/combobox/index.md#property-placement).

**Throws**

- [`yii\base\InvalidConfigException`](/docs/api/yii/base/invalidconfigexception/index.md): if [`$items`](/docs/extensions/bootstrap6/reference/combobox/index.md#property-items) is empty, or [`$placement`](/docs/extensions/bootstrap6/reference/combobox/index.md#property-placement) is not a [`Placement`](/docs/extensions/bootstrap6/reference/enum/placement/index.md) value, optionally breakpoint-prefixed.

### run() <span id="method-run"></span>

```php
public function run(): string
```

**Returns**

`string`

### renderItem() <span id="method-renderItem"></span>

```php
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() <span id="method-renderMenu"></span>

```php
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() <span id="method-renderToggle"></span>

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

Renders the toggle button.

**Parameters**

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

**Returns**

`string`