NavBar

API reference › Bootstrap 6 › NavBar

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

Renders a Bootstrap navbar whose content collapses into a drawer below the $expand breakpoint.

Content captured between begin() and end() is rendered inside the .drawer-body, or directly inside the navbar when $drawerOptions is false.

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`
`$brandImage`	`string\|false`	Source of the brand image, or `false` to render no image. Default: `false`.	`NavBar`
`$brandImageOptions`	`array<array-key, mixed>`	HTML attributes of the brand image. Default: `[]`.	`NavBar`
`$brandLabel`	`string\|Stringable\|false`	Brand text, or `false` to render no text. Default: `false`.	`NavBar`
`$brandOptions`	`array<array-key, mixed>`	HTML attributes of the `.navbar-brand` element. Default: `[]`.	`NavBar`
`$brandUrl`	`array<array-key, mixed>\|string\|false\|null`	Brand URL processed by `Url::to()`; `false` uses the application home URL and `null` renders a `<span>` instead of a link. Default: `false`.	`NavBar`
`$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`
`$drawerOptions`	`array<string, mixed>\|false`	Drawer configuration, or `false` to render the content inline without toggler and drawer. Default: `[]`.	`NavBar`
`$encodeBrandLabel`	`bool`	Whether to HTML-encode `$brandLabel`. Default: `true`.	`NavBar`
`$expand`	`yii2\extensions\bootstrap6\enum\Breakpoint\|string\|false\|null`	Breakpoint from which the navbar expands and the drawer content renders inline; `null` always expands and `false` never expands. Default: `\yii2\extensions\bootstrap6\enum\Breakpoint::LG`.	`NavBar`
`$id`	`string`	Id of the widget.	`yii\base\Widget`
`$innerContainerOptions`	`array<array-key, mixed>`	HTML attributes of the inner container; the `class` defaults to `container-fluid`. Default: `[]`.	`NavBar`
`$options`	`array<string, mixed>`	HTML attributes of the widget container tag. Default: `[]`.	`Widget`
`$renderInnerContainer`	`bool`	Whether to wrap the navbar content in the inner container. Default: `true`.	`NavBar`
`$screenReaderToggleText`	`string\|Stringable\|null`	Accessible label of the toggler, or `null` to use the translated `Toggle navigation` text. Default: `null`.	`NavBar`
`$togglerContent`	`string\|Stringable`	HTML content of the toggler. Default: `'<span class="navbar-toggler-icon" aria-hidden="true"></span>'`.	`NavBar`
`$togglerOptions`	`array<array-key, mixed>`	HTML attributes of the toggler button. Default: `[]`.	`NavBar`
`$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`

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`
`addTogglerAttribute()`	Sets an HTML attribute value of the toggler.	`TogglerAttributesTrait`
`addTogglerClass()`	Adds one or more CSS classes to the existing toggler classes; duplicated classes are collapsed.	`TogglerAttributesTrait`
`addTogglerCssStyle()`	Adds CSS style properties to the `style` attribute of the toggler.	`TogglerAttributesTrait`
`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, validates `$expand`, and starts capturing the content.	`NavBar`
`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()`	Returns the complete navbar markup wrapping the captured content.	`NavBar`
`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`
`renderBrand()` protected	Renders the `.navbar-brand` element, or an empty string when there is no brand image and no brand label.	`NavBar`
`renderDrawerBegin()` protected	Renders the opening part of the drawer: the `<dialog>`, its header, and the opening `.drawer-body` tag.	`NavBar`
`renderToggler()` protected	Renders the toggler button that opens the drawer.	`NavBar`
`togglerOptions()` protected	Returns `$togglerOptions` by reference.	`NavBar`

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

$drawerOptions

public array<string, mixed>|false $drawerOptions = []

Drawer configuration, or false to render the content inline without toggler and drawer.

title: string, drawer title, HTML-encoded. Defaults to the translated Menu text.
placement: DrawerPlacement|string, side the drawer slides in from, validated when rendered. Defaults to DrawerPlacement::END.
options: array, HTML attributes of the <dialog> element; its id defaults to {id}-drawer.
bodyOptions: array, HTML attributes of the .drawer-body element.

Method details

init()

public function init(): void

Initializes the widget, validates $expand, and starts capturing the content.

Throws

yii\base\InvalidConfigException: if $expand is a string that is not a Breakpoint value.

run()

public function run(): string

Returns the complete navbar markup wrapping the captured content.

Returns

string

renderBrand()

protected function renderBrand(): string

Renders the .navbar-brand element, or an empty string when there is no brand image and no brand label.

Returns

string

renderDrawerBegin()

protected function renderDrawerBegin(): string

Renders the opening part of the drawer: the <dialog>, its header, and the opening .drawer-body tag.

Returns

string

renderToggler()

protected function renderToggler(): string

Renders the toggler button that opens the drawer.

Returns

string

togglerOptions()

protected function togglerOptions(): mixed[]

Returns $togglerOptions by reference.

Returns

mixed[]