Class yii\bootstrap5\Tabs

All Classes | Properties | Methods
Inheritanceyii\bootstrap5\Tabs » yii\bootstrap5\Widget » yii\base\Widget
Uses Traitsyii\bootstrap5\BootstrapWidgetTrait
Source Code https://github.com/yiisoft/yii2-bootstrap5/blob/master/src/Tabs.php

Tabs renders a Tab bootstrap javascript component.

For example:

echo Tabs::widget([
    'items' => [
        [
            'label' => 'One',
            'content' => 'Anim pariatur cliche...',
            'active' => true
        ],
        [
            'label' => 'Two',
            'content' => 'Anim pariatur cliche...',
            'headerOptions' => [...],
            'options' => ['id' => 'myveryownID'],
        ],
        [
            'label' => 'Example',
            'url' => 'http://www.example.com',
        ],
        [
            'label' => 'Dropdown',
            'items' => [
                 [
                     'label' => 'DropdownA',
                     'content' => 'DropdownA, Anim pariatur cliche...',
                 ],
                 [
                     'label' => 'DropdownB',
                     'content' => 'DropdownB, Anim pariatur cliche...',
                 ],
                 [
                     'label' => 'External Link',
                     'url' => 'http://www.example.com',
                 ],
            ],
        ],
    ],
]);

See also:

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
$dropdownClass string Name of a class to use for rendering dropdowns withing this widget. yii\bootstrap5\Tabs
$encodeLabels boolean Whether the labels for header items should be HTML-encoded. yii\bootstrap5\Tabs
$headerOptions array List of HTML attributes for the header container tags. yii\bootstrap5\Tabs
$itemOptions array List of HTML attributes for the item container tags. yii\bootstrap5\Tabs
$items array List of tabs in the tabs widget. yii\bootstrap5\Tabs
$linkOptions array List of HTML attributes for the tab header link tags. yii\bootstrap5\Tabs
$navType string Specifies the Bootstrap tab styling. yii\bootstrap5\Tabs
$options array The HTML attributes for the widget container tag. yii\bootstrap5\Widget
$renderTabContent boolean Whether to render the tab-content container and its content. yii\bootstrap5\Tabs
$tabContentOptions array List of HTML attributes for the tab-content container. yii\bootstrap5\Tabs

Protected Properties

Hide inherited properties

Property Type Description Defined By
$panes array Tab panes (contents) yii\bootstrap5\Tabs

Public Methods

Hide inherited methods

Method Description Defined By
init() yii\bootstrap5\Tabs
renderPanes() Renders tab panes. yii\bootstrap5\Tabs
run() yii\bootstrap5\Tabs

Protected Methods

Hide inherited methods

Method Description Defined By
activateFirstVisibleTab() Sets the first visible tab as active. yii\bootstrap5\Tabs
hasActiveTab() Check for active tab yii\bootstrap5\Tabs
prepareItems() Renders tab items as specified on $items. yii\bootstrap5\Tabs
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

$dropdownClass public property

Name of a class to use for rendering dropdowns withing this widget. Defaults to yii\bootstrap5\Dropdown.

public string $dropdownClass = \yii\bootstrap5\Dropdown::class
$encodeLabels public property

Whether the labels for header items should be HTML-encoded.

public boolean $encodeLabels = true
$headerOptions public property

List of HTML attributes for the header container tags. This will be overwritten by the "headerOptions" set in individual $items.

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

public array $headerOptions = []
$itemOptions public property

List of HTML attributes for the item container tags. This will be overwritten by the "options" set in individual $items. The following special options are recognized:

  • tag: string, defaults to "div", the tag name of the item container tags.

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

public array $itemOptions = []
$items public property

List of tabs in the tabs widget. Each array element represents a single tab with the following structure:

  • label: string, required, the tab header label.
  • encode: bool, optional, whether this label should be HTML-encoded. This param will override global $this->encodeLabels param.
  • headerOptions: array, optional, the HTML attributes of the tab header.
  • linkOptions: array, optional, the HTML attributes of the tab header link tags.
  • content: string, optional, the content (HTML) of the tab pane.
  • view: array, optional, the view that should be rendered with Yii::$app->controller->view->render
  • url: string, optional, an external URL. When this is specified, clicking on this tab will bring the browser to this URL. This option is available since version 2.0.4.
  • options: array, optional, the HTML attributes of the tab pane container.
  • active: bool, optional, whether this item tab header and pane should be active. If no item is marked as 'active' explicitly - the first one will be activated.
  • visible: bool, optional, whether the item tab header and pane should be visible or not. Defaults to true.
  • disabled: bool, optional, whether the item tab header and pane should be disabled or not. Defaults to false.
  • items: array, optional, can be used instead of content to specify a dropdown items configuration array. Each item can hold three extra keys, besides the above ones:
    • active: bool, optional, whether the item tab header and pane should be visible or not.
    • content: string, required if items is not set. The content (HTML) of the tab pane.
    • options: optional, array, the HTML attributes of the tab content container.
public array $items = []
$linkOptions public property

List of HTML attributes for the tab header link tags. This will be overwritten by the "linkOptions" set in individual $items.

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

public array $linkOptions = []
$navType public property

Specifies the Bootstrap tab styling.

