Merge pull request #1 from awcodes/feat/excludes

Feat: add includes and excludes to config

README.md

@@ -15,10 +15,27 @@ You can install the package via composer:
 composer require awcodes/overlook
 ```
 
-Optionally, you can publish the views using
+## Usage
+
+By default, Overlook will display any resource registered with Filament, while still honoring the `canViewAny` policy. This can be undesired and also slow down the dashboard. To prevent this behavior publish the config file with:
 
 ```bash
-php artisan vendor:publish --tag="overlook-views"
+php artisan vendor:publish --tag="overlook-config"
+```
+
+Inside the config you will have options to either "include" or "exclude" resources from being displayed.
+
+```php
+return [
+    'includes' => [
+        App\Filament\Resources\Blog\AuthorResource::class,
+        App\Filament\Resources\Blog\CategoryResource::class,
+        App\Filament\Resources\Blog\PostResource::class,
+    ],
+    'excludes' => [
+//        App\Filament\Resources\Blog\AuthorResource::class,
+    ],
+];
 ```
 
 ## Changelog

composer.json

@@ -20,7 +20,7 @@
         }
     ],
     "require": {
-        "php": "^8.0",
+        "php": "^8.1",
         "filament/filament": "^2.0",
         "spatie/laravel-package-tools": "^1.13.5"
     },

config/overlook.php

@@ -0,0 +1,10 @@
+<?php
+
+return [
+    'includes' => [
+        // App\Filament\Resources\Blog\AuthorResource::class,
+    ],
+    'excludes' => [
+        // App\Filament\Resources\Blog\AuthorResource::class,
+    ],
+];

resources/views/widget.blade.php

@@ -1,23 +1,20 @@
-<x-filament::widget id="overlook-widget">
+<x-filament::widget id="overlook-widget" @class(['hidden' => ! $data])>
     @if($data)
-        <h2 class="font-semibold text-sm uppercase">{{ __('overlook::overlook.heading') }}</h2>
-
-        <ul class="grid grid-cols-2 md:grid-cols-3 lg:grid-cols-4 xl:grid-cols-5 gap-6 mt-4">
+        <ul class="grid grid-cols-2 md:grid-cols-3 lg:grid-cols-4 xl:grid-cols-5 gap-6">
             @foreach($data as $resource)
                 <li class="rounded-xl border border-gray-200 dark:border-gray-800 relative h-24 bg-gradient-to-tr from-gray-100 via-white to-white dark:from-gray-900 dark:via-gray-800 dark:to-gray-800" wire:key="{{ $resource['name'] }}">
                     <a href="{{ $resource['url'] }}" class="overflow-hidden absolute inset-0 py-2 px-3 text-gray-600 font-medium rounded-xl ring-primary-500 dark:text-gray-400 group hover:ring-2 focus:ring-2">
                         @if ($resource['icon'])
-                            <x-dynamic-component
-                                :component="$resource['icon']"
-                                class="w-auto h-24 absolute left-0 top-8 text-primary-500 opacity-20 dark:opacity-20 transition group-hover:scale-110 group-hover:-rotate-12 group-hover:opacity-40 dark:group-hover:opacity-80"
-                            />
+                            @svg($resource['icon'], 'w-auto h-24 absolute left-0 top-8 text-primary-500 opacity-20 dark:opacity-20 transition group-hover:scale-110 group-hover:-rotate-12 group-hover:opacity-40 dark:group-hover:opacity-80')
                         @endif
                         {{ $resource['name'] }}
                         <span class="text-gray-600 dark:text-gray-300 absolute bottom-4 right-4 text-3xl font-bold">{{ $resource['count'] }}</span>
                     </a>
                 </li>
             @endforeach
         </ul>
+    @else
+        <div class="-my-8"></div>
     @endif
 </x-filament::widget>
 

src/Overlook.php

@@ -3,6 +3,7 @@
 namespace Awcodes\Overlook;
 
 use Filament\Facades\Filament;
+use Filament\Resources\Resource;
 use Filament\Widgets\Widget;
 use Illuminate\Support\Str;
 
@@ -14,19 +15,33 @@ class Overlook extends Widget
 
     public array $data = [];
 
-    private array $excludes = [];
+    protected array $excludes = [];
+
+    protected array $includes = [];
 
     public function mount(): void
     {
         $this->data = $this->getData();
     }
 
+    public function getIncludes(): array
+    {
+        return $this->includes = config('overlook.includes');
+    }
+
+    public function getExcludes(): array
+    {
+        return $this->excludes = config('overlook.excludes');
+    }
+
     public function getData(): array
     {
-        $rawResources = Filament::getResources();
+        $rawResources = filled($this->getIncludes())
+            ? $this->getIncludes()
+            : Filament::getResources();
 
         return collect($rawResources)->filter(function ($resource) {
-            return ! in_array(Str::of($resource)->afterLast('\\'), $this->excludes);
+            return ! in_array($resource, $this->getExcludes());
         })->transform(function ($resource) {
             $res = app($resource);
             $model = $res->getModel();

src/OverlookServiceProvider.php

@@ -20,7 +20,7 @@ public function configurePackage(Package $package): void
 
         $package
             ->name(static::$name)
-            ->hasTranslations()
+            ->hasConfigFile()
             ->hasViews(static::$viewNamespace);
     }