Move exclusion to Column component

Author: rappasoft

resources/views/tailwind/includes/column-select.blade.php

@@ -40,7 +40,7 @@ class="origin-top-right absolute right-0 mt-2 w-48 rounded-md shadow-lg z-50"
                 <div class="rounded-md bg-white shadow-xs">
                     <div class="p-2" role="menu" aria-orientation="vertical" aria-labelledby="column-select-menu">
                         @foreach($columns as $column)
-                            @if ($column->isVisible() && ! $this->isColumnSelectExcluded($column))
+                            @if ($column->isVisible() && $column->isSelectable())
                                 <div>
                                     <label class="px-2 py-1 inline-flex items-center">
                                         <input wire:model="columnSelectEnabled" type="checkbox" value="{{ $column->column() }}">

src/Traits/WithColumnSelect.php

@@ -10,7 +10,6 @@
 trait WithColumnSelect
 {
     public bool $columnSelect = false;
-    public array $columnSelectExcluded = [];
     public array $columnSelectEnabled = [];
 
     public function mountWithColumnSelect(): void
@@ -22,7 +21,7 @@ public function mountWithColumnSelect(): void
 
         // Get a list of visible default columns that are not excluded
         $columns = collect($this->columns())
-            ->filter(fn ($column) => $column->isVisible() && ! $this->isColumnSelectExcluded($column))
+            ->filter(fn ($column) => $column->isVisible() && $column->isSelectable())
             ->map(fn ($column) => $column->column())
             ->values()
             ->toArray();
@@ -31,9 +30,10 @@ public function mountWithColumnSelect(): void
         $this->columnSelectEnabled = session()->get($this->tableName.'-columnSelectEnabled', $columns);
 
         // Check to see if there are any excluded that are already stored in the enabled and remove them
-        foreach ($this->columnSelectExcluded as $column) {
-            if (! in_array($column, $this->columnSelectEnabled, true)) {
-                session([$this->tableName.'-columnSelectEnabled' => $this->columnSelectEnabled[] = $column]);
+        foreach ($this->columns() as $column) {
+            if (! $column->isSelectable() && ! in_array($column->column(), $this->columnSelectEnabled, true)) {
+                $this->columnSelectEnabled[] = $column->column();
+                session([$this->tableName.'-columnSelectEnabled' => $this->columnSelectEnabled]);
             }
         }
     }
@@ -47,9 +47,4 @@ public function isColumnSelectEnabled($column): bool
     {
         return in_array($column instanceof Column ? $column->column() : $column, $this->columnSelectEnabled, true);
     }
-
-    public function isColumnSelectExcluded($column): bool
-    {
-        return in_array($column instanceof Column ? $column->column() : $column, $this->columnSelectExcluded, true);
-    }
 }

src/Views/Column.php

@@ -64,6 +64,11 @@ class Column
      */
     public bool $hidden = false;
 
+    /**
+     * @var bool
+     */
+    public bool $selectable = true;
+
     /**
      * Column constructor.
      *
@@ -287,4 +292,22 @@ public function isVisible(): bool
     {
         return $this->hidden !== true;
     }
+
+    /**
+     * @return $this
+     */
+    public function excludeFromSelectable(): self
+    {
+        $this->selectable = false;
+
+        return $this;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isSelectable(): bool
+    {
+        return $this->selectable === true;
+    }
 }