Tabs

API reference › Bootstrap 6 › Tabs

class	`yii2\extensions\bootstrap6\Tabs`
Extends	`Widget` » `yii\base\Widget` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\ViewContextInterface`, `yii\base\Configurable`
Uses traits	`AttributesTrait`, `BootstrapWidgetTrait`
Source	`src/Tabs.php`

Renders a nav of tab buttons and the matching .tab-pane panels for the Bootstrap Tab plugin.

When no item is active, the first visible, enabled pane is activated. Tab plugin events bubble up to the nav element, so $clientEvents such as shown.bs.tab can be attached to it.

Properties

Property	Type	Description	Defined by
`$autoIdPrefix` static	`string`	The prefix to the automatically generated widget IDs. Default: `'w'`.	`yii\base\Widget`
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$clientEvents`	`array<string,` `yii\web\JsExpression\|string>`	Event handlers attached to the widget element, as event name => JavaScript handler source. Default: `[]`.	`BootstrapWidgetTrait`
`$clientOptions`	`array<string, mixed>\|false`	Options passed to the plugin constructor, or `false` to skip the JavaScript initialization. Default: `[]`.	`BootstrapWidgetTrait`
`$encodeLabels`	`bool`	Whether to HTML-encode the item labels; the item `encode` option takes precedence. Default: `true`.	`Tabs`
`$headerOptions`	`array<array-key, mixed>`	HTML attributes of every `.nav-item` element, merged with the item `headerOptions`. Default: `[]`.	`Tabs`
`$id`	`string`	Id of the widget.	`yii\base\Widget`
`$itemOptions`	`array<array-key, mixed>`	HTML attributes of every `.tab-pane` element, merged with the item `options`; the `tag` option sets the tag name (default `div`). Default: `[]`.	`Tabs`
`$items`	`array<array-key, array<array-key, mixed>\|string\|yii2\extensions\bootstrap6\item\TabItem>`	Tab items: `TabItem` instances, arrays converted through `TabItem::fromArray()`, or strings rendered as is. Default: `[]`.	`Tabs`
`$linkOptions`	`array<array-key, mixed>`	HTML attributes of every tab button, merged with the item `linkOptions`. Default: `[]`.	`Tabs`
`$menuClass`	`class-string<Menu>`	Class of the menu widget. Default: `\yii2\extensions\bootstrap6\Menu::class`.	`Tabs`
`$navType`	`yii2\extensions\bootstrap6\enum\NavStyle\|string`	Nav style, such as `NavStyle::PILLS`; `NavStyle::PILLS_VERTICAL` adds `aria-orientation="vertical"`. Default: `\yii2\extensions\bootstrap6\enum\NavStyle::TABS`.	`Tabs`
`$options`	`array<string, mixed>`	HTML attributes of the widget container tag. Default: `[]`.	`Widget`
`$renderTabContent`	`bool`	Whether to render the `.tab-content` container; set it to `false` to render the panes yourself. Default: `true`.	`Tabs`
`$tabContentOptions`	`array<array-key, mixed>`	HTML attributes of the `.tab-content` container. Default: `[]`.	`Tabs`
`$view`	`yii\web\View`	The view object that can be used to render views or view files.	`yii\base\Widget`
`$viewPath` read-only	`string`	The directory containing the view files for this widget.	`yii\base\Widget`
`$panes` protected	`list<string>`	Rendered tab panes. Default: `[]`.	`Tabs`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\Component`
`__clone()`	This method is called after the object is created by cloning an existing one.	`yii\base\Component`
`__get()`	Returns the value of a component property.	`yii\base\Component`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\Component`
`__set()`	Sets the value of a component property.	`yii\base\Component`
`__unset()`	Sets a component property to be null.	`yii\base\Component`
`addAttributes()`	Adds a set of HTML attributes; attributes already set with the same name are replaced.	`AttributesTrait`
`addClass()`	Adds one or more CSS classes to the existing classes; duplicated classes are collapsed.	`AttributesTrait`
`addCssStyle()`	Adds CSS style properties to the `style` attribute.	`AttributesTrait`
`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`
`attribute()`	Sets an HTML attribute value.	`AttributesTrait`
`beforeRun()`	This method is invoked right before the widget is executed.	`yii\base\Widget`
`begin()` static	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\Component`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\Component`
`class()`	Replaces the existing CSS classes with the specified ones.	`AttributesTrait`
`className()` static	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()` static	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()`	Returns the view object that can be used to render views or view files.	`yii\base\Widget`
`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\Component`
`hasProperty()`	Returns a value indicating whether a property is defined for this component.	`yii\base\Component`
`init()`	Initializes the widget and validates `$navType`.	`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`
`run()`		`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()` static	Creates a widget instance and runs it.	`yii\base\Widget`
`pluginInitialization()` protected	Returns the JavaScript that initializes a plugin with its normalized constructor options.	`BootstrapWidgetTrait`
`registerClientEvents()` protected	Registers the JavaScript event handlers listed in `$clientEvents` at `View::POS_END`.	`BootstrapWidgetTrait`
`registerPlugin()` protected	Registers the plugin asset, the plugin initialization when needed, and the `$clientEvents`.	`BootstrapWidgetTrait`
`renderPanes()` protected	Renders the `.tab-content` container with the panes, or an empty string when `$renderTabContent` is `false`.	`Tabs`

