#39 shouldRegisterSpotlight() for resources and resource pages

readme.md

@@ -79,6 +79,19 @@ CMD + /
 
 This plugin relies on the same properties and methods used for Filament's global search. For records showing up with the correct name in "Edit/View" you need to set `$recordTitleAttribute`. [Check the docs for more information](https://filamentphp.com/docs/2.x/admin/resources/global-search)
 
+#### Excluding pages
+
+If you need to exclude a page from the spotlight results you may do so by adding a static `shouldRegisterSpotlight` method to the page and return false:
+
+```php
+public static function shouldRegisterSpotlight(): bool
+{
+    return false;
+}
+```
+
+This can be useful when you have pages that require URL parameters.
+
 ## Translation
 
 To translate or edit the default placeholder, you have to publish the translation file for *wire-element/spotlight*: 

src/Actions/RegisterPages.php

@@ -20,6 +20,10 @@ public static function boot(Panel $panel)
              */
             $page = new $pageClass();
 
+            if (method_exists($page, 'shouldRegisterSpotlight') && $page::shouldRegisterSpotlight() === false) {
+                continue;
+            }
+
             $name = collect([
                 $page->getNavigationGroup(),
                 $page->getTitle(),

src/Actions/RegisterResources.php

@@ -14,9 +14,17 @@ public static function boot(Panel $panel)
         $resources = $panel->getResources();
 
         foreach ($resources as $resource) {
+            if (method_exists($resource, 'shouldRegisterSpotlight') && $resource::shouldRegisterSpotlight() === false) {
+                continue;
+            }
+
             $pages = $resource::getPages();
 
             foreach ($pages as $key => $page) {
+                if (method_exists($page->getPage(), 'shouldRegisterSpotlight') && $page->getPage()::shouldRegisterSpotlight() === false) {
+                    continue;
+                }
+
                 /**
                  * @var PageRegistration $page
                  */