Class yii\bootstrap\Tabs

Inheritanceyii\bootstrap\Tabs » yii\bootstrap\Widget » yii\base\Widget
Uses Traitsyii\bootstrap\BootstrapWidgetTrait
Available since version2.0
Source Code https://github.com/yiisoft/yii2-bootstrap/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 http://getbootstrap.com/javascript/#tabs.

Public Properties

Hide inherited properties

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

Public Methods

Hide inherited methods

MethodDescriptionDefined By
getView() yii\bootstrap\BootstrapWidgetTrait
init() Initializes the widget. yii\bootstrap\Tabs
renderPanes() Renders tab panes. yii\bootstrap\Tabs
run() Renders the widget. yii\bootstrap\Tabs

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
activateFirstVisibleTab() Sets the first visible tab as active. yii\bootstrap\Tabs
hasActiveTab() yii\bootstrap\Tabs
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
renderDropdown() Normalizes dropdown item options by removing tab specific keys content and contentOptions, and also configure panes accordingly. yii\bootstrap\Tabs
renderItems() Renders tab items as specified on $items. yii\bootstrap\Tabs

Property Details

$dropdownClass public property (available since version 2.0.7)

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

public string $dropdownClass 'yii\bootstrap\Dropdown'
$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.
  • 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.
  • 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.
    • contentOptions: 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'
$renderTabContent public property (available since version 2.0.1)

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 (available since version 2.0.7)

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.

Method Details

activateFirstVisibleTab() protected method (available since version 2.0.7)

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 ( )
hasActiveTab() protected method

protected boolean hasActiveTab ( )
return boolean

If there's active tab defined

init() public method

Initializes the widget.

public void init ( )
renderDropdown() protected method

Normalizes dropdown item options by removing tab specific keys content and contentOptions, and also configure panes accordingly.

protected boolean renderDropdown ( $itemNumber, &$items, &$panes )
$itemNumber string

Number of the item

$items array

The dropdown items configuration.

$panes array

The panes reference array.

return boolean

Whether any of the dropdown items is active or not.

throws \yii\base\InvalidConfigException
renderItems() protected method

Renders tab items as specified on $items.

protected string renderItems ( )
return string

The rendering result.

throws \yii\bootstrap\InvalidConfigException.
renderPanes() public method (available since version 2.0.7)

Renders tab panes.

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

The rendering result.

run() public method

Renders the widget.

public void run ( )