Trait yii\bootstrap\BootstrapWidgetTrait

Implemented by	yii\apidoc\templates\bootstrap\SideNavWidget, yii\bootstrap\Alert, yii\bootstrap\Button, yii\bootstrap\ButtonDropdown, yii\bootstrap\ButtonGroup, yii\bootstrap\Carousel, yii\bootstrap\Collapse, yii\bootstrap\Dropdown, yii\bootstrap\InputWidget, yii\bootstrap\Modal, yii\bootstrap\Nav, yii\bootstrap\NavBar, yii\bootstrap\Progress, yii\bootstrap\Tabs, yii\bootstrap\ToggleButtonGroup, yii\bootstrap\Widget
Available since version	2.0.6
Source Code	https://github.com/yiisoft/yii2-bootstrap/blob/master/BootstrapWidgetTrait.php

BootstrapWidgetTrait is the trait, which provides basic for all bootstrap widgets features.

Note: class, which uses this trait must declare public field named options with the array default value:

class MyWidget extends \yii\base\Widget
{
    use BootstrapWidgetTrait;

    public $options = [];
}

This field is not present in the trait in order to avoid possible PHP Fatal error on definition conflict.

Public Properties

Property	Type	Description	Defined By
$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

Public Methods

Method	Description	Defined By
getView()		yii\bootstrap\BootstrapWidgetTrait
init()	Initializes the widget.	yii\bootstrap\BootstrapWidgetTrait

Protected Methods

Method	Description	Defined By
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

Property Details

$clientEvents public property

The event handlers for the underlying Bootstrap JS plugin. Please refer to the corresponding Bootstrap plugin Web page for possible events. For example, this page shows how to use the "Modal" plugin and the supported events (e.g. "shown").

public array $clientEvents = []

$clientOptions public property

The options for the underlying Bootstrap JS plugin. Please refer to the corresponding Bootstrap plugin Web page for possible options. For example, this page shows how to use the "Modal" plugin and the supported options (e.g. "remote").

public array $clientOptions = []

Method Details