https://github.com/efectn/laravel-menu-builder
Wordpress like drag & drop menu builder for Laravel 9.x
https://github.com/efectn/laravel-menu-builder
Last synced: 10 months ago
JSON representation
Wordpress like drag & drop menu builder for Laravel 9.x
- Host: GitHub
- URL: https://github.com/efectn/laravel-menu-builder
- Owner: efectn
- License: gpl-3.0
- Created: 2022-04-21T09:32:50.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-30T15:17:58.000Z (almost 2 years ago)
- Last Synced: 2025-08-16T07:55:37.852Z (10 months ago)
- Language: JavaScript
- Homepage:
- Size: 238 KB
- Stars: 8
- Watchers: 2
- Forks: 12
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Drag and Drop Menu Builder for Laravel 9.x, 10.x and 11.x
[](https://packagist.org/packages/efectn/laravel-menu-builder) [](https://packagist.org/packages/efectn/laravel-menu-builder) [](https://packagist.org/packages/efectn/laravel-menu-builder) [](https://packagist.org/packages/efectn/laravel-menu-builder)
Originally forked from [harimayco/wmenu-builder](https://github.com/harimayco/wmenu-builder), but under active maintenance.
### Installation
1. Run
```php
composer require efectn/laravel-menu-builder
```
2. Add facade in the config/app.php (optional )
```php
'Menu' => Efectn\Menu\Facades\Menu::class,
```
4. Run publish to get configs, views, assets and migrations.
```php
php artisan vendor:publish --provider="Efectn\Menu\MenuServiceProvider"
```
5. 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
6. Run migrate
```php
php artisan migrate
```
DONE
### Menu Builder Usage Example - displays the builder
On your view blade file
```php
@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
```php
use Efectn\Menu\Models\Menus;
use Efectn\Menu\Models\MenuItems;
```
### Menu Usage Example (a)
A basic two-level menu can be displayed in your blade template
##### Using Model Class
```php
/* 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
```php
// 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
```php
```
### HELPERS
### Get Menu Items By Menu ID
```php
use Efectn\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_
```php
use Efectn\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](https://github.com/lordmacu/wmenu) - laravel package menu like wordpress
- [wmenu-builder](https://github.com/harimayco/wmenu-builder) - Laravel Drag and Drop Dynamic Menu Generator (Wordpress look alike)
### Compatibility
- Tested with Laravel 9.x.
### Known Issues
**Note:** Look at https://github.com/efectn/laravel-menu-builder/issues/1.