README

Database-driven dynamic navigation menus for Filament panels with multi-tenancy support.

Alih-alih mendefinisikan navigasi secara statis di PanelProvider, package ini memungkinkan kamu mengelola sidebar menu langsung dari Filament admin panel — termasuk grup, item, visibility berbasis role/permission, badge, dan pengaturan sidebar.

Persyaratan

• PHP ^8.2
• Laravel ^11.0
• Filament ^5.0

Langkah Instalasi

1. Install via Composer

composer require susantokun/filament-dynamic-menu

2. Jalankan Perintah Install

php artisan filament-dynamic-menu:install

Perintah ini akan:

• Mempublish file konfigurasi (config/filament-dynamic-menu.php)
• Mempublish file migrasi ke database/migrations/
• Mempublish file terjemahan (EN & ID)
• Mempublish file views
• Menanyakan apakah ingin langsung menjalankan migrasi

Gunakan opsi --force jika kamu ingin menimpa file yang sudah ada:

php artisan filament-dynamic-menu:install --force

3. Aktifkan Dynamic Menu

Buka .env dan tambahkan:

FILAMENT_DYNAMIC_MENU_ENABLED=true

Atau ubah langsung di config/filament-dynamic-menu.php:

'enabled' => true,

4. Pasang Trait di PanelProvider

Buka app/Providers/Filament/AdminPanelProvider.php (atau PanelProvider yang kamu gunakan), lalu tambahkan trait HasDynamicMenu:

<?php

namespace App\Providers\Filament;

use Filament\Pages\Dashboard;
use Filament\Panel;
use Filament\PanelProvider;
use Susantokun\FilamentDynamicMenu\Filament\Pages\MenuSettings;
use Susantokun\FilamentDynamicMenu\Filament\Resources\MenuItemResource;
use Susantokun\FilamentDynamicMenu\Filament\Resources\MenuGroupResource;
use Susantokun\FilamentDynamicMenu\Traits\HasDynamicMenu;

class AdminPanelProvider extends PanelProvider
{
    use HasDynamicMenu;

    public function panel(Panel $panel): Panel
    {
        $panel = $panel
            ->default()
            ->id('admin')
            ->pages([
                Dashboard::class,
                MenuSettings::class,
            ])
            ->resources([
                MenuItemResource::class,
                MenuGroupResource::class,
            ]);

        $panel = $this->dynamicMenu($panel);
        $panel = $this->dynamicMenuSettings($panel);

        return $panel;
    }
}

Penting: MenuSettings::class harus didaftarkan di ->pages() agar halaman pengaturan sidebar muncul di panel.

6. (Opsional) Konfigurasi Role & Permission

Jika kamu menggunakan spatie/laravel-permission, tentukan model Role dan Permission di config/filament-dynamic-menu.php:

'role_model' => \Spatie\Permission\Models\Role::class,
'permission_model' => \Spatie\Permission\Models\Permission::class,

Jika kamu menggunakan bezhansalleh/filament-shield, package ini akan otomatis me-resolve nama permission dari Resource/Page/Cluster target.

Hasil Akhir

Setelah semua langkah selesai, buka Filament admin panel kamu. Di sidebar akan muncul Settings > Menu Settings yang berisi:

Saat pertama kali, jika belum ada data menu, package akan otomatis menjalankan DefaultMenuSeeder yang membuat "Main Menu" group dengan item "Dashboard".

Konfigurasi Penting

Facade

Package ini menyediakan facade DynamicMenu:

use Susantokun\FilamentDynamicMenu\Facades\DynamicMenu;

DynamicMenu::isEnabled();   // cek apakah dynamic menu aktif
DynamicMenu::tenantMode();  // mode tenant yang digunakan
DynamicMenu::clearCache();  // hapus cache menu

Multi-Tenancy

Package mendukung 3 mode tenant:

• single — Tidak ada tenant, menu berlaku global.
• stancl — Menggunakan package stancl/tenancy.
• custom — Menggunakan model tenant kustom kamu sendiri. Set tenant_model di config.

Saat mode selain single, semua tabel akan memiliki kolom tenant_id dan data menu akan di-scope per tenant.

Lisensi

MIT