Class yii\apidoc\templates\bootstrap\SideNavWidget

All Classes | Properties | Methods
Inheritanceyii\apidoc\templates\bootstrap\SideNavWidget » yii\bootstrap\Widget
Available since version2.0

Nav renders a nav HTML component.

For example:

echo Nav::widget([
    'items' => [
        [
            'label' => 'Home',
            'url' => ['site/index'],
            'linkOptions' => [...],
        ],
        [
            'label' => 'Dropdown',
            'items' => [
                 ['label' => 'Level 1 - Dropdown A', 'url' => '#'],
                 '<li class="divider"></li>',
                 '<li class="dropdown-header">Dropdown Header</li>',
                 ['label' => 'Level 1 - Dropdown B', 'url' => '#'],
            ],
        ],
    ],
]);

Note: Multilevel dropdowns beyond Level 1 are not supported in Bootstrap 3.

See also:

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$activeUrl string The route used to determine if a menu item is active or not. yii\apidoc\templates\bootstrap\SideNavWidget
$encodeLabels boolean Whether the nav items labels should be HTML-encoded. yii\apidoc\templates\bootstrap\SideNavWidget
$items array List of items in the nav widget. yii\apidoc\templates\bootstrap\SideNavWidget

Public Methods

Hide inherited methods

MethodDescriptionDefined By
init() Initializes the widget. yii\apidoc\templates\bootstrap\SideNavWidget
renderItem() Renders a widget's item. yii\apidoc\templates\bootstrap\SideNavWidget
renderItems() Renders widget items. yii\apidoc\templates\bootstrap\SideNavWidget
run() Renders the widget. yii\apidoc\templates\bootstrap\SideNavWidget

Property Details

$activeUrl public property

The route used to determine if a menu item is active or not. If not set, it will use the route of the current request.

See also:

  • \yii\apidoc\templates\bootstrap\params
  • \yii\apidoc\templates\bootstrap\isItemActive
public string $activeUrl = null
$encodeLabels public property

Whether the nav items labels should be HTML-encoded.

public boolean $encodeLabels = true
$items public property

List of items in the nav widget. Each array element represents a single menu item which can be either a string or an array with the following structure:

  • label: string, required, the nav item label.
  • url: optional, the item's URL. Defaults to "#".
  • visible: boolean, optional, whether this menu item is visible. Defaults to true.
  • linkOptions: array, optional, the HTML attributes of the item's link.
  • options: array, optional, the HTML attributes of the item container (LI).
  • active: boolean, optional, whether the item should be on active state or not.
  • items: array|string, optional, the configuration array for creating a \yii\apidoc\templates\bootstrap\Dropdown widget, or a string representing the dropdown menu. Note that Bootstrap does not support sub-dropdown menus.

If a menu item is a string, it will be rendered directly without HTML encoding.

public array $items = []

Method Details

init() public method

Initializes the widget.

public void init ( )
renderItem() public method

Renders a widget's item.

public string renderItem ( $item, $collapsed = true )
$item string|array

The item to render.
$collapsed boolean

Whether to collapse item if not active
return string

The rendering result.
throws \yii\base\InvalidConfigException

if label is not defined
renderItems() public method

Renders widget items.

public void renderItems ( )
run() public method

Renders the widget.

public void run ( )