README

Yii2 Menu module

Module for creating and managing menus. It has its own component for displaying menu items in the front-end.

This module is an integral part of the Butterfly.СMS content management system, but can also be used as an standalone extension.

Requirements

PHP 5.6 or higher
Yii2 v.2.0.40 and newest
Yii2 Base module (required)

Installation

To install the module, run the following command in the console:

$ composer require "wdmg/yii2-menu"

After configure db connection, run the following command in the console:

$ php yii menu/init

And select the operation you want to perform:

Apply all module migrations
Revert all module migrations

Migrations

In any case, you can execute the migration and create the initial data, run the following command in the console:

$ php yii migrate --migrationPath=@vendor/wdmg/yii2-menu/migrations

Configure

To add a module to the project, add the following data in your configuration file:

'modules' => [
    ...
    'menu' => [
        'class' => 'wdmg\menu\Module',
        'routePrefix' => 'admin'
    ],
    ...
],

Usage examples

To build the navigation menu you may use the component method Yii::$app->menu->getItems() with id or alias of menu. The second argument of the component function determines whether the list of menu items will be presented as a tree.

View in frontend

<?php
    use yii\bootstrap\Nav;
    ...
?>
    
<?php
    if ($menuItems = Yii::$app->menu->getItems(1, true)) {
        echo Nav::widget([
            'options' => ['class' => 'navbar-nav'],
            'items' => $menuItems,
        ]);
    }
?>

// or get items by menu alias
    
<?php
    if ($menuItems = Yii::$app->menu->getItems('glavnoye-menyu', true)) {
        echo Nav::widget([
            'options' => ['class' => 'navbar-nav'],
            'items' => $menuItems,
        ]);
    }
?>
...

Routing

Use the Module::dashboardNavItems() method of the module to generate a navigation items list for NavBar, like this:

<?php
    echo Nav::widget([
    'options' => ['class' => 'navbar-nav navbar-right'],
        'label' => 'Modules',
        'items' => [
            Yii::$app->getModule('menu')->dashboardNavItems(),
            ...
        ]
    ]);
?>

Status and version [ready to use]

v.1.2.1 - Fix nav menu
v.1.2.0 - Fix node sass, update dependencies and copyrights
v.1.1.1 - Migration error fixed
v.1.1.0 - Multi-language implementation

wdmg / yii2-menu

Maintainers

Details