https://github.com/itstructure/yii2-multi-level-menu
Widget for rendering multilevel menu for Yii2 Framework
https://github.com/itstructure/yii2-multi-level-menu
menu multilevel-menu yii2
Last synced: about 1 month ago
JSON representation
Widget for rendering multilevel menu for Yii2 Framework
- Host: GitHub
- URL: https://github.com/itstructure/yii2-multi-level-menu
- Owner: itstructure
- License: mit
- Created: 2018-05-19T06:08:58.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-30T13:44:38.000Z (about 3 years ago)
- Last Synced: 2025-07-20T01:44:15.702Z (9 months ago)
- Topics: menu, multilevel-menu, yii2
- Language: PHP
- Homepage:
- Size: 54.7 KB
- Stars: 5
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
Yii2 Multilevel menu widget
==============
## Introduction
[](https://packagist.org/packages/itstructure/yii2-multi-level-menu)
[](https://packagist.org/packages/itstructure/yii2-multi-level-menu)
[](https://packagist.org/packages/itstructure/yii2-multi-level-menu)
[](https://packagist.org/packages/itstructure/yii2-multi-level-menu)
[](https://scrutinizer-ci.com/g/itstructure/yii2-multi-level-menu/build-status/master)
[](https://scrutinizer-ci.com/g/itstructure/yii2-multi-level-menu/?branch=master)
This widget is designed to display a multilevel menu, in which there can be nested submenus. Used for Yii2 v2.0.x framework.
The widget uses data from the **database**, in which there are, in addition to the primary keys, also the parent keys.
Data from the **database** is taken from an active model, which instance of **yii\db\ActiveRecord**.
## Requirements
- php >= 7.1
- composer 2
## Installation
Via composer:
`composer require itstructure/yii2-multi-level-menu ~3.2.10`
## Usage
### Usage in view template
Base application config must be like in example below:
```php
use Itstructure\MultiLevelMenu\MenuWidget;
```
```php
echo MenuWidget::widget([
'menuId' => 'multi-level-menu',
'data' => array_values($dataProvider->getModels()),
'itemTemplate' => '@app/views/MultiLevelMenu/main.php'
]);
```
Example of `itemTemplate` file:
```php
use yii\helpers\{Url, Html};
/* @var app\models\Page $data */
```
```php
title),
Url::to(['view', 'id' => $data->id])
) ?>
```
Example when there are some properties for nesting levels:
```php
use Itstructure\MultiLevelMenu\MenuWidget;
```
```php
echo MenuWidget::widget([
'menuId' => 'multi-level-menu',
'data' => array_values($dataProvider->getModels()),
'itemTemplate' => '@app/views/MultiLevelMenu/main.php'
'mainContainerOptions' => [
'class' => 'list-group'
],
'itemContainerOptions' => [
'levels' => [
['class' => 'list-group-item'],
['class' => 'list-group-item list-group-item-success'],
['class' => 'list-group-item list-group-item-warning'],
]
],
]);
```
Example when there are some properties as callable function:
```php
use Itstructure\MultiLevelMenu\MenuWidget;
```
```php
echo MenuWidget::widget([
'menuId' => 'multi-level-menu',
'data' => array_values($dataProvider->getModels()),
'itemTemplate' => '@app/views/MultiLevelMenu/main.php'
'mainContainerOptions' => function () {
return [
'class' => $level == 0 ? 'nav navbar-nav navbar-right' : 'dropdown-menu'
];
},
'itemTemplateParams' => function ($level, $item) {
return [
'linkOptions' => isset($item['items']) && count($item['items']) > 0 ? [
'class' => 'dropdown-toggle',
'data-toggle' => 'dropdown',
'aria-haspopup' => 'true',
'aria-expanded' => 'false',
] : [],
];
},
'itemContainerOptions' => function ($level, $item) {
return $level == 0 ? [
'class' => isset($item['items']) && count($item['items']) > 0 ? 'nav-item dropdown' : 'nav-item'
] : [
'class' => isset($item['items']) && count($item['items']) > 0 ? 'dropdown-item dropdown' : 'dropdown-item'
];
}
]);
```
### Database table structure example
`Table "pages"`
| id | parentId | title | ... |
|-----|----------|------------|-----|
| 1 | NULL | item 1 | ... |
| 2 | NULL | item 2 | ... |
| 3 | NULL | item 3 | ... |
| 4 | NULL | item 4 | ... |
| 5 | NULL | item 5 | ... |
| 6 | 2 | item 2.1 | ... |
| 7 | 2 | item 2.2 | ... |
| 8 | 7 | item 2.2.1 | ... |
| 9 | 7 | item 2.2.2 | ... |
| 10 | 7 | item 2.2.3 | ... |
| ... | ... | ... | ... |
## License
Copyright © 2018-2025 Andrey Girnik girnikandrey@gmail.com.
Licensed under the [MIT license](http://opensource.org/licenses/MIT). See LICENSE.txt for details.