Class yii\bootstrap5\ToggleButtonGroup
ToggleButtonGroup allows rendering form inputs Checkbox/Radio toggle button groups.
You can use this widget in an ActiveForm using the widget() method, for example like this:
<?= $form->field($model, 'item_id')->widget(\yii\bootstrap5\ToggleButtonGroup::class, [
'type' => \yii\bootstrap5\ToggleButtonGroup::TYPE_CHECKBOX
'items' => [
'fooValue' => 'BarLabel',
'barValue' => 'BazLabel'
]
]) ?>
See also https://getbootstrap.com/docs/5.1/components/buttons/#checkbox-and-radio-buttons.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $attribute | string|null | The model attribute that this widget is associated with. | yii\widgets\InputWidget |
| $autoIdPrefix | string | The prefix to the automatically generated widget IDs. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component. | yii\base\Component |
| $clientEvents | array | The event handlers for the underlying Bootstrap JS plugin. | yii\bootstrap5\BootstrapWidgetTrait |
| $clientOptions | array|boolean | The options for the underlying Bootstrap JS plugin. | yii\bootstrap5\BootstrapWidgetTrait |
| $counter | integer | A counter used to generate $id for widgets. | yii\base\Widget |
| $encodeLabels | boolean | Whether the items labels should be HTML-encoded. | yii\bootstrap5\ToggleButtonGroup |
| $field | yii\widgets\ActiveField | Active input field, which triggers this widget rendering. | yii\widgets\InputWidget |
| $id | string|null | ID of the widget. Note that the type of this property differs in getter and setter. See getId() and setId() for details. | yii\base\Widget |
| $items | array | The data item used to generate the checkboxes. | yii\bootstrap5\ToggleButtonGroup |
| $labelOptions | \yii\bootstrap5\array, | The HTML attributes for the label (button) tag. | yii\bootstrap5\ToggleButtonGroup |
| $model | yii\base\Model|null | The data model that this widget is associated with. | yii\widgets\InputWidget |
| $name | string|null | The input name. | yii\widgets\InputWidget |
| $options | array | The HTML attributes for the input tag. | yii\widgets\InputWidget |
| $stack | yii\base\Widget[] | The widgets that are currently being rendered (not ended). | yii\base\Widget |
| $type | string | Input type, can be TYPE_CHECKBOX or TYPE_RADIO | yii\bootstrap5\ToggleButtonGroup |
| $value | string | The input value. | yii\widgets\InputWidget |
| $view | yii\web\View | The view object that can be used to render views or view files. Note that the type of this property differs in getter and setter. See getView() and setView() for details. | yii\base\Widget |
| $viewPath | string | The directory containing the view files for this widget. | yii\base\Widget |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __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 |
| __construct() | Constructor. | yii\base\BaseObject |
| __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 |
| 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 |
| beforeRun() | This method is invoked right before the widget is executed. | yii\base\Widget |
| begin() | 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 |
| className() | 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() | 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() | yii\base\ViewContextInterface | |
| 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. | yii\bootstrap5\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 |
| renderItem() | Default callback for checkbox/radio list item rendering. | yii\bootstrap5\ToggleButtonGroup |
| run() | Executes the widget. | yii\bootstrap5\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() | Creates a widget instance and runs it. | yii\base\Widget |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| hasModel() | yii\widgets\InputWidget | |
| registerClientEvents() | Registers JS event handlers that are listed in $clientEvents. | yii\bootstrap5\BootstrapWidgetTrait |
| registerPlugin() | Registers a specific Bootstrap plugin and the related events | yii\bootstrap5\BootstrapWidgetTrait |
| renderInputHtml() | Render a HTML input tag. | yii\widgets\InputWidget |
Events
| Event | Type | Description | Defined By |
|---|---|---|---|
| EVENT_AFTER_RUN | yii\base\WidgetEvent | An event raised right after executing a widget. (available since version 2.0.11) | yii\base\Widget |
| EVENT_BEFORE_RUN | yii\base\WidgetEvent | An event raised right before executing a widget. (available since version 2.0.11) | yii\base\Widget |
| EVENT_INIT | yii\base\Event | An event that is triggered when the widget is initialized via init(). (available since version 2.0.11) | yii\base\Widget |
Constants
| Constant | Value | Description | Defined By |
|---|---|---|---|
| TYPE_CHECKBOX | 'checkbox' | Checkbox type | yii\bootstrap5\ToggleButtonGroup |
| TYPE_RADIO | 'radio' | Radio type | yii\bootstrap5\ToggleButtonGroup |
Property Details
Whether the items labels should be HTML-encoded.
The data item used to generate the checkboxes. The array values are the labels, while the array keys are the corresponding checkbox or radio values.
The HTML attributes for the label (button) tag.
See also:
Input type, can be TYPE_CHECKBOX or TYPE_RADIO
Method Details
Initializes the widget.
This method will register the bootstrap asset bundle. If you override this method, make sure you call the parent implementation first.
| public void init ( ) | ||
| throws | yii\base\InvalidConfigException | |
|---|---|---|
Default callback for checkbox/radio list item rendering.
See also:
| public string renderItem ( \yii\bootstrap5\int $index, \yii\bootstrap5\string $label, \yii\bootstrap5\string $name, \yii\bootstrap5\bool $checked, \yii\bootstrap5\string $value ) | ||
| $index | integer | Item index. |
| $label | string | Item label. |
| $name | string | Input name. |
| $checked | boolean | Whether value is checked or not. |
| $value | string | Input value. |
| return | string | Generated HTML. |
|---|---|---|
Executes the widget.
| public string run ( ) | ||
| return | string | The rendering result may be directly "echoed" or returned as a string |
|---|---|---|
| throws | yii\base\InvalidConfigException | |