# NavBar

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

[API reference](/docs/api/index.md) › [Bootstrap 6](/docs/extensions/bootstrap6/reference/index.md) › NavBar

| class | `yii2\extensions\bootstrap6\NavBar` |
| --- | --- |
| Extends | [`Widget`](/docs/extensions/bootstrap6/reference/widget/index.md) » [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) » [`yii\base\Component`](/docs/api/yii/base/component/index.md) » [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| Implements | [`yii\base\ViewContextInterface`](/docs/api/yii/base/viewcontextinterface/index.md), [`yii\base\Configurable`](/docs/api/yii/base/configurable/index.md) |
| Uses traits | [`TogglerAttributesTrait`](/docs/extensions/bootstrap6/reference/togglerattributestrait/index.md), [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/index.md), [`BootstrapWidgetTrait`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md) |
| Source | [`src/NavBar.php`](https://github.com/yii2-extensions/bootstrap6/blob/main/src/NavBar.php#L26) |

Renders a Bootstrap navbar whose content collapses into a drawer below the [`$expand`](/docs/extensions/bootstrap6/reference/navbar/index.md#property-expand) breakpoint.

Content captured between [`begin()`](/docs/api/yii/base/widget/index.md#method-begin) and [`end()`](/docs/api/yii/base/widget/index.md#method-end) is rendered inside the `.drawer-body`, or directly inside the
navbar when [`$drawerOptions`](/docs/extensions/bootstrap6/reference/navbar/index.md#property-drawerOptions) is `false`.

See also: <https://getbootstrap.com/docs/6.0/components/navbar/>.

## Properties

| Property | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="property-autoIdPrefix"></span>[`$autoIdPrefix`](/docs/api/yii/base/widget/index.md#property-autoIdPrefix) static | `string` | The prefix to the automatically generated widget IDs. Default: `'w'`. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="property-behaviors"></span>[`$behaviors`](/docs/api/yii/base/component/index.md#property-behaviors) read-only | `array<`[`yii\base\Behavior`](/docs/api/yii/base/behavior/index.md)`<static>>` | List of behaviors attached to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="property-brandImage"></span>`$brandImage` | `string\|false` | Source of the brand image, or `false` to render no image. Default: `false`. | `NavBar` |
| <span id="property-brandImageOptions"></span>`$brandImageOptions` | `array<array-key, mixed>` | HTML attributes of the brand image. Default: `[]`. | `NavBar` |
| <span id="property-brandLabel"></span>`$brandLabel` | `string\|`[`Stringable`](https://www.php.net/manual/en/class.stringable.php)`\|false` | Brand text, or `false` to render no text. Default: `false`. | `NavBar` |
| <span id="property-brandOptions"></span>`$brandOptions` | `array<array-key, mixed>` | HTML attributes of the `.navbar-brand` element. Default: `[]`. | `NavBar` |
| <span id="property-brandUrl"></span>`$brandUrl` | `array<array-key, mixed>\|string\|false\|null` | Brand URL processed by [`Url::to()`](/docs/api/yii/helpers/baseurl/index.md#method-to); `false` uses the application home URL and `null` renders a `<span>` instead of a link. Default: `false`. | `NavBar` |
| <span id="property-clientEvents"></span>[`$clientEvents`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#property-clientEvents) | `array<string,` [`yii\web\JsExpression`](/docs/api/yii/web/jsexpression/index.md)`\|string>` | Event handlers attached to the widget element, as event name => JavaScript handler source. Default: `[]`. | [`BootstrapWidgetTrait`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md) |
| <span id="property-clientOptions"></span>[`$clientOptions`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#property-clientOptions) | `array<string, mixed>\|false` | Options passed to the plugin constructor, or `false` to skip the JavaScript initialization. Default: `[]`. | [`BootstrapWidgetTrait`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md) |
| [`$drawerOptions`](#property-drawerOptions) | `array<string, mixed>\|false` | Drawer configuration, or `false` to render the content inline without toggler and drawer. Default: `[]`. | `NavBar` |
| <span id="property-encodeBrandLabel"></span>`$encodeBrandLabel` | `bool` | Whether to HTML-encode [`$brandLabel`](/docs/extensions/bootstrap6/reference/navbar/index.md#property-brandLabel). Default: `true`. | `NavBar` |
| <span id="property-expand"></span>`$expand` | [`yii2\extensions\bootstrap6\enum\Breakpoint`](/docs/extensions/bootstrap6/reference/enum/breakpoint/index.md)`\|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` |
| <span id="property-id"></span>[`$id`](/docs/api/yii/base/widget/index.md#property-id) | `string` | Id of the widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="property-innerContainerOptions"></span>`$innerContainerOptions` | `array<array-key, mixed>` | HTML attributes of the inner container; the `class` defaults to `container-fluid`. Default: `[]`. | `NavBar` |
| <span id="property-options"></span>[`$options`](/docs/extensions/bootstrap6/reference/widget/index.md#property-options) | `array<string, mixed>` | HTML attributes of the widget container tag. Default: `[]`. | [`Widget`](/docs/extensions/bootstrap6/reference/widget/index.md) |
| <span id="property-renderInnerContainer"></span>`$renderInnerContainer` | `bool` | Whether to wrap the navbar content in the inner container. Default: `true`. | `NavBar` |
| <span id="property-screenReaderToggleText"></span>`$screenReaderToggleText` | `string\|`[`Stringable`](https://www.php.net/manual/en/class.stringable.php)`\|null` | Accessible label of the toggler, or `null` to use the translated `Toggle navigation` text. Default: `null`. | `NavBar` |
| <span id="property-togglerContent"></span>`$togglerContent` | `string\|`[`Stringable`](https://www.php.net/manual/en/class.stringable.php) | HTML content of the toggler. Default: `'<span class="navbar-toggler-icon" aria-hidden="true"></span>'`. | `NavBar` |
| <span id="property-togglerOptions"></span>`$togglerOptions` | `array<array-key, mixed>` | HTML attributes of the toggler button. Default: `[]`. | `NavBar` |
| <span id="property-view"></span>[`$view`](/docs/api/yii/base/widget/index.md#property-view) | [`yii\web\View`](/docs/api/yii/web/view/index.md) | The view object that can be used to render views or view files. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="property-viewPath"></span>[`$viewPath`](/docs/api/yii/base/widget/index.md#property-viewPath) read-only | `string` | The directory containing the view files for this widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |

## Methods

| Method | Description | Defined by |
| --- | --- | --- |
| <span id="method-__construct"></span>[`__construct()`](/docs/api/yii/base/baseobject/index.md#method-__construct) | Constructor. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-__call"></span>[`__call()`](/docs/api/yii/base/component/index.md#method-__call) | Calls the named method which is not a class method. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__clone"></span>[`__clone()`](/docs/api/yii/base/component/index.md#method-__clone) | This method is called after the object is created by cloning an existing one. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__get"></span>[`__get()`](/docs/api/yii/base/component/index.md#method-__get) | Returns the value of a component property. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__isset"></span>[`__isset()`](/docs/api/yii/base/component/index.md#method-__isset) | Checks if a property is set, i.e. defined and not null. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__set"></span>[`__set()`](/docs/api/yii/base/component/index.md#method-__set) | Sets the value of a component property. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__unset"></span>[`__unset()`](/docs/api/yii/base/component/index.md#method-__unset) | Sets a component property to be null. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-addAttributes"></span>[`addAttributes()`](/docs/extensions/bootstrap6/reference/attributestrait/index.md#method-addAttributes) | Adds a set of HTML attributes; attributes already set with the same name are replaced. | [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/index.md) |
| <span id="method-addClass"></span>[`addClass()`](/docs/extensions/bootstrap6/reference/attributestrait/index.md#method-addClass) | Adds one or more CSS classes to the existing classes; duplicated classes are collapsed. | [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/index.md) |
| <span id="method-addCssStyle"></span>[`addCssStyle()`](/docs/extensions/bootstrap6/reference/attributestrait/index.md#method-addCssStyle) | Adds CSS style properties to the `style` attribute. | [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/index.md) |
| <span id="method-addTogglerAttribute"></span>[`addTogglerAttribute()`](/docs/extensions/bootstrap6/reference/togglerattributestrait/index.md#method-addTogglerAttribute) | Sets an HTML attribute value of the toggler. | [`TogglerAttributesTrait`](/docs/extensions/bootstrap6/reference/togglerattributestrait/index.md) |
| <span id="method-addTogglerClass"></span>[`addTogglerClass()`](/docs/extensions/bootstrap6/reference/togglerattributestrait/index.md#method-addTogglerClass) | Adds one or more CSS classes to the existing toggler classes; duplicated classes are collapsed. | [`TogglerAttributesTrait`](/docs/extensions/bootstrap6/reference/togglerattributestrait/index.md) |
| <span id="method-addTogglerCssStyle"></span>[`addTogglerCssStyle()`](/docs/extensions/bootstrap6/reference/togglerattributestrait/index.md#method-addTogglerCssStyle) | Adds CSS style properties to the `style` attribute of the toggler. | [`TogglerAttributesTrait`](/docs/extensions/bootstrap6/reference/togglerattributestrait/index.md) |
| <span id="method-afterRun"></span>[`afterRun()`](/docs/api/yii/base/widget/index.md#method-afterRun) | This method is invoked right after a widget is executed. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-attachBehavior"></span>[`attachBehavior()`](/docs/api/yii/base/component/index.md#method-attachBehavior) | Attaches a behavior to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-attachBehaviors"></span>[`attachBehaviors()`](/docs/api/yii/base/component/index.md#method-attachBehaviors) | Attaches a list of behaviors to the component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-attribute"></span>[`attribute()`](/docs/extensions/bootstrap6/reference/attributestrait/index.md#method-attribute) | Sets an HTML attribute value. | [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/index.md) |
| <span id="method-beforeRun"></span>[`beforeRun()`](/docs/api/yii/base/widget/index.md#method-beforeRun) | This method is invoked right before the widget is executed. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-begin"></span>[`begin()`](/docs/api/yii/base/widget/index.md#method-begin) static | Begins a widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-behaviors"></span>[`behaviors()`](/docs/api/yii/base/component/index.md#method-behaviors) | Returns a list of behaviors that this component should behave as. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-canGetProperty"></span>[`canGetProperty()`](/docs/api/yii/base/component/index.md#method-canGetProperty) | Returns a value indicating whether a property can be read. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-canSetProperty"></span>[`canSetProperty()`](/docs/api/yii/base/component/index.md#method-canSetProperty) | Returns a value indicating whether a property can be set. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-class"></span>[`class()`](/docs/extensions/bootstrap6/reference/attributestrait/index.md#method-class) | Replaces the existing CSS classes with the specified ones. | [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/index.md) |
| <span id="method-className"></span>[`className()`](/docs/api/yii/base/baseobject/index.md#method-className) static | Returns the fully qualified name of this class. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-detachBehavior"></span>[`detachBehavior()`](/docs/api/yii/base/component/index.md#method-detachBehavior) | Detaches a behavior from the component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-detachBehaviors"></span>[`detachBehaviors()`](/docs/api/yii/base/component/index.md#method-detachBehaviors) | Detaches all behaviors from the component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-end"></span>[`end()`](/docs/api/yii/base/widget/index.md#method-end) static | Ends a widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-ensureBehaviors"></span>[`ensureBehaviors()`](/docs/api/yii/base/component/index.md#method-ensureBehaviors) | Makes sure that the behaviors declared in [`behaviors()`](/docs/api/yii/base/component/index.md#method-behaviors) are attached to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-getBehavior"></span>[`getBehavior()`](/docs/api/yii/base/component/index.md#method-getBehavior) | Returns the named behavior object. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-getBehaviors"></span>[`getBehaviors()`](/docs/api/yii/base/component/index.md#method-getBehaviors) | Returns all behaviors attached to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-getId"></span>[`getId()`](/docs/api/yii/base/widget/index.md#method-getId) | Returns the ID of the widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-getView"></span>[`getView()`](/docs/api/yii/base/widget/index.md#method-getView) | Returns the view object that can be used to render views or view files. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-getViewPath"></span>[`getViewPath()`](/docs/api/yii/base/widget/index.md#method-getViewPath) | Returns the directory containing the view files for this widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-hasEventHandlers"></span>[`hasEventHandlers()`](/docs/api/yii/base/component/index.md#method-hasEventHandlers) | Returns a value indicating whether there is any handler attached to the named event. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-hasMethod"></span>[`hasMethod()`](/docs/api/yii/base/component/index.md#method-hasMethod) | Returns a value indicating whether a method is defined. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-hasProperty"></span>[`hasProperty()`](/docs/api/yii/base/component/index.md#method-hasProperty) | Returns a value indicating whether a property is defined for this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| [`init()`](#method-init) | Initializes the widget, validates [`$expand`](/docs/extensions/bootstrap6/reference/navbar/index.md#property-expand), and starts capturing the content. | `NavBar` |
| <span id="method-off"></span>[`off()`](/docs/api/yii/base/component/index.md#method-off) | Detaches an existing event handler from this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-on"></span>[`on()`](/docs/api/yii/base/component/index.md#method-on) | Attaches an event handler to an event. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-render"></span>[`render()`](/docs/api/yii/base/widget/index.md#method-render) | Renders a view. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-renderFile"></span>[`renderFile()`](/docs/api/yii/base/widget/index.md#method-renderFile) | Renders a view file. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| [`run()`](#method-run) | Returns the complete navbar markup wrapping the captured content. | `NavBar` |
| <span id="method-setId"></span>[`setId()`](/docs/api/yii/base/widget/index.md#method-setId) | Sets the ID of the widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-setView"></span>[`setView()`](/docs/api/yii/base/widget/index.md#method-setView) | Sets the view object to be used by this widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-trigger"></span>[`trigger()`](/docs/api/yii/base/component/index.md#method-trigger) | Triggers an event. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-widget"></span>[`widget()`](/docs/api/yii/base/widget/index.md#method-widget) static | Creates a widget instance and runs it. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-pluginInitialization"></span>[`pluginInitialization()`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#method-pluginInitialization) protected | Returns the JavaScript that initializes a plugin with its normalized constructor options. | [`BootstrapWidgetTrait`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md) |
| <span id="method-registerClientEvents"></span>[`registerClientEvents()`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#method-registerClientEvents) protected | Registers the JavaScript event handlers listed in [`$clientEvents`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#property-clientEvents) at [`View::POS_END`](/docs/api/yii/web/view/index.md#const-POS_END). | [`BootstrapWidgetTrait`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md) |
| <span id="method-registerPlugin"></span>[`registerPlugin()`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#method-registerPlugin) protected | Registers the plugin asset, the plugin initialization when needed, and the [`$clientEvents`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#property-clientEvents). | [`BootstrapWidgetTrait`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md) |
| [`renderBrand()`](#method-renderBrand) protected | Renders the `.navbar-brand` element, or an empty string when there is no brand image and no brand label. | `NavBar` |
| [`renderDrawerBegin()`](#method-renderDrawerBegin) protected | Renders the opening part of the drawer: the `<dialog>`, its header, and the opening `.drawer-body` tag. | `NavBar` |
| [`renderToggler()`](#method-renderToggler) protected | Renders the toggler button that opens the drawer. | `NavBar` |
| [`togglerOptions()`](#method-togglerOptions) protected | Returns [`$togglerOptions`](/docs/extensions/bootstrap6/reference/navbar/index.md#property-togglerOptions) by reference. | `NavBar` |

## Events

| Event | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="event-EVENT_INIT"></span>[`EVENT_INIT`](/docs/api/yii/base/widget/index.md#event-EVENT_INIT) | [`yii\base\Event`](/docs/api/yii/base/event/index.md) | An event that is triggered when the widget is initialized via [`init()`](/docs/api/yii/base/widget/index.md#method-init). Event name: `'init'`. Available since 2.0.11. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="event-EVENT_BEFORE_RUN"></span>[`EVENT_BEFORE_RUN`](/docs/api/yii/base/widget/index.md#event-EVENT_BEFORE_RUN) | [`yii\base\WidgetEvent`](/docs/api/yii/base/widgetevent/index.md) | An event raised right before executing a widget. Event name: `'beforeRun'`. Available since 2.0.11. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="event-EVENT_AFTER_RUN"></span>[`EVENT_AFTER_RUN`](/docs/api/yii/base/widget/index.md#event-EVENT_AFTER_RUN) | [`yii\base\WidgetEvent`](/docs/api/yii/base/widgetevent/index.md) | An event raised right after executing a widget. Event name: `'afterRun'`. Available since 2.0.11. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |

## Property details

### $drawerOptions <span id="property-drawerOptions"></span>

```php
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`](/docs/extensions/bootstrap6/reference/enum/drawerplacement/index.md)|`string`, side the drawer slides in from, validated when rendered. Defaults
  to [`DrawerPlacement::END`](/docs/extensions/bootstrap6/reference/enum/drawerplacement/index.md#case-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() <span id="method-init"></span>

```php
public function init(): void
```

Initializes the widget, validates [`$expand`](/docs/extensions/bootstrap6/reference/navbar/index.md#property-expand), and starts capturing the content.

**Throws**

- [`yii\base\InvalidConfigException`](/docs/api/yii/base/invalidconfigexception/index.md): if [`$expand`](/docs/extensions/bootstrap6/reference/navbar/index.md#property-expand) is a `string` that is not a [`Breakpoint`](/docs/extensions/bootstrap6/reference/enum/breakpoint/index.md) value.

### run() <span id="method-run"></span>

```php
public function run(): string
```

Returns the complete navbar markup wrapping the captured content.

**Returns**

`string`

### renderBrand() <span id="method-renderBrand"></span>

```php
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() <span id="method-renderDrawerBegin"></span>

```php
protected function renderDrawerBegin(): string
```

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

**Returns**

`string`

### renderToggler() <span id="method-renderToggler"></span>

```php
protected function renderToggler(): string
```

Renders the toggler button that opens the drawer.

**Returns**

`string`

### togglerOptions() <span id="method-togglerOptions"></span>

```php
protected function togglerOptions(): mixed[]
```

Returns [`$togglerOptions`](/docs/extensions/bootstrap6/reference/navbar/index.md#property-togglerOptions) by reference.

**Returns**

`mixed[]`