Class yii\bootstrap\ToggleButtonGroup

Inheritanceyii\bootstrap\ToggleButtonGroup » yii\bootstrap\InputWidget » yii\widgets\InputWidget » yii\base\Widget » yii\base\Component » yii\base\BaseObject
Implementsyii\base\Configurable, yii\base\ViewContextInterface
Uses Traitsyii\bootstrap\BootstrapWidgetTrait
Available since version2.0.6
Source Code https://github.com/yiisoft/yii2-bootstrap/blob/master/ToggleButtonGroup.php

ToggleButtonGroup allows rendering form inputs Checkbox/Radio toggle button groups.

You can use this widget in an \yii\bootstrap\yii\bootstrap\ActiveForm using the \yii\bootstrap\yii\widgets\ActiveField::widget() method, for example like this:

<?= $form->field($model, 'item_id')->widget(\yii\bootstrap\ToggleButtonGroup::classname(), [
    // configure additional widget properties here
]) ?>

See also http://getbootstrap.com/javascript/#buttons-checkbox-radio.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$attribute string 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
$clientEvents array The event handlers for the underlying Bootstrap JS plugin. yii\bootstrap\BootstrapWidgetTrait
$clientOptions array The options for the underlying Bootstrap JS plugin. yii\bootstrap\BootstrapWidgetTrait
$counter integer A counter used to generate \yii\base\id for widgets. yii\base\Widget
$encodeLabels boolean Whether the items labels should be HTML-encoded. yii\bootstrap\ToggleButtonGroup
$field yii\widgets\ActiveField Active input field, which triggers this widget rendering. yii\widgets\InputWidget
$items array The data item used to generate the checkboxes. yii\bootstrap\ToggleButtonGroup
$labelOptions \yii\bootstrap\array, The HTML attributes for the label (button) tag. yii\bootstrap\ToggleButtonGroup
$model yii\base\Model The data model that this widget is associated with. yii\widgets\InputWidget
$name string 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: - 'checkbox' - 'radio' yii\bootstrap\ToggleButtonGroup
$value string The input value. yii\widgets\InputWidget

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__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 an object property. yii\base\BaseObject
__isset() Checks if a property is set, i.e. defined and not null. yii\base\BaseObject
__set() Sets value of an object property. yii\base\BaseObject
__unset() Sets an object property to null. yii\base\BaseObject
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\BaseObject
canSetProperty() Returns a value indicating whether a property can be set. yii\base\BaseObject
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() yii\bootstrap\BootstrapWidgetTrait
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\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
init() Initializes the widget. yii\bootstrap\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\bootstrap\ToggleButtonGroup
run() Executes the widget. yii\bootstrap\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

Hide inherited methods

MethodDescriptionDefined By
hasModel() yii\widgets\InputWidget
registerClientEvents() Registers JS event handlers that are listed in $clientEvents. yii\bootstrap\BootstrapWidgetTrait
registerPlugin() Registers a specific Bootstrap plugin and the related events yii\bootstrap\BootstrapWidgetTrait
renderInputHtml() Render a HTML input tag. yii\widgets\InputWidget

Events

Hide inherited events

EventTypeDescriptionDefined 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

Property Details

$encodeLabels public property

Whether the items labels should be HTML-encoded.

public boolean $encodeLabels true
$items public property

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.

public array $items = []
$labelOptions public property

The HTML attributes for the label (button) tag.

See also:

public \yii\bootstrap\array, $labelOptions = []
$type public property

Input type, can be:

  • 'checkbox'
  • 'radio'
public string $type null

Method Details

init() public method

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 ( )
renderItem() public method

Default callback for checkbox/radio list item rendering.

See also:

public string renderItem ( $index, $label, $name, $checked, $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.

run() public method

Executes the widget.

public string run ( )
return string

The result of widget execution to be outputted.