ToggleButtonGroup

API reference › Bootstrap 6 › ToggleButtonGroup

class	`yii2\extensions\bootstrap6\ToggleButtonGroup`
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/ToggleButtonGroup.php`

Renders a group of checkbox or radio toggle buttons for a model attribute or a named input.

Each item renders as <label class="btn-check ..."><input type="checkbox" ...>Label</label>; the input is nested in the label, so no id/for pair is needed. With a model, a hidden input submits the empty value when nothing is selected (configurable through the unselect key of $options); it is disabled together with the inputs when $inputOptions carries disabled.

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`
`$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. Default: `true`.	`ToggleButtonGroup`
`$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`
`$inputOptions`	`array<string, mixed>`	HTML attributes of every input tag, for example `['disabled' => true]`. Default: `[]`.	`ToggleButtonGroup`
`$items`	`array<array-key, string>`	Toggle buttons as value => label pairs. Default: `[]`.	`ToggleButtonGroup`
`$labelOptions`	`array<string, mixed>`	HTML attributes of every label (button) tag. Default: `[]`.	`ToggleButtonGroup`
`$model`	`yii\base\Model\|null`	The data model that this widget is associated with. Default: `null`.	`yii\widgets\InputWidget`
`$name`	`string\|null`	The input name. Default: `null`.	`yii\widgets\InputWidget`
`$options`	`array`	The HTML attributes for the input tag. Default: `[]`.	`yii\widgets\InputWidget`
`$size`	`yii2\extensions\bootstrap6\enum\Size\|string\|null`	Size modifier rendered as the `btn-group-{value}` class (`xs`, `sm`, or `lg`), or `null` for the default. Default: `null`.	`ToggleButtonGroup`
`$theme`	`yii2\extensions\bootstrap6\enum\Theme\|string\|null`	Theme color of the buttons rendered as the `theme-{value}` class, or `null` for the neutral color. Default: `null`.	`ToggleButtonGroup`
`$type`	`string`	Input type, either `TYPE_CHECKBOX` or `TYPE_RADIO`. Default: `self::TYPE_CHECKBOX`.	`ToggleButtonGroup`
`$value`	`string`	The input value. Default: `null`.	`yii\widgets\InputWidget`
`$variant`	`yii2\extensions\bootstrap6\enum\ButtonVariant\|string`	Button style class of the labels. Default: `\yii2\extensions\bootstrap6\enum\ButtonVariant::OUTLINE`.	`ToggleButtonGroup`
`$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()`		`ToggleButtonGroup`
`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()`		`ToggleButtonGroup`
`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 toggle button.	`ToggleButtonGroup`

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`

Constants

Constant	Value	Description	Defined by
`TYPE_CHECKBOX`	`'checkbox'`	Checkbox toggle buttons; the input name receives the `[]` suffix.	`ToggleButtonGroup`
`TYPE_RADIO`	`'radio'`	Radio toggle buttons.	`ToggleButtonGroup`
`TYPES`	`[self::TYPE_CHECKBOX, self::TYPE_RADIO]`	Supported values of `$type`.	`ToggleButtonGroup`

Method details

init()

public function init(): void

Throws

yii\base\InvalidConfigException: if the widget has neither a model attribute nor a name, or $size, $theme, $type, or $variant is not supported.

run()

public function run(): string

Returns

string

renderItem()

protected function renderItem(string $label, string $name, bool $checked, string $value): string

Renders a toggle button.

Parameters

Parameter	Type	Description
`$label`	`string`	Item label, HTML-encoded when `$encodeLabels` is `true`.
`$name`	`string`	Input name.
`$checked`	`bool`	Whether the input is checked.
`$value`	`string`	Input value.

Returns

string: Generated HTML.