public string $navType = 'nav-tabs'
$panes protected property

Tab panes (contents)

protected array $panes = []
$renderTabContent public property

Whether to render the tab-content container and its content. You may set this property to be false so that you can manually render tab-content yourself in case your tab contents are complex.

public boolean $renderTabContent = true
$tabContentOptions public property

List of HTML attributes for the tab-content container. This will always contain the CSS class tab-content.

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

public array $tabContentOptions = []

Method Details

Hide inherited methods

activateFirstVisibleTab() protected method

Sets the first visible tab as active.

This method activates the first tab that is visible and not explicitly set to inactive ('active' => false).

protected void activateFirstVisibleTab ( )
throws Exception 

                protected function activateFirstVisibleTab(): void
{
    foreach ($this->items as $i => $item) {
        $active = ArrayHelper::getValue($item, 'active', null);
        $visible = ArrayHelper::getValue($item, 'visible', true);
        $disabled = ArrayHelper::getValue($item, 'disabled', false);
        if ($visible && $active !== false && $disabled !== true) {
            $this->items[$i]['active'] = true;
            return;
        }
    }
}
hasActiveTab() protected method

Check for active tab

protected boolean hasActiveTab ( )
return boolean

If there's active tab defined

 

                protected function hasActiveTab(): bool
{
    foreach ($this->items as $item) {
        if (isset($item['active']) && $item['active'] === true) {
            return true;
        }
    }
    return false;
}
init() public method

public void init ( )

                public function init(): void
{
    parent::init();
    Html::addCssClass($this->options, [
        'widget' => 'nav',
        $this->navType,
    ]);
    Html::addCssClass($this->tabContentOptions, [
        'panel' => 'tab-content',
    ]);
}
prepareItems() protected method

Renders tab items as specified on $items.

protected void prepareItems ( array &$items, string $prefix = '' )
$items array
$prefix string
throws \yii\base\InvalidConfigException
throws Exception 

                protected function prepareItems(array &$items, string $prefix = ''): void
{
    if (!$this->hasActiveTab()) {
        $this->activateFirstVisibleTab();
    }
    foreach ($items as $n => $item) {
        $options = array_merge($this->itemOptions, ArrayHelper::getValue($item, 'options', []));
        $options['id'] = ArrayHelper::getValue($options, 'id', $this->options['id'] . $prefix . '-tab' . $n);
        unset($items[$n]['options']['id']); // @see https://github.com/yiisoft/yii2-bootstrap4/issues/108#issuecomment-465219339
        if (!ArrayHelper::remove($item, 'visible', true)) {
            continue;
        }
        if (!array_key_exists('label', $item)) {
            throw new InvalidConfigException("The 'label' option is required.");
        }
        $selected = ArrayHelper::getValue($item, 'active', false);
        $disabled = ArrayHelper::getValue($item, 'disabled', false);
        $headerOptions = ArrayHelper::getValue($item, 'headerOptions', $this->headerOptions);
        if (isset($item['items'])) {
            $this->prepareItems($items[$n]['items'], '-dd' . $n);
            continue;
        } else {
            ArrayHelper::setValue($items[$n], 'options', $headerOptions);
            if (!isset($item['url'])) {
                ArrayHelper::setValue($items[$n], 'url', '#' . $options['id']);
                ArrayHelper::setValue($items[$n], 'linkOptions.data.bs-toggle', 'tab');
                ArrayHelper::setValue($items[$n], 'linkOptions.role', 'tab');
                ArrayHelper::setValue($items[$n], 'linkOptions.aria.controls', $options['id']);
                if (!$disabled) {
                    ArrayHelper::setValue($items[$n], 'linkOptions.aria.selected', $selected ? 'true' : 'false');
                }
            } else {
                continue;
            }
        }
        Html::addCssClass($options, [
            'widget' => 'tab-pane',
        ]);
        if ($selected) {
            Html::addCssClass($options, [
                'activate' => 'active',
            ]);
        }
        if ($this->renderTabContent) {
            $tag = ArrayHelper::remove($options, 'tag', 'div');
            $view = ArrayHelper::getValue($item, 'view');
            $content = ArrayHelper::getValue($item, 'content', '');
            if (!$content && $view) {
                $content = Yii::$app->view->renderFile($view[0], ArrayHelper::getValue($view, 1, []), Yii::$app->controller);
            }
            $this->panes[] = Html::tag($tag, $content, $options);
        }
    }
}
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 

                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

 

                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);
    }
}
renderPanes() public method

Renders tab panes.

public string renderPanes ( array $panes )
$panes array
return string

The rendering result.

 

                public function renderPanes(array $panes): string
{
    return $this->renderTabContent ? "\n" . Html::tag('div', implode("\n", $panes), $this->tabContentOptions) : '';
}
run() public method

public string run ( )
throws \yii\base\InvalidConfigException
throws Throwable 

                public function run(): string
{
    $this->registerPlugin('tab');
    $this->prepareItems($this->items);
    return Nav::widget([
        'dropdownClass' => $this->dropdownClass,
        'options' => ArrayHelper::merge([
            'role' => 'tablist',
        ], $this->options),
        'items' => $this->items,
        'encodeLabels' => $this->encodeLabels,
    ]) . $this->renderPanes($this->panes);
}