Always hide bulk actions option (#1752)

* Add option to "Always Hide Bulk Actions" * Fix styling * Fix test function name clash --------- Co-authored-by: lrljoe <[email protected]>
rappasoft · Jul 1, 2024 · 2acac1b · 2acac1b
1 parent ea2c8fc
commit 2acac1b
Show file tree

Hide file tree

Showing 6 changed files with 176 additions and 1 deletion.
diff --git a/docs/bulk-actions/available-methods.md b/docs/bulk-actions/available-methods.md
@@ -239,3 +239,38 @@ public function configure(): void
     ]);
 }
 ```
+
+## setShouldAlwaysHideBulkActionsDropdownOption
+
+Allows hiding the Bulk Actions button & menu, regardless of whether there are any items selected, or hideBulkActionsWhenEmptyEnabled behaviour
+
+```php
+public function configure(): void
+{
+    $this->setShouldAlwaysHideBulkActionsDropdownOption(true);
+}
+```
+
+
+## setShouldAlwaysHideBulkActionsDropdownOptionEnabled
+
+Allows hiding the Bulk Actions button & menu, regardless of whether there are any items selected, or hideBulkActionsWhenEmptyEnabled behaviour
+
+```php
+public function configure(): void
+{
+    $this->setShouldAlwaysHideBulkActionsDropdownOptionEnabled();
+}
+```
+
+
+## setShouldAlwaysHideBulkActionsDropdownOptionDisabled
+
+Restores the Bulk Actions to default functionality, so it will respect the hideBulkActionsWhenEmptyEnabled behaviour
+
+```php
+public function configure(): void
+{
+    $this->setShouldAlwaysHideBulkActionsDropdownOptionDisabled();
+}
+```
diff --git a/resources/views/components/tools/toolbar.blade.php b/resources/views/components/tools/toolbar.blade.php
@@ -56,7 +56,7 @@
             @include($component->getConfigurableAreaFor('toolbar-right-start'), $component->getParametersForConfigurableArea('toolbar-right-start'))
         @endif
 
-        @if ($component->showBulkActionsDropdownAlpine())
+        @if ($component->showBulkActionsDropdownAlpine() && $this->shouldAlwaysHideBulkActionsDropdownOption != true)
             <x-livewire-tables::tools.toolbar.items.bulk-actions />
         @endif
 

diff --git a/src/Traits/Configuration/BulkActionsConfiguration.php b/src/Traits/Configuration/BulkActionsConfiguration.php
@@ -150,4 +150,25 @@ public function setBulkActionsTdCheckboxAttributes(array $bulkActionsTdCheckboxA
 
         return $this;
     }
+
+    public function setShouldAlwaysHideBulkActionsDropdownOption(bool $status = false): self
+    {
+        $this->alwaysHideBulkActionsDropdownOption = $status;
+
+        return $this;
+    }
+
+    public function setShouldAlwaysHideBulkActionsDropdownOptionEnabled(): self
+    {
+        $this->setShouldAlwaysHideBulkActionsDropdownOption(true);
+
+        return $this;
+    }
+
+    public function setShouldAlwaysHideBulkActionsDropdownOptionDisabled(): self
+    {
+        $this->setShouldAlwaysHideBulkActionsDropdownOption(false);
+
+        return $this;
+    }
 }
diff --git a/src/Traits/Helpers/BulkActionsHelpers.php b/src/Traits/Helpers/BulkActionsHelpers.php
@@ -2,6 +2,8 @@
 
 namespace Rappasoft\LaravelLivewireTables\Traits\Helpers;
 
+use Livewire\Attributes\Computed;
+
 trait BulkActionsHelpers
 {
     public function getBulkActionsStatus(): bool
@@ -212,4 +214,10 @@ public function getBulkActionsTdCheckboxAttributes(): array
     {
         return $this->bulkActionsTdCheckboxAttributes ?? ['default' => true];
     }
+
+    #[Computed]
+    public function shouldAlwaysHideBulkActionsDropdownOption(): bool
+    {
+        return $this->alwaysHideBulkActionsDropdownOption ?? false;
+    }
 }
diff --git a/src/Traits/WithBulkActions.php b/src/Traits/WithBulkActions.php
@@ -34,6 +34,8 @@ trait WithBulkActions
 
     protected array $bulkActionsTdCheckboxAttributes = ['default' => true];
 
+    protected bool $alwaysHideBulkActionsDropdownOption = false;
+
     public function bulkActions(): array
     {
         return property_exists($this, 'bulkActions') ? $this->bulkActions : [];

diff --git a/tests/Traits/Visuals/BulkActionsVisualsTest.php b/tests/Traits/Visuals/BulkActionsVisualsTest.php
@@ -80,4 +80,113 @@ public function test_bulk_actions_row_shows_correct_for_select_some(): void
             ->assertSee('do you want to select all')
             ->assertDontSee('You are currently selecting all');
     }*/
+
+    public function test_bulk_dropdown_shows_when_necessary_extended(): void
+    {
+        Livewire::test(new class extends PetsTable
+        {
+            public function configure(): void
+            {
+                $this->setPrimaryKey('id');
+            }
+
+            public function bulkActions(): array
+            {
+                return ['exportBulk' => 'exportBulk'];
+            }
+
+            public function exportBulk($items)
+            {
+                return $items;
+            }
+        })->assertSee('Bulk Actions');
+    }
+
+    public function test_bulk_dropdown_shows_when_not_permanently_hidden(): void
+    {
+        Livewire::test(new class extends PetsTable
+        {
+            public function configure(): void
+            {
+                $this->setPrimaryKey('id')
+                    ->setShouldAlwaysHideBulkActionsDropdownOption(false);
+            }
+
+            public function bulkActions(): array
+            {
+                return ['exportBulk' => 'exportBulk'];
+            }
+
+            public function exportBulk($items)
+            {
+                return $items;
+            }
+        })->assertSee('Bulk Actions');
+    }
+
+    public function test_bulk_dropdown_hides_when_permanently_hidden(): void
+    {
+        Livewire::test(new class extends PetsTable
+        {
+            public function configure(): void
+            {
+                $this->setPrimaryKey('id')
+                    ->setShouldAlwaysHideBulkActionsDropdownOption(true);
+            }
+
+            public function bulkActions(): array
+            {
+                return ['exportBulk' => 'exportBulk'];
+            }
+
+            public function exportBulk($items)
+            {
+                return $items;
+            }
+        })->assertDontSee('Bulk Actions');
+    }
+
+    public function test_bulk_dropdown_shows_when_not_permanently_hidden_disabled(): void
+    {
+        Livewire::test(new class extends PetsTable
+        {
+            public function configure(): void
+            {
+                $this->setPrimaryKey('id')
+                    ->setShouldAlwaysHideBulkActionsDropdownOptionDisabled();
+            }
+
+            public function bulkActions(): array
+            {
+                return ['exportBulk' => 'exportBulk'];
+            }
+
+            public function exportBulk($items)
+            {
+                return $items;
+            }
+        })->assertSee('Bulk Actions');
+    }
+
+    public function test_bulk_dropdown_hides_when_permanently_hidden_enabled(): void
+    {
+        Livewire::test(new class extends PetsTable
+        {
+            public function configure(): void
+            {
+                $this->setPrimaryKey('id')
+                    ->setShouldAlwaysHideBulkActionsDropdownOptionEnabled();
+            }
+
+            public function bulkActions(): array
+            {
+                return ['exportBulk' => 'exportBulk'];
+            }
+
+            public function exportBulk($items)
+            {
+                return $items;
+            }
+        })->assertDontSee('Bulk Actions');
+    }
 }