PHPackages                             skylark-team/nova-menus - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Admin Panels](/categories/admin)
4. /
5. skylark-team/nova-menus

ActiveLibrary[Admin Panels](/categories/admin)

skylark-team/nova-menus
=======================

Advanced hierarchical menu management tool for Laravel Nova with drag-and-drop interface, temporal visibility, and resource integration

201PHP

Since Aug 29Pushed 10mo ago1 watchersCompare

[ Source](https://github.com/skylark-team/nova-menus)[ Packagist](https://packagist.org/packages/skylark-team/nova-menus)[ RSS](/packages/skylark-team-nova-menus/feed)WikiDiscussions main Synced today

READMEChangelogDependenciesVersions (1)Used By (0)

Nova Menus
==========

[](#nova-menus)

Advanced hierarchical menu management tool for Laravel Nova with intuitive drag-and-drop interface, temporal visibility, resource integration, and comprehensive testing.

Screenshots
-----------

[](#screenshots)

[![Menu Management Interface](docs/screenshots/menu-management.png)](docs/screenshots/menu-management.png)*Main menu management interface with Nova integration*

[![Menu Structure Management](docs/screenshots/drag-drop.png)](docs/screenshots/drag-drop.png)*Menu item management with hierarchical structure and edit controls*

Features
--------

[](#features)

- **🎯 Drag & Drop Interface**: Intuitive Vue.js-based interface with nested drag-and-drop functionality
- **⏰ Temporal Visibility**: Schedule menu items to appear/disappear at specific dates and times
- **🔗 Resource Integration**: Link menu items to any Nova resources with automatic URL generation
- **📊 Performance Monitoring**: Built-in query performance monitoring and optimization suggestions
- **🌳 Nested Hierarchy**: Unlimited nesting levels with configurable depth limits
- **✅ Comprehensive Testing**: 90%+ test coverage with unit, integration, and E2E tests
- **🎨 Responsive Design**: Mobile-friendly interface with accessibility support
- **⚡ Optimized Queries**: Efficient nested set implementation for fast hierarchy operations

Requirements
------------

[](#requirements)

- PHP 8.2+
- Laravel 10.0+
- Laravel Nova 4.0+ or 5.0+

Installation
------------

[](#installation)

You can install the package via Composer:

```
composer require skylark-team/nova-menus
```

After installation, publish and run the migrations:

```
php artisan vendor:publish --tag="menus-migrations"
php artisan migrate
```

Optionally, you can publish the config file:

```
php artisan vendor:publish --tag="menus-config"
```

Register the tool in your `NovaServiceProvider`:

```
use Skylark\Menus\MenusTool;

public function tools()
{
    return [
        new MenusTool(),
    ];
}
```

Usage
-----

[](#usage)

### Basic Menu Management

[](#basic-menu-management)

1. **Access the Tool**: Navigate to "Menus" in your Nova sidebar
2. **Create a Menu**: Click "Create Menu" and provide a name and slug
3. **Add Items**: Use "Manage Items" to add menu items with drag-and-drop functionality
4. **Configure Links**: Set custom URLs or link to Nova resources
5. **Set Visibility**: Configure when items should be visible (always, never, or scheduled)

### Programmatic Usage

[](#programmatic-usage)

#### Creating Menus Programmatically

[](#creating-menus-programmatically)

```
use Skylark\Menus\Models\MenuItem;

// Create a root menu
$menu = MenuItem::create([
    'name' => 'Main Navigation',
    'slug' => 'main-nav',
    'is_root' => true,
    'max_depth' => 6,
]);

// Add menu items
$homeItem = MenuItem::create([
    'menu_id' => $menu->id,
    'name' => 'Home',
    'custom_url' => '/',
    'position' => 1,
]);

$aboutItem = MenuItem::create([
    'menu_id' => $menu->id,
    'name' => 'About',
    'custom_url' => '/about',
    'position' => 2,
]);
```

#### Retrieving Menu Data

[](#retrieving-menu-data)

```
// Get a menu with all items
$menu = MenuItem::where('slug', 'main-nav')->first();
$items = $menu->children()->visible()->ordered()->get();

// Get hierarchical structure
$tree = MenuItem::where('menu_id', $menu->id)
    ->with('children.children')
    ->whereNull('parent_id')
    ->ordered()
    ->get();
```

#### Visibility Filtering

[](#visibility-filtering)

```
use Carbon\Carbon;

// Get currently visible items
$visibleItems = MenuItem::visible()->get();

// Get items visible at specific time
$futureDate = Carbon::parse('2024-12-25 00:00:00');
$christmasItems = MenuItem::isVisibleAt($futureDate)->get();

// Create scheduled item
MenuItem::create([
    'name' => 'Holiday Special',
    'custom_url' => '/holiday',
    'display_at' => '2024-12-01 00:00:00',
    'hide_at' => '2024-12-31 23:59:59',
]);
```

### Frontend Integration

[](#frontend-integration)

#### Blade Templates

[](#blade-templates)

```
@php
$menu = \Skylark\Menus\Models\MenuItem::where('slug', 'main-nav')->first();
$items = $menu ? $menu->children()->visible()->ordered()->get() : collect();
@endphp

    @foreach ($items as $item)

            {{ $item->name }}

        @if ($item->children->isNotEmpty())

                @foreach ($item->children as $child)

                        {{ $child->name }}

                @endforeach

        @endif
    @endforeach

```

#### API Usage

[](#api-usage)

```
// In your controller
public function getMenu($slug)
{
    $menu = MenuItem::where('slug', $slug)->first();

    if (!$menu) {
        return response()->json(['error' => 'Menu not found'], 404);
    }

    $tree = $menu->children()
        ->visible()
        ->with(['children' => function ($query) {
            $query->visible()->ordered();
        }])
        ->ordered()
        ->get();

    return response()->json($tree);
}
```

Configuration
-------------

[](#configuration)

The config file allows you to customize various aspects of the menu system:

```
return [
    // Maximum nesting depth
    'max_depth' => 10,

    // Performance monitoring
    'performance_monitoring' => env('MENUS_PERFORMANCE_MONITORING', false),
    'slow_query_threshold' => 100, // milliseconds
    'log_slow_queries' => env('MENUS_LOG_SLOW_QUERIES', false),

    // Resource integration
    'resources' => [
        'App\\Models\\Page' => [
            'model' => 'App\\Models\\Page',
            'name_field' => 'title',
            'slug_field' => 'slug',
            'route_pattern' => '/pages/{slug}',
        ],
        // Add more resource types...
    ],

    // Cache settings
    'cache' => [
        'enabled' => true,
        'ttl' => 3600, // 1 hour
        'key_prefix' => 'menus',
    ],
];
```

Performance Optimization
------------------------

[](#performance-optimization)

### Database Optimization

[](#database-optimization)

The package includes performance monitoring tools:

```
# Analyze query performance
php artisan menus:analyze-performance

# Generate optimization recommendations
php artisan menus:analyze-performance --threshold=50 --export=performance-report.json
```

### Recommended Database Indexes

[](#recommended-database-indexes)

For optimal performance, ensure these indexes exist:

```
-- Basic indexes
CREATE INDEX idx_menu_items_menu_id ON menu_items(menu_id);
CREATE INDEX idx_menu_items_parent_id ON menu_items(parent_id);
CREATE INDEX idx_menu_items_position ON menu_items(position);

-- Composite indexes for better performance
CREATE INDEX idx_menu_items_menu_parent ON menu_items(menu_id, parent_id);
CREATE INDEX idx_menu_items_parent_position ON menu_items(parent_id, position);
CREATE INDEX idx_menu_items_visibility ON menu_items(is_active, display_at, hide_at);

-- Nested set indexes (if using nested set model)
CREATE INDEX idx_menu_items_lft_rgt ON menu_items(lft, rgt);
```

### Caching

[](#caching)

Enable caching for frequently accessed menus:

```
use Skylark\Menus\Models\MenuItem;

// Cache menu for 1 hour
$menu = Cache::remember("menu.{$slug}", 3600, function () use ($slug) {
    return MenuItem::where('slug', $slug)
        ->with(['children' => function ($query) {
            $query->visible()->ordered();
        }])
        ->first();
});
```

Testing
-------

[](#testing)

The package includes comprehensive tests covering unit, integration, and end-to-end scenarios:

```
# Run all tests
composer test

# Run with coverage
composer test-coverage

# Run specific test types
vendor/bin/pest tests/Unit
vendor/bin/pest tests/Feature
vendor/bin/pest tests/Performance

# Run E2E tests with Playwright
npm run test:e2e
```

### Test Categories

[](#test-categories)

- **Unit Tests**: Model validation, service logic, utilities
- **Feature Tests**: API endpoints, database operations, Nova integration
- **Performance Tests**: Large dataset handling, query optimization
- **Vue Component Tests**: Frontend component functionality
- **E2E Tests**: Complete user workflows with Playwright

Development
-----------

[](#development)

### Setting Up Development Environment

[](#setting-up-development-environment)

```
# Clone the repository
git clone https://github.com/skylark-team/nova-menus.git
cd nova-menus

# Install dependencies
composer install
npm install

# Set up testing environment
cp .env.example .env
php artisan key:generate
php artisan migrate --database=testing

# Run development server
composer run dev
```

### Code Quality

[](#code-quality)

```
# Format code
composer format

# Check code style
composer lint

# Run static analysis
composer analyse

# Run all quality checks
composer test && composer lint && composer analyse
```

API Reference
-------------

[](#api-reference)

### Model Methods

[](#model-methods)

#### MenuItem Model

[](#menuitem-model)

```
// Hierarchy methods
$item->children()           // Get direct children
$item->descendants          // Get all descendants
$item->ancestors           // Get all ancestors
$item->siblings()          // Get siblings

// Visibility methods
MenuItem::visible()        // Scope for visible items
MenuItem::isVisibleAt($date) // Scope for items visible at date
$item->isCurrentlyVisible() // Check if item is visible now

// Utility methods
$item->getUrl()           // Get the item URL
$item->isCurrentPage()    // Check if item matches current page
$item->hasChildren()      // Check if item has children
```

### Service Classes

[](#service-classes)

#### QueryPerformanceMonitor

[](#queryperformancemonitor)

```
use Skylark\Menus\Services\QueryPerformanceMonitor;

$monitor = new QueryPerformanceMonitor();

// Monitor specific operation
$stats = $monitor->monitor(function () {
    return MenuItem::with('children')->get();
});

// Get optimization suggestions
$suggestions = $monitor->getMenuOptimizationSuggestions();
```

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.

Security Vulnerabilities
------------------------

[](#security-vulnerabilities)

Please review our [security policy](../../security/policy) on how to report security vulnerabilities.

Changelog
---------

[](#changelog)

Please see [CHANGELOG.md](CHANGELOG.md) for more information on what has changed recently.

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

Credits
-------

[](#credits)

- [Skylark Team](https://github.com/skylark-team)

Support
-------

[](#support)

If you discover any issues or have questions, please:

1. Check the [documentation](https://skylark-team.github.io/nova-menus)
2. Search [existing issues](https://github.com/skylark-team/nova-menus/issues)
3. Create a [new issue](https://github.com/skylark-team/nova-menus/issues/new) if needed

For commercial support, please contact us at .

###  Health Score

16

—

LowBetter than 4% of packages

Maintenance39

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity14

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/577808?v=4)[Igor Zhavoronkin](/maintainers/Skylark)[@SkyLark](https://github.com/SkyLark)

---

Top Contributors

[![t2thec](https://avatars.githubusercontent.com/u/2419418?v=4)](https://github.com/t2thec "t2thec (7 commits)")

### Embed Badge

![Health badge](/badges/skylark-team-nova-menus/health.svg)

```
[![Health](https://phpackages.com/badges/skylark-team-nova-menus/health.svg)](https://phpackages.com/packages/skylark-team-nova-menus)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)