TabItem

API reference › Bootstrap 6 › item › TabItem

final readonly class	yii2\extensions\bootstrap6\item\TabItem
Uses traits	ItemTrait
Source	src/item/TabItem.php

Represents a Tabs item: a tab with its pane, a plain link, or a toggle that opens a Menu of tabs.

Properties

Property	Type	Description	Defined by
$active readonly constructor	bool|null	Whether the tab and its pane, the link, or the menu toggle are active, or null to let Tabs activate the first eligible tab when none is active; an active menu toggle needs no active item. Default: null.	TabItem
$content readonly constructor	string|Stringable|null	HTML content of the pane, or null for an empty pane. Default: null.	TabItem
$disabled readonly constructor	bool	Whether the tab button, the link, or the menu toggle is disabled; a disabled link loses its href and takes precedence over $active, and a disabled toggle is never marked active. Default: false.	TabItem
$encode readonly constructor	bool|null	Whether to HTML-encode $label, or null to use Tabs::$encodeLabels. Default: null.	TabItem
$headerOptions readonly constructor	array<array-key, mixed>	HTML attributes of the .nav-item element. Default: [].	TabItem
$items readonly constructor	array<array-key, MenuItem|string|TabItem>	Items of the menu toggled by the tab: tabs are rendered as menu buttons with their panes, tabs with a $url as menu links, tabs with their own items as nested .submenu panels; menu items and strings are passed to the Menu as is. Default: [].	TabItem
$label readonly constructor	string|Stringable	Label of the tab button, link, or menu toggle.	TabItem
$linkOptions readonly constructor	array<array-key, mixed>	HTML attributes of the tab button; its id defaults to {id}-tab{n}. Default: [].	TabItem
$options readonly constructor	array<array-key, mixed>	HTML attributes of the pane; its id defaults to {id}-pane{n}. Default: [].	TabItem
$url readonly constructor	array<array-key, mixed>|string|null	URL of a plain link tab, processed by Url::to(), or null for a tab with a pane. Default: null.	TabItem
$visible readonly constructor	bool	Whether to render the tab and its pane. Default: true.	TabItem

Methods

Method	Description	Defined by
fromArray() static	Creates an item from the array configuration documented in Tabs::$items.	TabItem
link() static	Creates a plain link tab.	TabItem
menu() static	Creates a toggle that opens a Menu of tabs.	TabItem
to() static	Creates a tab with its pane.	TabItem
withActive()	Returns a copy with the given active state.	TabItem
withContent()	Returns a copy with the given pane content.	TabItem
withDisabled()	Returns a copy with the given disabled state.	TabItem
withEncode()	Returns a copy with the given encoding flag.	TabItem
withHeaderOptions()	Returns a copy with the given .nav-item attributes.	TabItem
withItems()	Returns a copy with the given menu items.	TabItem
withLabel()	Returns a copy with the given label.	TabItem
withLinkOptions()	Returns a copy with the given tab button attributes.	TabItem
withOptions()	Returns a copy with the given pane attributes.	TabItem
withUrl()	Returns a copy with the given URL.	TabItem
withVisible()	Returns a copy with the given visibility.	TabItem

Method details

fromArray()

public static function fromArray(array<array-key, mixed> $config): self

Creates an item from the array configuration documented in Tabs::$items.

An active key, even null, makes the state explicit. Nested items arrays with a url key, even null, or without a label are converted through MenuItem::fromArray(), the others recursively through this method.

Parameters

Parameter	Type	Description
$config	array<array-key, mixed>	Item configuration.

Returns

self

Throws

• yii\base\InvalidConfigException: if the item, or one of its nested items, has no string|Stringable label.

link()

public static function link(string|Stringable $label, array<array-key, mixed>|string $url): self

Creates a plain link tab.

Parameters

Parameter	Type	Description
$label	string|Stringable	Link label.
$url	array<array-key, mixed>|string	URL processed by Url::to().

Returns

self

menu()

public static function menu(string|Stringable $label, array<array-key, array<string, mixed>|yii2\extensions\bootstrap6\item\MenuItem|string|yii2\extensions\bootstrap6\item\TabItem> $items): self

Creates a toggle that opens a Menu of tabs.

Parameters

Parameter	Type	Description
$label	string|Stringable	Toggle label.
$items	array<array-key, array<string, mixed>|MenuItem|string|TabItem>	Tabs rendered as menu buttons (menu links when they have a URL, nested .submenu panels when they have items), menu items, or strings; arrays are converted as in fromArray().

Returns

self

to()

public static function to(string|Stringable $label, string|Stringable|null $content = null): self

Creates a tab with its pane.

Parameters

Parameter	Type	Description
$label	string|Stringable	Tab label.
$content	string|Stringable|null	HTML content of the pane.

Returns

self

withActive()

public function withActive(bool|null $active): self

Returns a copy with the given active state.

Parameters

Parameter	Type	Description
$active	bool|null

Returns

self

withContent()

public function withContent(string|Stringable|null $content): self

Returns a copy with the given pane content.

Parameters

Parameter	Type	Description
$content	string|Stringable|null

Returns

self

withDisabled()

public function withDisabled(bool $disabled): self

Returns a copy with the given disabled state.

Parameters

Parameter	Type	Description
$disabled	bool

Returns

self

withEncode()

public function withEncode(bool|null $encode): self

Returns a copy with the given encoding flag.

Parameters

Parameter	Type	Description
$encode	bool|null

Returns

self

withHeaderOptions()

public function withHeaderOptions(array<array-key, mixed> $headerOptions): self

Returns a copy with the given .nav-item attributes.

Parameters

Parameter	Type	Description
$headerOptions	array<array-key, mixed>	HTML attributes of the .nav-item element.

Returns

self

withItems()

public function withItems(array<array-key, array<string, mixed>|yii2\extensions\bootstrap6\item\MenuItem|string|yii2\extensions\bootstrap6\item\TabItem> $items): self

Returns a copy with the given menu items.

Parameters

Parameter	Type	Description
$items	array<array-key, array<string, mixed>|MenuItem|string|TabItem>	Tabs rendered as menu buttons (menu links when they have a URL, nested .submenu panels when they have items), menu items, or strings; arrays are converted as in fromArray().

Returns

self

withLabel()

public function withLabel(string|Stringable $label): self

Returns a copy with the given label.

Parameters

Parameter	Type	Description
$label	string|Stringable

Returns

self

withLinkOptions()

public function withLinkOptions(array<array-key, mixed> $linkOptions): self

Returns a copy with the given tab button attributes.

Parameters

Parameter	Type	Description
$linkOptions	array<array-key, mixed>	HTML attributes of the tab button.

Returns

self

withOptions()

public function withOptions(array<array-key, mixed> $options): self

Returns a copy with the given pane attributes.

Parameters

Parameter	Type	Description
$options	array<array-key, mixed>	HTML attributes of the pane.

Returns

self

withUrl()

public function withUrl(array<array-key, mixed>|string|null $url): self

Returns a copy with the given URL.

Parameters

Parameter	Type	Description
$url	array<array-key, mixed>|string|null	URL processed by Url::to(), or null for a tab with a pane.

Returns

self

withVisible()

public function withVisible(bool $visible): self

Returns a copy with the given visibility.

Parameters

Parameter	Type	Description
$visible	bool

Returns

self