Class yii\apidoc\templates\krajee\widgets\SideNav

All Classes | Properties | Methods | Events
Inheritanceyii\apidoc\templates\krajee\widgets\SideNav » yii\bootstrap5\Widget » yii\base\Widget » yii\base\Component » yii\base\BaseObject
Implementsyii\base\Configurable, yii\base\ViewContextInterface
Uses Traitsyii\bootstrap5\BootstrapWidgetTrait
Available since version2.0
Source Code https://github.com/yiisoft/yii2-apidoc/blob/master/templates/krajee/widgets/SideNav.php

SideNav renders a nav HTML component.

For example:

echo SideNav::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.

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\krajee\widgets\SideNav
$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
$clientEvents array The event handlers for the underlying Bootstrap JS plugin. yii\bootstrap5\BootstrapWidgetTrait
$clientOptions array|boolean The options for the underlying Bootstrap JS plugin. yii\bootstrap5\BootstrapWidgetTrait
$counter integer A counter used to generate $id for widgets. yii\base\Widget
$encodeLabels boolean Whether the nav items labels should be HTML-encoded. yii\apidoc\templates\krajee\widgets\SideNav
$id string|null ID of the widget. Note that the type of this property differs in getter and setter. See getId() and setId() for details. yii\base\Widget
$items array List of items in the nav widget. yii\apidoc\templates\krajee\widgets\SideNav
$options array The HTML attributes for the widget container tag. yii\apidoc\templates\krajee\widgets\SideNav
$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. Note that the type of this property differs in getter and setter. See getView() and setView() for details. yii\base\Widget
$viewPath string The directory containing the view files for this widget. yii\base\Widget

Public Methods

Hide inherited methods

MethodDescriptionDefined 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() Returns the view object that can be used to render views or view files. yii\base\Widget
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\apidoc\templates\krajee\widgets\SideNav
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
renderItem() Renders a widget's item. yii\apidoc\templates\krajee\widgets\SideNav
renderItems() Renders widget items. yii\apidoc\templates\krajee\widgets\SideNav
run() Renders the widget. yii\apidoc\templates\krajee\widgets\SideNav
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

MethodDescriptionDefined By
registerClientEvents() Registers JS event handlers that are listed in $clientEvents. yii\bootstrap5\BootstrapWidgetTrait
registerPlugin() Registers a specific Bootstrap plugin and the related events yii\bootstrap5\BootstrapWidgetTrait

Events

Hide inherited events

EventTypeDescriptionDefined 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

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

  • params
  • isItemActive
public string $activeUrl = null
$encodeLabels public property

Whether the nav items labels should be HTML-encoded.

public boolean $encodeLabels = false
$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: bool, 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: bool, optional, whether the item should be on active state or not.
  • items: array|string, optional, the configuration array for creating a yii\apidoc\templates\krajee\widgets\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 = []
$options public property

The HTML attributes for the widget container tag.

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

public array $options = []

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 ( )