Trait yii\bootstrap\BootstrapWidgetTrait
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
隐藏继承的属性 Hide inherited 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
隐藏继承的方法 Hide inherited methods
| 方法 Method | 简介 Description | 定义在 Defined By |
|---|---|---|
| getView() | yii\bootstrap\BootstrapWidgetTrait | |
| init() | Initializes the widget. | yii\bootstrap\BootstrapWidgetTrait |
Protected Methods
隐藏继承的方法 Hide inherited 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
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").
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").
方法详情 Method Details
| public abstract yii\web\View getView ( ) | ||
| return | yii\web\View | The view object that can be used to render views or view files. |
|---|---|---|
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 ( ) |
Registers JS event handlers that are listed in $clientEvents.
| protected void registerClientEvents ( ) |
Registers a specific Bootstrap plugin and the related events
| protected void registerPlugin ( $name ) | ||
| $name | string | The name of the Bootstrap plugin |