Class yii\bootstrap\Tabs

All Classes | Properties | Methods | Events

Inheritance	yii\bootstrap\Tabs » yii\bootstrap\Widget » yii\base\Widget » yii\base\Component » yii\base\BaseObject
Implements	yii\base\Configurable, yii\base\ViewContextInterface
Uses Traits	yii\bootstrap\BootstrapWidgetTrait
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2-bootstrap/blob/master/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',
                 ],
            ],
        ],
    ],
]);

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$autoIdPrefix	string	The prefix to the automatically generated widget IDs.	yii\base\Widget
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component. This property is read-only.	yii\base\Component
$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
$counter	integer	A counter used to generate $id for widgets.	yii\base\Widget
$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
$id	string\|null	ID of the widget. Note that the type of this property differs in getter and setter. See getId() and setId() for details.	yii\base\Widget
$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
$stack	yii\base\Widget[]	The widgets that are currently being rendered (not ended).	yii\base\Widget
$tabContentOptions	array	List of HTML attributes for the `tab-content` container.	yii\bootstrap\Tabs
$view	yii\web\View	The view object that can be used to render views or view files. Note that the type of this property differs in getter and setter. See getView() and setView() for details.	yii\base\Widget
$viewPath	string	The directory containing the view files for this widget. This property is read-only.	yii\base\Widget

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\BaseObject
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()	Constructor.	yii\base\BaseObject
__get()	Returns the value of an object property.	yii\base\BaseObject
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\BaseObject
__set()	Sets value of an object property.	yii\base\BaseObject
__unset()	Sets an object property to null.	yii\base\BaseObject
afterRun()	This method is invoked right after a widget is executed.	yii\base\Widget
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
beforeRun()	This method is invoked right before the widget is executed.	yii\base\Widget
begin()	Begins a widget.	yii\base\Widget
behaviors()	Returns a list of behaviors that this component should behave as.	yii\base\Component
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\BaseObject
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\BaseObject
className()	Returns the fully qualified name of this class.	yii\base\BaseObject
detachBehavior()	Detaches a behavior from the component.	yii\base\Component
detachBehaviors()	Detaches all behaviors from the component.	yii\base\Component
end()	Ends a widget.	yii\base\Widget
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
getId()	Returns the ID of the widget.	yii\base\Widget
getView()		yii\bootstrap\BootstrapWidgetTrait
getViewPath()	Returns the directory containing the view files for this widget.	yii\base\Widget
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\BaseObject
hasProperty()	Returns a value indicating whether a property is defined.	yii\base\BaseObject
init()	Initializes the widget.	yii\bootstrap\Tabs
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
render()	Renders a view.	yii\base\Widget
renderFile()	Renders a view file.	yii\base\Widget
renderPanes()	Renders tab panes.	yii\bootstrap\Tabs
run()	Renders the widget.	yii\bootstrap\Tabs
setId()	Sets the ID of the widget.	yii\base\Widget
setView()	Sets the view object to be used by this widget.	yii\base\Widget
trigger()	Triggers an event.	yii\base\Component
widget()	Creates a widget instance and runs it.	yii\base\Widget

Protected Methods

Hide inherited methods

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

Events

Hide inherited events

Event	Type	Description	Defined By
EVENT_AFTER_RUN	yii\base\WidgetEvent	An event raised right after executing a widget. (available since version 2.0.11)	yii\base\Widget
EVENT_BEFORE_RUN	yii\base\WidgetEvent	An event raised right before executing a widget. (available since version 2.0.11)	yii\base\Widget
EVENT_INIT	yii\base\Event	An event that is triggered when the widget is initialized via init(). (available since version 2.0.11)	yii\base\Widget

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.

public array $tabContentOptions = []

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 ( )