Class yii\bootstrap\NavBar

All Classes | Properties | Methods | Events

Inheritance	yii\bootstrap\NavBar » yii\bootstrap\Widget » yii\base\Widget » yii\base\Component » yii\base\BaseObject
Implements	yii\base\Configurable, yii\base\ViewContextInterface
Uses Traits	yii\bootstrap\BootstrapWidgetTrait
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2-bootstrap/blob/master/NavBar.php

NavBar renders a navbar HTML component.

Any content enclosed between the begin() and end() calls of NavBar is treated as the content of the navbar. You may use widgets such as yii\bootstrap\Nav or yii\widgets\Menu to build up such content. For example,

use yii\bootstrap\NavBar;
use yii\bootstrap\Nav;

NavBar::begin(['brandLabel' => 'NavBar Test']);
echo Nav::widget([
    'items' => [
        ['label' => 'Home', 'url' => ['/site/index']],
        ['label' => 'About', 'url' => ['/site/about']],
    ],
    'options' => ['class' => 'navbar-nav'],
]);
NavBar::end();

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$autoIdPrefix	string	The prefix to the automatically generated widget IDs.	yii\base\Widget
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component	yii\base\Component
$brandImage	string\|boolean	Src of the brand image or false if it's not used.	yii\bootstrap\NavBar
$brandLabel	string\|boolean	The text of the brand or false if it's not used.	yii\bootstrap\NavBar
$brandOptions	array	The HTML attributes of the brand link.	yii\bootstrap\NavBar
$brandUrl	array\|string\|boolean	The URL for the brand's hyperlink tag.	yii\bootstrap\NavBar
$clientEvents	array	The event handlers for the underlying Bootstrap JS plugin.	yii\bootstrap\BootstrapWidgetTrait
$clientOptions	array	The options for the underlying Bootstrap JS plugin.	yii\bootstrap\BootstrapWidgetTrait
$containerOptions	array	The HTML attributes for the container tag.	yii\bootstrap\NavBar
$counter	integer	A counter used to generate $id for widgets.	yii\base\Widget
$headerContent	string	HTML content to be added in navbar-header div, for example, mobile search form.	yii\bootstrap\NavBar
$id	string	ID of the widget.	yii\base\Widget
$innerContainerOptions	array	The HTML attributes of the inner container.	yii\bootstrap\NavBar
$options	array	The HTML attributes for the widget container tag.	yii\bootstrap\NavBar
$renderInnerContainer	boolean	Whether the navbar content should be included in an inner div container which by default adds left and right padding.	yii\bootstrap\NavBar
$screenReaderToggleText	string	Text to show for screen readers for the button to toggle the navbar.	yii\bootstrap\NavBar
$stack	yii\base\Widget[]	The widgets that are currently being rendered (not ended).	yii\base\Widget
$view	yii\web\View	The view object that can be used to render views or view files.	yii\bootstrap\BootstrapWidgetTrait
$viewPath	string	The directory containing the view files for this widget.	yii\base\Widget

Public Methods

Hide inherited methods

Method	Description	Defined By
__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
__construct()	Constructor.	yii\base\BaseObject
__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
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
beforeRun()	This method is invoked right before the widget is executed.	yii\base\Widget
begin()	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
className()	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()	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()		yii\bootstrap\BootstrapWidgetTrait
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.	yii\bootstrap\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()	Renders the widget.	yii\bootstrap\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()	Creates a widget instance and runs it.	yii\base\Widget

Protected Methods

Hide inherited methods

Method	Description	Defined By
registerClientEvents()	Registers JS event handlers that are listed in $clientEvents.	yii\bootstrap\BootstrapWidgetTrait
registerPlugin()	Registers a specific Bootstrap plugin and the related events	yii\bootstrap\BootstrapWidgetTrait
renderToggleButton()	Renders collapsible toggle button.	yii\bootstrap\NavBar

Events

Hide inherited events

Event	Type	Description	Defined By
EVENT_AFTER_RUN	yii\base\WidgetEvent	An event raised right after executing a widget. (available since version 2.0.11)	yii\base\Widget
EVENT_BEFORE_RUN	yii\base\WidgetEvent	An event raised right before executing a widget. (available since version 2.0.11)	yii\base\Widget
EVENT_INIT	yii\base\Event	An event that is triggered when the widget is initialized via init(). (available since version 2.0.11)	yii\base\Widget

Property Details

$brandImage public property (available since version 2.0.8)

Src of the brand image or false if it's not used. Note that this param will override $this->brandLabel param.

public string|boolean $brandImage = false

$brandLabel public property

The text of the brand or false if it's not used. Note that this is not HTML-encoded.

public string|boolean $brandLabel = false

$brandOptions public property

The HTML attributes of the brand link.

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $brandOptions = []

$brandUrl public property

The URL for the brand's hyperlink tag. This parameter will be processed by yii\helpers\Url::to() and will be used for the "href" attribute of the brand link. Default value is false that means yii\web\Application::$homeUrl will be used. You may set it to null if you want to have no link at all.

public array|string|boolean $brandUrl = false

$containerOptions public property

The HTML attributes for the container tag. The following special options are recognized:

tag: string, defaults to "div", the name of the container tag.

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $containerOptions = []

$headerContent public property (available since version 2.0.8)

HTML content to be added in navbar-header div, for example, mobile search form.

public string $headerContent = null

$innerContainerOptions public property

The HTML attributes of the inner container.

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $innerContainerOptions = []

$options public property

The HTML attributes for the widget container tag. The following special options are recognized:

tag: string, defaults to "nav", the name of the container tag.

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $options = []

$renderInnerContainer public property

Whether the navbar content should be included in an inner div container which by default adds left and right padding. Set this to false for a 100% width navbar.

public boolean $renderInnerContainer = true

$screenReaderToggleText public property

Text to show for screen readers for the button to toggle the navbar.

public string $screenReaderToggleText = 'Toggle navigation'

Method Details

init() public method

Initializes the widget.

public void init ( )

renderToggleButton() protected method

Renders collapsible toggle button.

protected string renderToggleButton ( )
return	string	The rendering toggle button.

run() public method

Renders the widget.

public void run ( )