Hide configurable areas when reordering

Author: rappasoft

CHANGELOG.md

@@ -4,12 +4,15 @@ All notable changes to `laravel-livewire-tables` will be documented in this file
 
 ## [Unreleased]
 
+## [2.4.0] - 2022-04-30
+
 ### Added
 
 - Added table event listeners to sort/filter/clear from other components.
 - Added text filter.
 - Added $row as second parameter to BooleanColumn `setCallback()`.
 - Added `setThSortButtonAttributes()` to set attributes for th sort button.
+- Added `setHideConfigurableAreasWhenReorderingStatus()` to hide configurable areas when reordering status which now defaults to true.
 
 ### Changed
 
@@ -630,7 +633,8 @@ Ground Up Rebuild
 
 - Initial release
 
-[Unreleased]: https://github.com/rappasoft/laravel-livewire-tables/compare/v2.3.0...development
+[Unreleased]: https://github.com/rappasoft/laravel-livewire-tables/compare/v2.4.0...development
+[2.4.0]: https://github.com/rappasoft/laravel-livewire-tables/compare/v2.3.0...v2.4.0
 [2.3.0]: https://github.com/rappasoft/laravel-livewire-tables/compare/v2.2.1...v2.3.0
 [2.2.1]: https://github.com/rappasoft/laravel-livewire-tables/compare/v2.2.0...v2.2.1
 [2.2.0]: https://github.com/rappasoft/laravel-livewire-tables/compare/v2.1.0...v2.2.0

docs/datatable/configurable-areas.md

@@ -29,6 +29,43 @@ public function configure(): void
 
 **Note:** Only specify the keys you are actually implementing, otherwise you may get uneven spacing.
 
+### setHideConfigurableAreasWhenReorderingStatus
+
+Defaults to **true**, set whether or not configurable areas are hidden during reordering.
+
+```php
+public function configure(): void
+{
+  $this->setHideConfigurableAreasWhenReorderingStatus(true);
+  $this->setHideConfigurableAreasWhenReorderingStatus(false);
+}
+```
+
+### setHideConfigurableAreasWhenReorderingEnabled
+
+Hide configurable areas when reordering.
+
+```php
+public function configure(): void
+{
+  // Shorthand for $this->setHideConfigurableAreasWhenReorderingStatus(true)
+  $this->setHideConfigurableAreasWhenReorderingEnabled();
+}
+```
+
+### setHideConfigurableAreasWhenReorderingDisabled
+
+Show configurable areas when reordering.
+
+```php
+public function configure(): void
+{
+  // Shorthand for $this->setHideConfigurableAreasWhenReorderingStatus(false)
+  $this->setHideConfigurableAreasWhenReorderingDisabled();
+}
+```
+
+
 ## Example View
 
 Example dropdown for the toolbar:

src/Traits/ComponentUtilities.php

@@ -35,6 +35,7 @@ trait ComponentUtilities
     protected $collapsingColumnsStatus = true;
     protected string $emptyMessage = 'No items found. Try to broaden your search.';
     protected array $additionalSelects = [];
+    protected bool $hideConfigurableAreasWhenReorderingStatus = true;
     protected array $configurableAreas = [
         'toolbar-left-start' => null,
         'toolbar-left-end' => null,

src/Traits/Configuration/ComponentConfiguration.php

@@ -323,4 +323,36 @@ public function setConfigurableAreas(array $areas): self
 
         return $this;
     }
+
+    /**
+     * @param  bool  $status
+     *
+     * @return $this
+     */
+    public function setHideConfigurableAreasWhenReorderingStatus(bool $status): self
+    {
+        $this->hideConfigurableAreasWhenReorderingStatus = $status;
+
+        return $this;
+    }
+
+    /**
+     * @return $this
+     */
+    public function setHideConfigurableAreasWhenReorderingEnabled(): self
+    {
+        $this->setHideConfigurableAreasWhenReorderingStatus(true);
+
+        return $this;
+    }
+
+    /**
+     * @return $this
+     */
+    public function setHideConfigurableAreasWhenReorderingDisabled(): self
+    {
+        $this->setHideConfigurableAreasWhenReorderingStatus(false);
+
+        return $this;
+    }
 }

src/Traits/Helpers/ComponentHelpers.php

