Class yii\bootstrap4\NavBar

Inheritanceyii\bootstrap4\NavBar » yii\bootstrap4\Widget » yii\base\Widget
Uses Traitsyii\bootstrap4\BootstrapWidgetTrait

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\bootstrap4\Nav or \yii\widgets\Menu to build up such content. For example,

use yii\bootstrap4\NavBar;
use yii\bootstrap4\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();

See also https://getbootstrap.com/docs/4.2/components/navbar/.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$brandImage string|boolean Src of the brand image or false if it's not used. yii\bootstrap4\NavBar
$brandLabel string|boolean The text of the brand or false if it's not used. yii\bootstrap4\NavBar
$brandOptions array The HTML attributes of the brand link. yii\bootstrap4\NavBar
$brandUrl array|string|boolean The URL for the brand's hyperlink tag. yii\bootstrap4\NavBar
$clientEvents array The event handlers for the underlying Bootstrap JS plugin. yii\bootstrap4\BootstrapWidgetTrait
$clientOptions array The options for the underlying Bootstrap JS plugin. yii\bootstrap4\NavBar
$collapseOptions array The HTML attributes for the container tag. yii\bootstrap4\NavBar
$innerContainerOptions array The HTML attributes of the inner container. yii\bootstrap4\NavBar
$options array The HTML attributes for the widget container tag. yii\bootstrap4\NavBar
$renderInnerContainer boolean Whether the navbar content should be included in an inner div container which by default adds left and right padding. yii\bootstrap4\NavBar
$screenReaderToggleText string Text to show for screen readers for the button to toggle the navbar. yii\bootstrap4\NavBar
$togglerContent string The toggle button content. yii\bootstrap4\NavBar
$togglerOptions array The HTML attributes of the navbar toggler button. yii\bootstrap4\NavBar

Public Methods

Hide inherited methods

MethodDescriptionDefined By
getView() yii\bootstrap4\BootstrapWidgetTrait
init() Initializes the widget. yii\bootstrap4\NavBar
run() Renders the widget. yii\bootstrap4\NavBar
setContainerOptions() Container options setter for backwards compatibility yii\bootstrap4\NavBar

Protected Methods

Hide inherited methods

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

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.

See also https://getbootstrap.com/docs/4.2/components/navbar/.

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.

See also https://getbootstrap.com/docs/4.2/components/navbar/.

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
$clientOptions public property

The options for the underlying Bootstrap JS plugin. Please refer to the corresponding Bootstrap plugin Web page for possible options. For example, this page shows how to use the "Modal" plugin and the supported options (e.g. "remote").

public array $clientOptions false
$collapseOptions 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 $collapseOptions = []
$innerContainerOptions public property

The HTML attributes of the inner container.

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

$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.

$screenReaderToggleText public property

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

public string $screenReaderToggleText 'Toggle navigation'
$togglerContent public property

The toggle button content. Defaults to bootstrap 4 default <span class="navbar-toggler-icon"></span>

public string $togglerContent '<span class="navbar-toggler-icon"></span>'
$togglerOptions public property

The HTML attributes of the navbar toggler button.

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

public array $togglerOptions = []

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 ( )
setContainerOptions() public method

Container options setter for backwards compatibility

public void setContainerOptions ( $collapseOptions )
$collapseOptions array