rah1595/laravel-drag-menu

Wordpress like drag & drop menu builder for Laravel

dev-master 2023-09-04 08:00 UTC

Requires

• php: >=8.0
• illuminate/events: ~8.0 || ~9.0 || ^10.0
• illuminate/notifications: ~8.0 || ~9.0 || ^10.0
• illuminate/queue: ~8.0 || ~9.0 || ^10.0
• illuminate/support: ~8.0 || ~9.0 || ^10.0
• pusher/pusher-push-notifications: ^2.0

MIT

• Rah
• Muhammed Efe Çetin
• Rendy Harimayco
• Cristian Garcia

• menu
• wordpress
• builder
• laravel
• drag and drop

README

Installation

1. Run

composer require rah1595/laravel-drag-menu

1. Add facade in the config/app.php (optional )

'Menu' => Efectn\Menu\Facades\Menu::class,

1. Run publish to get configs, views, assets and migrations.

php artisan vendor:publish --provider="Rah\Menu\MenuServiceProvider"

1. Configure (optional) in config/menu.php :

• CUSTOM MIDDLEWARE: You can add you own middleware
• TABLE PREFIX: By default this package will create 2 new tables named "menus" and "menu_items" but you can still add your own table prefix avoiding conflict with existing table
• TABLE NAMES If you want use specific name of tables you have to modify that and the migrations
• Custom routes If you want to edit the route path you can edit the field
• Role Access If you want to enable roles (permissions) on menu items

1. Run migrate

php artisan migrate

DONE

Menu Builder Usage Example - displays the builder

On your view blade file

@extends('app')

@section('contents')
    {!! Menu::render() !!}
@endsection

//YOU MUST HAVE JQUERY LOADED BEFORE menu scripts
@push('scripts')
    {!! Menu::scripts() !!}
@endpush

Using The Model

Call the model class

use Rah\Menu\Models\Menus;
use Rah\Menu\Models\MenuItems;

Menu Usage Example (a)

A basic two-level menu can be displayed in your blade template

Using Model Class

/* get menu by id*/
$menu = Menus::find(1);
/* or by name */
$menu = Menus::where('name','Test Menu')->first();

/* or get menu by name and the items with EAGER LOADING (RECOMENDED for better performance and less query call)*/
$menu = Menus::where('name','Test Menu')->with('items')->first();
/*or by id */
$menu = Menus::where('id', 1)->with('items')->first();

//you can access by model result
$public_menu = $menu->items;

//or you can convert it to array
$public_menu = $menu->items->toArray();

or Using helper

// Using Helper 
$public_menu = Menu::getByName('Public'); //return array

Menu Usage Example (b)

Now inside your blade template file place the menu using this simple example

<div class="nav-wrap">
    <div class="btn-menu">
        <span></span>
    </div><!-- //mobile menu button -->
    <nav id="mainnav" class="mainnav">

        @if($public_menu)
        <ul class="menu">
            @foreach($public_menu as $menu)
            <li class="">
                <a href="{{ $menu['link'] }}" title="">{{ $menu['label'] }}</a>
                @if( $menu['child'] )
                <ul class="sub-menu">
                    @foreach( $menu['child'] as $child )
                        <li class=""><a href="{{ $child['link'] }}" title="">{{ $child['label'] }}</a></li>
                    @endforeach
                </ul><!-- /.sub-menu -->
                @endif
            </li>
            @endforeach
        @endif

        </ul><!-- /.menu -->
    </nav><!-- /#mainnav -->
 </div><!-- /.nav-wrap -->

HELPERS

Get Menu Items By Menu ID

use Rah\Menu\Facades\Menu;
...
/*
Parameter: Menu ID
Return: Array
*/
$menuList = Menu::get(1);

Get Menu Items By Menu Name

In this example, you must have a menu named Admin

use Rah\Menu\Facades\Menu;
...
/*
Parameter: Menu ID
Return: Array
*/
$menuList = Menu::getByName('Admin');

Customization

you can edit the menu interface in resources/views/vendor/menu-builder/menu-html.blade.php

Credits

• wmenu - laravel package menu like wordpress
• wmenu-builder - Laravel Drag and Drop Dynamic Menu Generator (Wordpress look alike)

Compatibility

• Tested with Laravel 9.x.

Known Issues

Note: Look at efectn/laravel-menu-builder#1.