Class humhub\modules\directory\widgets\Menu
| Inheritance | humhub\modules\directory\widgets\Menu » humhub\widgets\BaseMenu » yii\base\Widget |
|---|---|
| Available since version | 0.21 |
Directory Menu
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $id | string | Dom element id | humhub\widgets\BaseMenu |
| $itemGroups | array | Of item groups | humhub\widgets\BaseMenu |
| $items | array | Of items | humhub\widgets\BaseMenu |
| $template | humhub\modules\directory\widgets\Menu | ||
| $type | string | Type of the navigation, optional for identifing. | humhub\widgets\BaseMenu |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| addItem() | Adds new Item to the menu | humhub\widgets\BaseMenu |
| addItemGroup() | Adds new Item Group to the menu | humhub\widgets\BaseMenu |
| deleteItemByUrl() | Removes Item by URL | humhub\widgets\BaseMenu |
| getActive() | humhub\widgets\BaseMenu | |
| getItemGroups() | Returns all Item Groups | humhub\widgets\BaseMenu |
| getItems() | Returns Items of this Navigation | humhub\widgets\BaseMenu |
| init() | humhub\modules\directory\widgets\Menu | |
| markAsActive() | Add the active class from a menue item. | humhub\widgets\BaseMenu |
| markAsInactive() | Remove the active class from a menue item. | humhub\widgets\BaseMenu |
| run() | Executes the Menu Widget | humhub\widgets\BaseMenu |
| setActive() | Activates the menu item with the given url | humhub\widgets\BaseMenu |
| setInactive() | humhub\widgets\BaseMenu | |
| setViewState() | This function is used in combination with pjax to get sure the required menu is active | humhub\widgets\BaseMenu |
Constants
| Constant | Value | Description | Defined By |
|---|---|---|---|
| EVENT_INIT | 'init' | humhub\widgets\BaseMenu | |
| EVENT_RUN | 'run' | humhub\widgets\BaseMenu |