Column Select Core

- Add column select trait
- Add needed functionality to show/hide columns

Author: rappasoft

resources/lang/en.json

@@ -4,6 +4,7 @@
     "Applied Sorting": "Applied Sorting",
     "Bulk Actions": "Bulk Actions",
     "Clear": "Clear",
+    "Columns": "Columns",
     "Filters": "Filters",
     "Remove filter option": "Remove filter option",
     "Remove sort option": "Remove sort option",

src/DataTableComponent.php

@@ -8,6 +8,7 @@
 use Illuminate\Support\Collection;
 use Livewire\Component;
 use Rappasoft\LaravelLivewireTables\Traits\WithBulkActions;
+use Rappasoft\LaravelLivewireTables\Traits\WithColumnSelect;
 use Rappasoft\LaravelLivewireTables\Traits\WithCustomPagination;
 use Rappasoft\LaravelLivewireTables\Traits\WithFilters;
 use Rappasoft\LaravelLivewireTables\Traits\WithPerPagePagination;
@@ -22,6 +23,7 @@
 abstract class DataTableComponent extends Component
 {
     use WithBulkActions;
+    use WithColumnSelect;
     use WithCustomPagination;
     use WithFilters;
     use WithPerPagePagination;

src/Traits/WithColumnSelect.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Traits;
+
+use Rappasoft\LaravelLivewireTables\Views\Column;
+
+/**
+ * Trait WithColumnSelect.
+ */
+trait WithColumnSelect
+{
+    public bool $columnSelect = false;
+    public array $columnSelectExcluded = [];
+    public array $columnSelectEnabled = [];
+
+    public function mountWithColumnSelect(): void
+    {
+        // If the column select is off, make sure to clear the session
+        if (! $this->columnSelect && session()->has($this->tableName.'-columnSelectEnabled')) {
+            session()->forget($this->tableName.'-columnSelectEnabled');
+        }
+
+        // Get a list of visible default columns that are not excluded
+        $columns = collect($this->columns())
+            ->filter(fn ($column) => $column->isVisible() && ! $this->isColumnSelectExcluded($column))
+            ->map(fn ($column) => $column->column())
+            ->values()
+            ->toArray();
+
+        // Set to either the default set or what is stored in the session
+        $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]);
+            }
+        }
+    }
+
+    public function updatedColumnSelectEnabled(): void
+    {
+        session([$this->tableName.'-columnSelectEnabled' => $this->columnSelectEnabled]);
+    }
+
+    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);
+    }
+}