MenuItem

API reference › Bootstrap 6 › item › MenuItem

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

Represents a Menu item: a link, a button, a submenu, a header, a text, or a divider.

Properties

Property	Type	Description	Defined by
$active readonly constructor	bool|null	Whether the item is active, or null to let Nav detect it from $url. Default: null.	MenuItem
$disabled readonly constructor	bool	Whether the item is disabled; it takes precedence over $active. Default: false.	MenuItem
$encode readonly constructor	bool|null	Whether to HTML-encode $label, or null to use the widget encodeLabels. Default: null.	MenuItem
$items readonly constructor	array<array-key, MenuItem|string>	Items of the nested submenu; the string - renders a divider, any other string is rendered as is. Default: [].	MenuItem
$label readonly constructor	string|Stringable	Label of a link, button, or submenu toggle, or content of a header or text; empty for a divider.	MenuItem
$linkOptions readonly constructor	array<array-key, mixed>	HTML attributes of the .menu-item element. Default: [].	MenuItem
$options readonly constructor	array<array-key, mixed>	HTML attributes of the .submenu wrapper, header, text, or divider. Default: [].	MenuItem
$submenuOptions readonly constructor	array<array-key, mixed>	HTML attributes of the nested .menu, merged over the widget submenuOptions. Default: [].	MenuItem
$type readonly constructor	yii2\extensions\bootstrap6\enum\MenuItemType	Kind of the item, which selects the rendered element.	MenuItem
$url readonly constructor	array<array-key, mixed>|string|null	URL of a link, processed by Url::to(). Default: null.	MenuItem
$visible readonly constructor	bool	Whether to render the item. Default: true.	MenuItem

Methods

Method	Description	Defined by
button() static	Creates a <button> item.	MenuItem
divider() static	Creates an <hr class="menu-divider"> item.	MenuItem
fromArray() static	Creates an item from the array configuration documented in Menu::$items.	MenuItem
header() static	Creates an <h6 class="menu-header"> item.	MenuItem
link() static	Creates a link item.	MenuItem
submenu() static	Creates a submenu: a toggle button followed by a nested .menu, inside a .submenu wrapper.	MenuItem
text() static	Creates a <span class="menu-text"> item.	MenuItem
withActive()	Returns a copy with the given active state.	MenuItem
withDisabled()	Returns a copy with the given disabled state.	MenuItem
withEncode()	Returns a copy with the given encoding flag.	MenuItem
withItems()	Returns a copy with the given nested items.	MenuItem
withLabel()	Returns a copy with the given label or content.	MenuItem
withLinkOptions()	Returns a copy with the given .menu-item attributes.	MenuItem
withOptions()	Returns a copy with the given wrapper, header, text, or divider attributes.	MenuItem
withSubmenuOptions()	Returns a copy with the given nested .menu attributes.	MenuItem
withType()	Returns a copy with the given kind.	MenuItem
withUrl()	Returns a copy with the given URL.	MenuItem
withVisible()	Returns a copy with the given visibility.	MenuItem

Method details

button()

public static function button(string|Stringable $label): self

Creates a <button> item.

Parameters

Parameter	Type	Description
$label	string|Stringable	Button label.

Returns

self

divider()

public static function divider(): self

Creates an <hr class="menu-divider"> item.

Returns

self

fromArray()

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

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

The divider, header, and text keys select those kinds, in that order; otherwise, a non-empty items key selects a submenu, a url key (even null) a link, and its absence a button. Nested items arrays are converted recursively; strings are kept.

Parameters

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

Returns

self

Throws

• yii\base\InvalidConfigException: if a link, button, or submenu has no string|Stringable label.

header()

public static function header(string|Stringable $content): self

Creates an <h6 class="menu-header"> item.

Parameters

Parameter	Type	Description
$content	string|Stringable	Header content.

Returns

self

link()

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

Creates a link item.

Parameters

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

Returns

self

submenu()

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

Creates a submenu: a toggle button followed by a nested .menu, inside a .submenu wrapper.

Parameters

Parameter	Type	Description
$label	string|Stringable	Toggle label.
$items	array<array-key, array<string, mixed>|MenuItem|string>	Items of the nested menu; arrays are converted through fromArray().

Returns

self

text()

public static function text(string|Stringable $content): self

Creates a <span class="menu-text"> item.

Parameters

Parameter	Type	Description
$content	string|Stringable	Text content.

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

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

withItems()

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

Returns a copy with the given nested items.

Parameters

Parameter	Type	Description
$items	array<array-key, array<string, mixed>|MenuItem|string>	Items of the nested menu; arrays are converted through fromArray().

Returns

self

withLabel()

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

Returns a copy with the given label or content.

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 .menu-item attributes.

Parameters

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

Returns

self

withOptions()

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

Returns a copy with the given wrapper, header, text, or divider attributes.

Parameters

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

Returns

self

withSubmenuOptions()

public function withSubmenuOptions(array<array-key, mixed> $submenuOptions): self

Returns a copy with the given nested .menu attributes.

Parameters

Parameter	Type	Description
$submenuOptions	array<array-key, mixed>	HTML attributes of the nested .menu.

Returns

self

withType()

public function withType(yii2\extensions\bootstrap6\enum\MenuItemType $type): self

Returns a copy with the given kind.

Parameters

Parameter	Type	Description
$type	yii2\extensions\bootstrap6\enum\MenuItemType

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

Returns

self

withVisible()

public function withVisible(bool $visible): self

Returns a copy with the given visibility.

Parameters

Parameter	Type	Description
$visible	bool

Returns

self