Class yii\apidoc\templates\bootstrap\SideNavWidget

All Classes | Properties | Methods
Inheritanceyii\apidoc\templates\bootstrap\SideNavWidget » yii\bootstrap\Widget
Available since extension's version2.0
Source Code https://github.com/yiisoft/yii2-apidoc/blob/master/templates/bootstrap/SideNavWidget.php

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

Property Type Description Defined 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

Method Description Defined 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

Hide inherited properties

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

Hide inherited methods

init() public method

Initializes the widget.

public void init ( )

                public function init()
{
    parent::init();
    if (!isset($this->options['class'])) {
        Html::addCssClass($this->options, 'list-group');
    }
}
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

 

                public function renderItem($item, $collapsed = true)
{
    if (is_string($item)) {
        return $item;
    }
    if (!isset($item['label'])) {
        throw new InvalidConfigException("The 'label' option is required.");
    }
    $label = $this->encodeLabels ? Html::encode($item['label']) : $item['label'];
    $items = ArrayHelper::getValue($item, 'items');
    $url = Url::to(ArrayHelper::getValue($item, 'url', '#'));
    $linkOptions = ArrayHelper::getValue($item, 'linkOptions', []);
    Html::addCssClass($linkOptions, 'list-group-item');
    if (isset($item['active'])) {
        $active = ArrayHelper::remove($item, 'active', false);
    } else {
        $active = ($url == $this->activeUrl);
    }
    if ($items !== null) {
        $linkOptions['data-toggle'] = 'collapse';
        $linkOptions['data-parent'] = '#' . $this->id;
        $id = $this->id . '-' . static::$counter++;
        $url = '#' . $id;
        $label .= ' ' . Html::tag('b', '', ['class' => 'caret']);
        if (is_array($items)) {
            if ($active === false) {
                foreach ($items as $subItem) {
                    if (isset($subItem['active']) && $subItem['active']) {
                        $active = true;
                    }
                }
            }
            $items = static::widget([
                'id' => $id,
                'items' => $items,
                'encodeLabels' => $this->encodeLabels,
                'view' => $this->getView(),
                'options' => [
                    'class' => "submenu panel-collapse collapse" . ($active || !$collapsed ? ' in' : '')
                ]
            ]);
        }
    }
    if ($active) {
        Html::addCssClass($linkOptions, 'active');
    }
    return Html::a($label, $url, $linkOptions) . $items;
}
renderItems() public method

Renders widget items.

public void renderItems ( )

                public function renderItems()
{
    $items = [];
    foreach ($this->items as $i => $item) {
        if (isset($item['visible']) && !$item['visible']) {
            unset($items[$i]);
            continue;
        }
        $items[] = $this->renderItem($item, count($this->items) !== 1);
    }
    return Html::tag('div', implode("\n", $items), $this->options);
}
run() public method

Renders the widget.

public void run ( )

                public function run()
{
    echo $this->renderItems();
    BootstrapAsset::register($this->getView());
}