Events

Event	Type	Description	Defined by
`EVENT_INIT`	`yii\base\Event`	An event that is triggered when the widget is initialized via `init()`. Event name: `'init'`. Available since 2.0.11.	`yii\base\Widget`
`EVENT_BEFORE_RUN`	`yii\base\WidgetEvent`	An event raised right before executing a widget. Event name: `'beforeRun'`. Available since 2.0.11.	`yii\base\Widget`
`EVENT_AFTER_RUN`	`yii\base\WidgetEvent`	An event raised right after executing a widget. Event name: `'afterRun'`. Available since 2.0.11.	`yii\base\Widget`

Property details

$items

public array<array-key, array<array-key, mixed>|string|yii2\extensions\bootstrap6\item\TabItem> $items = []

Tab items: TabItem instances, arrays converted through TabItem::fromArray(), or strings rendered as is.

An array item accepts the following options:

label: string|Stringable, required.
content: string|Stringable, HTML content of the pane.
active: bool, whether the tab and its pane, the link tab, or the menu toggle are active.
disabled: bool, disables the tab button, the link tab, which loses its href, or the menu toggle; a disabled toggle is never marked active.
visible: bool, whether to render the tab and its pane. Defaults to true.
encode: bool, whether to HTML-encode the label.
headerOptions: array, HTML attributes of the .nav-item element.
linkOptions: array, HTML attributes of the tab button; its id defaults to {id}-tab{n}.
options: array, HTML attributes of the pane; its id defaults to {id}-pane{n}.
url: array|string, renders a plain link that takes the active and disabled state instead of a tab, processed by Url::to().
items: array, tab items rendered inside a Menu, with the same options; items with a url key, even null, or without a label are Menu::$items. A nested item with its own items renders as a .submenu (its headerOptions apply to the .submenu wrapper), and an active nested tab activates the outer toggle only. The Bootstrap docs advise against menus in tabbed interfaces for accessibility reasons.

Method details

init()

public function init(): void

Initializes the widget and validates $navType.

Throws

yii\base\InvalidConfigException: if $navType is not a NavStyle value.

run()

public function run(): string

Returns

string

Throws

yii\base\InvalidConfigException: if an item has no label.

renderPanes()

protected function renderPanes(list<string> $panes): string

Renders the .tab-content container with the panes, or an empty string when $renderTabContent is false.

Parameters

Parameter	Type	Description
`$panes`	`list<string>`	Rendered panes.

Returns

string