Merge pull request #7 from Log1x/feat/override-resource

🧑‍💻 Add support for overriding the menu resource

README.md

@@ -174,7 +174,7 @@ $panel
             ])
             ->addMenuItemFields([
                 TextInput::make('classes'),
-            ]),
+            ])
     )
 ```
 
@@ -219,6 +219,42 @@ return new class extends Migration
 
 Once done, simply run `php artisan migrate`.
 
+### Customizing the Resource
+
+Out of the box, a default Menu Resource is registered with Filament when registering the plugin in the admin provider. This resource can be extended and overridden allowing for more fine-grained control.
+
+Start by extending the `Datlechin\FilamentMenuBuilder\Resources\MenuResource` class in your application. Below is an example:
+
+```php
+namespace App\Filament\Plugins\Resources;
+
+use Datlechin\FilamentMenuBuilder\Resources\MenuResource as BaseMenuResource;
+
+class MenuResource extends BaseMenuResource
+{
+    protected static ?string $navigationGroup = 'Navigation';
+
+    public static function getNavigationBadge(): ?string
+    {
+        return number_format(static::getModel()::count());
+    }
+}
+```
+
+Now pass the custom resource to `usingResource` while registering the plugin with the panel:
+
+```php
+use App\Filament\Plugins\Resources\MenuResource;
+use Datlechin\FilamentMenuBuilder\FilamentMenuBuilderPlugin;
+
+$panel
+    ...
+    ->plugin(
+        FilamentMenuBuilderPlugin::make()
+            ->usingResource(MenuResource::class)
+    )
+```
+
 ## Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

src/FilamentMenuBuilderPlugin.php

@@ -11,6 +11,8 @@
 
 class FilamentMenuBuilderPlugin implements Plugin
 {
+    protected string $resource = MenuResource::class;
+
     protected array $locations = [];
 
     protected array | Closure $menuFields = [];
@@ -29,9 +31,7 @@ public function getId(): string
 
     public function register(Panel $panel): void
     {
-        $panel->resources([
-            MenuResource::class,
-        ]);
+        $panel->resources([$this->getResource()]);
     }
 
     public function boot(Panel $panel): void
@@ -52,6 +52,13 @@ public static function get(): static
         return $plugin;
     }
 
+    public function usingResource(string $resource): static
+    {
+        $this->resource = $resource;
+
+        return $this;
+    }
+
     public function addLocation(string $key, string $label): static
     {
         $this->locations[$key] = $label;
@@ -94,6 +101,11 @@ public function addMenuItemFields(array | Closure $schema): static
         return $this;
     }
 
+    public function getResource(): string
+    {
+        return $this->resource;
+    }
+
     /**
      * @return MenuPanel[]
      */

src/Resources/MenuResource/Pages/EditMenu.php

@@ -4,8 +4,8 @@
 
 namespace Datlechin\FilamentMenuBuilder\Resources\MenuResource\Pages;
 
+use Datlechin\FilamentMenuBuilder\FilamentMenuBuilderPlugin;
 use Datlechin\FilamentMenuBuilder\Models\Menu;
-use Datlechin\FilamentMenuBuilder\Resources\MenuResource;
 use Filament\Actions;
 use Filament\Forms\Components\Section;
 use Filament\Forms\Form;
@@ -15,10 +15,13 @@
 
 class EditMenu extends EditRecord
 {
-    protected static string $resource = MenuResource::class;
-
     protected static string $view = 'filament-menu-builder::edit-record';
 
+    public static function getResource(): string
+    {
+        return FilamentMenuBuilderPlugin::get()->getResource();
+    }
+
     public function form(Form $form): Form
     {
         return $form

src/Resources/MenuResource/Pages/ListMenus.php

@@ -4,13 +4,16 @@
 
 namespace Datlechin\FilamentMenuBuilder\Resources\MenuResource\Pages;
 
-use Datlechin\FilamentMenuBuilder\Resources\MenuResource;
+use Datlechin\FilamentMenuBuilder\FilamentMenuBuilderPlugin;
 use Filament\Actions;
 use Filament\Resources\Pages\ListRecords;
 
 class ListMenus extends ListRecords
 {
-    protected static string $resource = MenuResource::class;
+    public static function getResource(): string
+    {
+        return FilamentMenuBuilderPlugin::get()->getResource();
+    }
 
     protected function getHeaderActions(): array
     {