@@ -354,6 +354,10 @@ public function getConfigurableAreas(): array
      */
     public function hasConfigurableAreaFor(string $area): bool
     {
+        if ($this->hideConfigurableAreasWhenReorderingIsEnabled() && $this->reorderIsEnabled() && $this->currentlyReorderingIsEnabled()) {
+            return false;
+        }
+
         return isset($this->configurableAreas[$area]) && $this->getConfigurableAreaFor($area) !== null;
     }
 
@@ -366,4 +370,28 @@ public function getConfigurableAreaFor(string $area): ?string
     {
         return $this->configurableAreas[$area] ?? null;
     }
+
+    /**
+     * @return bool
+     */
+    public function getHideConfigurableAreasWhenReorderingStatus(): bool
+    {
+        return $this->hideConfigurableAreasWhenReorderingStatus;
+    }
+
+    /**
+     * @return bool
+     */
+    public function hideConfigurableAreasWhenReorderingIsEnabled(): bool
+    {
+        return $this->getHideConfigurableAreasWhenReorderingStatus() === true;
+    }
+
+    /**
+     * @return bool
+     */
+    public function hideConfigurableAreasWhenReorderingIsDisabled(): bool
+    {
+        return $this->getHideConfigurableAreasWhenReorderingStatus() === false;
+    }
 }

tests/Traits/Configuration/ComponentConfigurationTest.php

@@ -250,4 +250,26 @@ public function can_set_tr_url_target(): void
 
         $this->assertSame($this->basicTable->getTableRowUrlTarget(1), '_blank');
     }
+
+    /** @test */
+    public function can_set_hide_configurable_areas_when_reordering_status(): void
+    {
+        $this->assertTrue($this->basicTable->getHideConfigurableAreasWhenReorderingStatus());
+
+        $this->basicTable->setHideConfigurableAreasWhenReorderingStatus(false);
+
+        $this->assertFalse($this->basicTable->getHideConfigurableAreasWhenReorderingStatus());
+
+        $this->basicTable->setHideConfigurableAreasWhenReorderingStatus(true);
+
+        $this->assertTrue($this->basicTable->getHideConfigurableAreasWhenReorderingStatus());
+
+        $this->basicTable->setHideConfigurableAreasWhenReorderingDisabled();
+
+        $this->assertFalse($this->basicTable->getHideConfigurableAreasWhenReorderingStatus());
+
+        $this->basicTable->setHideConfigurableAreasWhenReorderingEnabled();
+
+        $this->basicTable->setHideConfigurableAreasWhenReorderingStatus(true);
+    }
 }

tests/Traits/Helpers/ComponentHelpersTest.php

@@ -110,7 +110,7 @@ public function can_check_if_table_has_page_name(): void
     /** @test */
     public function can_get_eager_load_relations_status(): void
     {
-        $this->assertFalse($this->basicTable->getEagerLoadAllRelationsStatus());
+        $this->assertFalse($this->basicTable->getHideReorderColumnUnlessReorderingStatus());
 
         $this->assertFalse($this->basicTable->eagerLoadAllRelationsIsEnabled());
 
@@ -183,4 +183,24 @@ public function can_get_configurable_areas(): void
 
         $this->assertEquals('includes.areas.toolbar-left-start', $this->basicTable->getConfigurableAreaFor('toolbar-left-start'));
     }
+
+    /** @test */
+    public function can_get_hide_configurable_areas_when_reordering_status(): void
+    {
+        $this->assertTrue($this->basicTable->getHideConfigurableAreasWhenReorderingStatus());
+
+        $this->assertTrue($this->basicTable->hideConfigurableAreasWhenReorderingIsEnabled());
+
+        $this->basicTable->setHideConfigurableAreasWhenReorderingDisabled();
+
+        $this->assertTrue($this->basicTable->hideConfigurableAreasWhenReorderingIsDisabled());
+
+        $this->assertFalse($this->basicTable->hideConfigurableAreasWhenReorderingIsEnabled());
+
+        $this->basicTable->setHideConfigurableAreasWhenReorderingEnabled();
+
+        $this->assertTrue($this->basicTable->hideConfigurableAreasWhenReorderingIsEnabled());
+
+        $this->assertFalse($this->basicTable->hideConfigurableAreasWhenReorderingIsDisabled());
+    }
 }