Class yii\bootstrap5\Widget

All Classes | Properties | Methods

Inheritance	yii\bootstrap5\Widget » yii\base\Widget
Uses Traits	yii\bootstrap5\BootstrapWidgetTrait
Subclasses	yii\bootstrap5\Accordion, yii\bootstrap5\Alert, yii\bootstrap5\Button, yii\bootstrap5\ButtonDropdown, yii\bootstrap5\ButtonGroup, yii\bootstrap5\ButtonToolbar, yii\bootstrap5\Carousel, yii\bootstrap5\Dropdown, yii\bootstrap5\LinkPager, yii\bootstrap5\Modal, yii\bootstrap5\Nav, yii\bootstrap5\NavBar, yii\bootstrap5\Offcanvas, yii\bootstrap5\Popover, yii\bootstrap5\Progress, yii\bootstrap5\Tabs, yii\bootstrap5\Toast
Source Code	https://github.com/yiisoft/yii2-bootstrap5/blob/master/src/Widget.php

\yii\bootstrap5\Widget is the base class for all bootstrap5 widgets.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$clientEvents	array	The event handlers for the underlying Bootstrap JS plugin.	yii\bootstrap5\BootstrapWidgetTrait
$clientOptions	array\|false	The options for the underlying Bootstrap JS plugin/component.	yii\bootstrap5\BootstrapWidgetTrait
$options	array	The HTML attributes for the widget container tag.	yii\bootstrap5\Widget

Public Methods

Hide inherited methods

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

Protected Methods

Hide inherited methods

Method	Description	Defined By
registerClientEvents()	Registers JS event handlers that are listed in $clientEvents.	yii\bootstrap5\BootstrapWidgetTrait
registerPlugin()	Registers a specific Bootstrap plugin/component and the related events.	yii\bootstrap5\BootstrapWidgetTrait

Property Details

Hide inherited properties

$options public property

The HTML attributes for the widget container tag.

See also \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $options = []

Method Details

Hide inherited methods

init() public method

Defined in: yii\bootstrap5\BootstrapWidgetTrait::init()

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

Source code

                public function init(): void
{
    parent::init();
    if (!isset($this->options['id'])) {
        $this->options['id'] = $this->getId();
    }
}

registerClientEvents() protected method

Defined in: yii\bootstrap5\BootstrapWidgetTrait::registerClientEvents()

Registers JS event handlers that are listed in $clientEvents.

protected void registerClientEvents ( ?string $name = null )
$name	?string

Source code

                protected function registerClientEvents(?string $name = null): void
{
    if (!empty($this->clientEvents)) {
        $id = $this->options['id'];
        $js = [];
        $appendix = ($name === 'dropdown') ? '.parentElement' : '';
        foreach ($this->clientEvents as $event => $handler) {
            $js[] = "document.getElementById('$id')$appendix.addEventListener('$event', $handler);";
        }
        $this->getView()->registerJs(implode("\n", $js));
    }
}

registerPlugin() protected method

Defined in: yii\bootstrap5\BootstrapWidgetTrait::registerPlugin()

Registers a specific Bootstrap plugin/component and the related events.

protected void registerPlugin ( string $name )
$name	string	The name of the Bootstrap plugin

Source code

                protected function registerPlugin(string $name): void
{
    /**
     * @see https://github.com/twbs/bootstrap/blob/v5.2.0/js/index.esm.js
     */
    $jsPlugins = [
        'alert',
        'button',
        'carousel',
        'collapse',
        'dropdown',
        'modal',
        'offcanvas',
        'popover',
        'scrollspy',
        'tab',
        'toast',
        'tooltip',
    ];
    if (in_array($name, $jsPlugins, true)) {
        $view = $this->getView();
        BootstrapPluginAsset::register($view);
        // 'popover', 'toast' and 'tooltip' plugins not activates via data attributes
        if ($this->clientOptions !== false || in_array($name, ['popover', 'toast', 'tooltip'], true)) {
            $name = ucfirst($name);
            $id = $this->options['id'];
            $options = empty($this->clientOptions) ? '{}' : Json::htmlEncode($this->clientOptions);
            $view->registerJs("(new bootstrap.$name('#$id', $options));");
        }
        $this->registerClientEvents($name);
    }
}