Add ability to hide columns with a conditional

Author: rappasoft

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to `laravel-livewire-tables` will be documented in this file
 
 ## [Unreleased]
 
+### Added
+
+- Added hideIf for columns to hide a column with a conditional, works out of the box for cells not using rowView, if using rowView you must wrap the cells you want to hide in the same conditional. [See documentation](https://github.com/rappasoft/laravel-livewire-tables/wiki/Conditionally-hiding-columns).
+
 ## [1.4.0] - 2021-04-29
 
 ### Added

resources/views/bootstrap-4/components/table/row-columns.blade.php

@@ -1,9 +1,11 @@
 @foreach($columns as $column)
-    <td>
-        @if ($column->asHtml)
-            {{ new \Illuminate\Support\HtmlString($column->formatted($row)) }}
-        @else
-            {{ $column->formatted($row) }}
-        @endif
-    </td>
+    @if ($column->isVisible())
+        <td>
+            @if ($column->asHtml)
+                {{ new \Illuminate\Support\HtmlString($column->formatted($row)) }}
+            @else
+                {{ $column->formatted($row) }}
+            @endif
+        </td>
+    @endif
 @endforeach

resources/views/bootstrap-4/includes/table.blade.php

@@ -10,16 +10,18 @@
         @endif
 
         @foreach($columns as $column)
-            @if ($column->isBlank())
-                <x-livewire-tables::bs4.table.heading />
-            @else
-                <x-livewire-tables::bs4.table.heading
-                    :sortable="$column->isSortable()"
-                    :column="$column->column()"
-                    :direction="$column->column() ? $sorts[$column->column()] ?? null : null"
-                    :text="$column->text() ?? ''"
-                    :class="$column->class() ?? ''"
-                />
+            @if ($column->isVisible())
+                @if ($column->isBlank())
+                    <x-livewire-tables::bs4.table.heading />
+                @else
+                    <x-livewire-tables::bs4.table.heading
+                        :sortable="$column->isSortable()"
+                        :column="$column->column()"
+                        :direction="$column->column() ? $sorts[$column->column()] ?? null : null"
+                        :text="$column->text() ?? ''"
+                        :class="$column->class() ?? ''"
+                    />
+                @endif
             @endif
         @endforeach
     </x-slot>

resources/views/bootstrap-5/components/table/row-columns.blade.php

@@ -1,9 +1,11 @@
 @foreach($columns as $column)
-    <td>
-        @if ($column->asHtml)
-            {{ new \Illuminate\Support\HtmlString($column->formatted($row)) }}
-        @else
-            {{ $column->formatted($row) }}
-        @endif
-    </td>
+    @if ($column->isVisible())
+        <td>
+            @if ($column->asHtml)
+                {{ new \Illuminate\Support\HtmlString($column->formatted($row)) }}
+            @else
+                {{ $column->formatted($row) }}
+            @endif
+        </td>
+    @endif
 @endforeach

resources/views/bootstrap-5/includes/table.blade.php

@@ -11,16 +11,18 @@ class="form-check-input"
         @endif
 
         @foreach($columns as $column)
-            @if ($column->isBlank())
-                <x-livewire-tables::bs5.table.heading />
-            @else
-                <x-livewire-tables::bs5.table.heading
-                    :sortable="$column->isSortable()"
-                    :column="$column->column()"
-                    :direction="$column->column() ? $sorts[$column->column()] ?? null : null"
-                    :text="$column->text() ?? ''"
-                    :class="$column->class() ?? ''"
-                />
+            @if ($column->isVisible())
+                @if ($column->isBlank())
+                    <x-livewire-tables::bs5.table.heading />
+                @else
+                    <x-livewire-tables::bs5.table.heading
+                        :sortable="$column->isSortable()"
+                        :column="$column->column()"
+                        :direction="$column->column() ? $sorts[$column->column()] ?? null : null"
+                        :text="$column->text() ?? ''"
+                        :class="$column->class() ?? ''"
+                    />
+                @endif
             @endif
         @endforeach
     </x-slot>

resources/views/tailwind/components/table/row-columns.blade.php

@@ -1,9 +1,11 @@
 @foreach($columns as $column)
-    <x-livewire-tables::table.cell>
-        @if ($column->asHtml)
-            {{ new \Illuminate\Support\HtmlString($column->formatted($row)) }}
-        @else
-            {{ $column->formatted($row) }}
-        @endif
-    </x-livewire-tables::table.cell>
+    @if ($column->isVisible())
+        <x-livewire-tables::table.cell>
+            @if ($column->asHtml)
+                {{ new \Illuminate\Support\HtmlString($column->formatted($row)) }}
+            @else
+                {{ $column->formatted($row) }}
+            @endif
+        </x-livewire-tables::table.cell>
+    @endif
 @endforeach

resources/views/tailwind/includes/table.blade.php

@@ -13,16 +13,18 @@ class="rounded-md shadow-sm border-gray-300 block transition duration-150 ease-i
         @endif
 
         @foreach($columns as $column)
-            @if ($column->isBlank())
-                <x-livewire-tables::table.heading />
-            @else
-                <x-livewire-tables::table.heading
-                    :sortable="$column->isSortable()"
-                    :column="$column->column()"
-                    :direction="$column->column() ? $sorts[$column->column()] ?? null : null"
-                    :text="$column->text() ?? ''"
-                    :class="$column->class() ?? ''"
-                />
+            @if ($column->isVisible())
+                @if ($column->isBlank())
+                    <x-livewire-tables::table.heading />
+                @else
+                    <x-livewire-tables::table.heading
+                        :sortable="$column->isSortable()"
+                        :column="$column->column()"
+                        :direction="$column->column() ? $sorts[$column->column()] ?? null : null"
+                        :text="$column->text() ?? ''"
+                        :class="$column->class() ?? ''"
+                    />
+                @endif
             @endif
         @endforeach
     </x-slot>

src/Views/Column.php

@@ -59,6 +59,11 @@ class Column
      */
     public bool $asHtml = false;
 
+    /**
+     * @var bool
+     */
+    public bool $hidden = false;
+
     /**
      * Column constructor.
      *
@@ -262,4 +267,24 @@ public function getSearchCallback(): ?callable
     {
         return $this->searchCallback;
     }
+
+    /**
+     * @param $condition
+     *
+     * @return $this
+     */
+    public function hideIf($condition): self
+    {
+        $this->hidden = $condition;
+
+        return $this;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isVisible(): bool
+    {
+        return $this->hidden !== true;
+    }
 }