# Class yii\jui\Menu

Inheritance | yii\jui\Menu » yii\widgets\Menu » yii\base\Widget » yii\base\Component » yii\base\BaseObject
Implements | yii\base\Configurable, yii\base\ViewContextInterface
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2-jui/blob/master/Menu.php

Menu renders a menu jQuery UI widget.

See also http://api.jqueryui.com/menu/.

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$activateItems | boolean | Whether to automatically activate items according to whether their route setting matches the currently requested route. | yii\widgets\Menu
$activateParents | boolean | Whether to activate parent menu items when one of the corresponding child menu items is active. | yii\widgets\Menu
$activeCssClass | string | The CSS class to be appended to the active menu item. | yii\widgets\Menu
$autoIdPrefix | string | The prefix to the automatically generated widget IDs. | yii\base\Widget
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component. This property is read-only. | yii\base\Component
$clientEvents | array | The event handlers for the underlying jQuery UI widget. | yii\jui\Menu
$clientOptions | array | The options for the underlying jQuery UI widget. | yii\jui\Menu
$counter | integer | A counter used to generate $id for widgets. | yii\base\Widget
$encodeLabels | boolean | Whether the labels for menu items should be HTML-encoded. | yii\widgets\Menu
$firstItemCssClass | string | The CSS class that will be assigned to the first item in the main menu or each submenu. | yii\widgets\Menu
$hideEmptyItems | boolean | Whether to hide empty menu items. | yii\widgets\Menu
$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
$itemOptions | array | List of HTML attributes shared by all menu $items. | yii\widgets\Menu
$items | array | List of menu items. | yii\widgets\Menu
$labelTemplate | string | The template used to render the body of a menu which is NOT a link. | yii\widgets\Menu
$lastItemCssClass | string | The CSS class that will be assigned to the last item in the main menu or each submenu. | yii\widgets\Menu
$linkTemplate | string | The template used to render the body of a menu which is a link. | yii\widgets\Menu
$options | array | The HTML attributes for the menu's container tag. | yii\widgets\Menu
$params | array | The parameters used to determine if a menu item is active or not. | yii\widgets\Menu
$route | string | The route used to determine if a menu item is active or not. | yii\widgets\Menu
$stack | yii\base\Widget[] | The widgets that are currently being rendered (not ended). | yii\base\Widget
$submenuTemplate | string | The template used to render a list of sub-menus. | yii\widgets\Menu
$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. This property is read-only. | 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() | 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\jui\Menu
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\jui\Menu
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
--- | --- | ---
isItemActive() | Checks whether a menu item is active. | yii\widgets\Menu
normalizeItems() | Normalizes the $items property to remove invisible items and activate certain items. | yii\widgets\Menu
renderItem() | Renders the content of a menu item. | yii\widgets\Menu
renderItems() | Recursively renders the menu items (without the container tag). | yii\widgets\Menu

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

$clientEvents public property

The event handlers for the underlying jQuery UI widget. Please refer to the corresponding jQuery UI widget Web page for possible events. For example, this page shows how to use the "Accordion" widget and the supported events (e.g. "create").

public array $clientEvents = []
$clientOptions public property

The options for the underlying jQuery UI widget. Please refer to the corresponding jQuery UI widget Web page for possible options. For example, this page shows how to use the "Accordion" widget and the supported options (e.g. "header").

public array $clientOptions = []

## Method Details

init() public method

Initializes the widget.

If you override this method, make sure you call the parent implementation first.

public void init ( )

run() public method

Renders the widget.

public void run ( )