Getting Started

Minimal Setup

Installation

composer require dizatech/module-menu

Publish the configuration file:

php artisan vendor:publish --provider="Dizatech\ModuleMenu\ModuleMenuServiceProvider" --tag="config"

Basic Configuration Edit config/module-menu.php to define your modules and their menu items:

'modules' => [
    'admin' => [
        'label' => 'Admin Panel',
        'icon' => 'fas fa-tachometer-alt',
        'items' => [
            ['label' => 'Dashboard', 'route' => 'admin.dashboard'],
            ['label' => 'Users', 'route' => 'admin.users.index'],
        ],
    ],
],

First Usage Render the menu in a Blade view:
```
@menu('admin')
```
Or dynamically fetch it in a controller:
```
$menu = \Dizatech\ModuleMenu\Facades\ModuleMenu::get('admin');
```

Implementation Patterns

Module-Based Menu Structure

Grouping by Module: Organize menus by logical modules (e.g., admin, frontend, settings).

'modules' => [
    'frontend' => [
        'label' => 'Public Site',
        'items' => [
            ['label' => 'Home', 'route' => 'home'],
            ['label' => 'Blog', 'route' => 'blog.index'],
        ],
    ],
],

Nested Submenus Use the items array recursively for hierarchical menus:

'admin' => [
    'items' => [
        [
            'label' => 'Content',
            'items' => [
                ['label' => 'Posts', 'route' => 'admin.posts.index'],
                ['label' => 'Categories', 'route' => 'admin.categories.index'],
            ],
        ],
    ],
],

Dynamic Menu Generation

Conditional Rendering Use Blade directives to show/hide menus based on user roles or permissions:

@auth
    @menu('admin', ['showIf' => function () {
        return auth()->user()->isAdmin();
    }])
@endauth

Route-Based Active States Highlight active menu items by route:

'items' => [
    ['label' => 'Dashboard', 'route' => 'admin.dashboard', 'activeWhen' => 'admin.*'],
],

Integration with Laravel Features

Middleware for Module Access Restrict menu visibility via middleware:

Route::group(['middleware' => 'can:access-admin'], function () {
    // Admin routes
});

Localization Support Localize menu labels:

'items' => [
    ['label' => trans('menu.dashboard'), 'route' => 'admin.dashboard'],
],

Gotchas and Tips

Common Pitfalls

Route Name Mismatches Ensure route values in the config match your actual Laravel route names. Use php artisan route:list to verify.
Caching Issues Clear the view cache if menus don’t update after config changes:
```
php artisan view:clear
```

Nested Item Syntax Incorrect nesting can break rendering. Validate JSON structure:

// Correct:
'items' => [['label' => 'Submenu', 'items' => [...]],]

// Incorrect (missing array wrapper):
'items' => ['label' => 'Submenu', 'items' => [...]]

Debugging Tips

Dump Menu Structure Log the raw menu data for debugging:

dd(\Dizatech\ModuleMenu\Facades\ModuleMenu::get('admin'));

Check Config Loading Verify the config file is published and loaded:
```
dd(config('module-menu'));
```

Extension Points

Custom Menu Providers Extend functionality by creating a custom provider:

use Dizatech\ModuleMenu\Contracts\MenuProvider;

class CustomMenuProvider implements MenuProvider {
    public function getMenu($module) {
        // Custom logic
    }
}

'provider' => \App\Providers\CustomMenuProvider::class,

Dynamic Menu Items Fetch menu items from a database or API:

'items' => function () {
    return \App\Models\MenuItem::where('module', 'admin')->get()->toArray();
},

Event-Based Updates Trigger menu rebuilds on module changes via events:

event(new \App\Events\ModuleUpdated($module));

Listen for updates in a service provider:

\App\Events\ModuleUpdated::class => function () {
    \Dizatech\ModuleMenu\Facades\ModuleMenu::clearCache();
},

Module Menu Laravel Package