Merge pull request rappasoft#487 from rappasoft/develop

rappasoft · web-flow · commit d3efe711d1b6 · 2021-10-12T21:25:40.000-04:00
v1.17.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,17 @@ All notable changes to `laravel-livewire-tables` will be documented in this file
 
 ## [Unreleased]
 
+## [1.17.0] - 2021-10-12
+
+### Added
+
+- Multiselect filter - https://github.com/rappasoft/laravel-livewire-tables/pull/469
+
+### Changed
+
+- Fixed default version of livewire - https://github.com/rappasoft/laravel-livewire-tables/issues/486
+- Fix bulk select with search and add typed property to selected - https://github.com/rappasoft/laravel-livewire-tables/pull/439
+
 ## [1.16.0] - 2021-09-26
 
 ### Added
@@ -484,7 +495,8 @@ All notable changes to `laravel-livewire-tables` will be documented in this file
 
 - Initial release
 
-[Unreleased]: https://github.com/rappasoft/laravel-livewire-tables/compare/v1.16.0...development
+[Unreleased]: https://github.com/rappasoft/laravel-livewire-tables/compare/v1.17.0...development
+[1.17.0]: https://github.com/rappasoft/laravel-livewire-tables/compare/v1.16.0...v1.17.0
 [1.16.0]: https://github.com/rappasoft/laravel-livewire-tables/compare/v1.15.0...v1.16.0
 [1.15.0]: https://github.com/rappasoft/laravel-livewire-tables/compare/v1.14.0...v1.15.0
 [1.14.0]: https://github.com/rappasoft/laravel-livewire-tables/compare/v1.13.0...v1.14.0
diff --git a/composer.json b/composer.json
@@ -19,7 +19,7 @@
     ],
     "require": {
         "php": "^7.4|^8.0",
-        "livewire/livewire": "^2.6.5",
+        "livewire/livewire": "^2.0",
         "spatie/laravel-package-tools": "^1.4.3",
         "illuminate/contracts": "^8.0"
     },
diff --git a/resources/views/bootstrap-4/includes/filter-pills.blade.php b/resources/views/bootstrap-4/includes/filter-pills.blade.php
@@ -4,14 +4,22 @@
             <small>@lang('Applied Filters'):</small>
 
             @foreach($filters as $key => $value)
-                @if ($key !== 'search' && strlen($value))
+                @if ($key !== 'search' && filled($value))
                     <span
                         wire:key="filter-pill-{{ $key }}"
                         class="badge badge-pill badge-info d-inline-flex align-items-center"
                     >
                         {{ $filterNames[$key] ?? collect($this->columns())->pluck('text', 'column')->get($key, ucwords(strtr($key, ['_' => ' ', '-' => ' ']))) }}:
                         @if(isset($customFilters[$key]) && method_exists($customFilters[$key], 'options'))
-                            {{ $customFilters[$key]->options()[$value] ?? $value }}
+                            @if(is_array($value))
+                                @foreach($value as $selectedValue)
+                                    {{ $customFilters[$key]->options()[$selectedValue] ?? $selectedValue }}@if(!$loop->last), @endif
+                                @endforeach
+                            @else
+                                {{ $customFilters[$key]->options()[$value] ?? $value }}
+                            @endif
+                        @elseif(is_array($value))
+                            {{ implode(', ', $value) }}
                         @else
                             {{ ucwords(strtr($value, ['_' => ' ', '-' => ' '])) }}
                         @endif
diff --git a/resources/views/bootstrap-4/includes/filter-type-multiselect.blade.php b/resources/views/bootstrap-4/includes/filter-type-multiselect.blade.php
@@ -0,0 +1,13 @@
+@foreach($filter->options() as $optionKey => $value)
+    <div class="form-check" wire:key="filter-{{ $key }}-multiselect-{{ $optionKey }}">
+        <input
+            class="form-check-input"
+            onclick="event.stopPropagation();"
+            type="checkbox"
+            id="filter-{{$key}}-{{ $loop->index }}"
+            wire:model="filters.{{$key}}"
+            value="{{ $optionKey }}"
+        >
+        <label class="form-check-label" for="filter-{{$key}}-{{ $loop->index }}">{{ $value }}</label>
+    </div>
+@endforeach
diff --git a/resources/views/bootstrap-4/includes/filters.blade.php b/resources/views/bootstrap-4/includes/filters.blade.php
@@ -38,6 +38,8 @@ class="dropdown-menu w-100 mt-md-3"
 
                             @if ($filter->isSelect())
                                 @include('livewire-tables::bootstrap-4.includes.filter-type-select')
+                            @elseif($filter->isMultiSelect())
+                                @include('livewire-tables::bootstrap-4.includes.filter-type-multiselect')
                             @elseif($filter->isDate())
                                 @include('livewire-tables::bootstrap-4.includes.filter-type-date')
                             @endif
diff --git a/resources/views/bootstrap-5/includes/filter-pills.blade.php b/resources/views/bootstrap-5/includes/filter-pills.blade.php
@@ -4,14 +4,22 @@
             <small>@lang('Applied Filters'):</small>
 
             @foreach($filters as $key => $value)
-                @if ($key !== 'search' && strlen($value))
+                @if ($key !== 'search' && filled($value))
                     <span
                         wire:key="filter-pill-{{ $key }}"
                         class="badge rounded-pill bg-info d-inline-flex align-items-center"
                     >
                         {{ $filterNames[$key] ?? collect($this->columns())->pluck('text', 'column')->get($key, ucwords(strtr($key, ['_' => ' ', '-' => ' ']))) }}:
                         @if(isset($customFilters[$key]) && method_exists($customFilters[$key], 'options'))
-                            {{ $customFilters[$key]->options()[$value] ?? $value }}
+                            @if(is_array($value))
+                                @foreach($value as $selectedValue)
+                                    {{ $customFilters[$key]->options()[$selectedValue] ?? $selectedValue }}@if(!$loop->last), @endif
+                                @endforeach
+                            @else
+                                {{ $customFilters[$key]->options()[$value] ?? $value }}
+                            @endif
+                        @elseif(is_array($value))
+                            {{ implode(', ', $value) }}
                         @else
                             {{ ucwords(strtr($value, ['_' => ' ', '-' => ' '])) }}
                         @endif
diff --git a/resources/views/bootstrap-5/includes/filter-type-multiselect.blade.php b/resources/views/bootstrap-5/includes/filter-type-multiselect.blade.php
@@ -0,0 +1,12 @@
+@foreach($filter->options() as $optionKey => $value)
+    <div class="form-check" wire:key="filter-{{ $key }}-multiselect-{{ $optionKey }}">
+        <input
+            onclick="event.stopPropagation();"
+            type="checkbox"
+            id="filter-{{$key}}-{{ $loop->index }}"
+            wire:model="filters.{{$key}}"
+            value="{{ $optionKey }}"
+        >
+        <label class="form-check-label" for="filter-{{$key}}-{{ $loop->index }}">{{ $value }}</label>
+    </div>
+@endforeach
diff --git a/resources/views/bootstrap-5/includes/filters.blade.php b/resources/views/bootstrap-5/includes/filters.blade.php
@@ -38,6 +38,8 @@ class="dropdown-menu w-100"
 
                             @if ($filter->isSelect())
                                 @include('livewire-tables::bootstrap-5.includes.filter-type-select')
+                            @elseif($filter->isMultiSelect())
+                                @include('livewire-tables::bootstrap-5.includes.filter-type-multiselect')
                             @elseif($filter->isDate())
                                 @include('livewire-tables::bootstrap-5.includes.filter-type-date')
                             @endif
diff --git a/resources/views/tailwind/includes/filter-pills.blade.php b/resources/views/tailwind/includes/filter-pills.blade.php
@@ -4,14 +4,22 @@
             <small class="text-gray-700 dark:text-white">@lang('Applied Filters'):</small>
 
             @foreach($filters as $key => $value)
-                @if ($key !== 'search' && strlen($value))
+                @if ($key !== 'search' && filled($value))
                     <span
                         wire:key="filter-pill-{{ $key }}"
                         class="inline-flex items-center px-2.5 py-0.5 rounded-full text-xs font-medium leading-4 bg-indigo-100 text-indigo-800 capitalize dark:bg-indigo-200 dark:text-indigo-900"
                     >
                         {{ $filterNames[$key] ?? collect($this->columns())->pluck('text', 'column')->get($key, ucwords(strtr($key, ['_' => ' ', '-' => ' ']))) }}:
                         @if(isset($customFilters[$key]) && method_exists($customFilters[$key], 'options'))
-                            {{ $customFilters[$key]->options()[$value] ?? $value }}
+                            @if(is_array($value))
+                                @foreach($value as $selectedValue)
+                                    {{ $customFilters[$key]->options()[$selectedValue] ?? $selectedValue }}@if(!$loop->last), @endif
+                                @endforeach
+                            @else
+                                {{ $customFilters[$key]->options()[$value] ?? $value }}
+                            @endif
+                        @elseif(is_array($value))
+                            {{ implode(', ', $value) }}
                         @else
                             {{ ucwords(strtr($value, ['_' => ' ', '-' => ' '])) }}
                         @endif
diff --git a/resources/views/tailwind/includes/filter-type-multiselect.blade.php b/resources/views/tailwind/includes/filter-type-multiselect.blade.php
@@ -0,0 +1,14 @@
+<div class="mt-1 relative rounded-md">
+    @foreach($filter->options() as $optionKey => $value)
+        <div wire:key="filter-{{ $key }}-multiselect-{{ $optionKey }}">
+            <input
+                type="checkbox"
+                id="filter-{{$key}}-{{ $loop->index }}"
+                wire:key="filter-{{$key}}-{{ $loop->index }}"
+                wire:model="filters.{{$key}}"
+                value="{{ $optionKey }}"
+            >
+            <label for="filter-{{$key}}-{{ $loop->index }}">{{ $value }}</label>
+        </div>
+    @endforeach
+</div>
diff --git a/resources/views/tailwind/includes/filters.blade.php b/resources/views/tailwind/includes/filters.blade.php
@@ -58,6 +58,8 @@ class="block text-sm font-medium leading-5 text-gray-700 dark:text-white">
 
                             @if ($filter->isSelect())
                                 @include('livewire-tables::tailwind.includes.filter-type-select')
+                            @elseif($filter->isMultiSelect())
+                                @include('livewire-tables::tailwind.includes.filter-type-multiselect')
                             @elseif($filter->isDate())
                                 @include('livewire-tables::tailwind.includes.filter-type-date')
                             @endif
diff --git a/src/Traits/WithBulkActions.php b/src/Traits/WithBulkActions.php
@@ -14,8 +14,8 @@ trait WithBulkActions
     public string $primaryKey = 'id';
     public bool $selectPage = false;
     public bool $selectAll = false;
-    public $selected = [];
-
+    public array $selected = [];
+    public array $bulkActions = [];
     public bool $hideBulkActionsOnEmpty = false;
 
     public function renderingWithBulkActions(): void
@@ -49,7 +49,7 @@ public function updatedSelectPage($value): void
 
     public function selectPageRows(): void
     {
-        $this->selected = $this->rows->pluck($this->primaryKey)->map(fn ($key) => (string) $key);
+        $this->selected = $this->rows->pluck($this->primaryKey)->map(fn ($key) => (string) $key)->toArray();
     }
 
     public function selectAll(): void
@@ -69,8 +69,10 @@ public function resetBulk(): void
      */
     public function selectedRowsQuery()
     {
-        return (clone $this->rowsQuery())
-            ->unless($this->selectAll, fn ($query) => $query->whereIn($query->qualifyColumn($this->primaryKey), $this->selected));
+        return $this->query()->unless(
+            $this->selectAll,
+            fn ($query) => $query->whereIn($query->qualifyColumn($this->primaryKey), $this->selected)
+        );
     }
 
     /**
@@ -83,7 +85,7 @@ public function getSelectedRowsQueryProperty()
 
     public function selectedKeys(): array
     {
-        return $this->selectedRowsQuery()->pluck($this->rowsQuery()->qualifyColumn($this->primaryKey))->toArray();
+        return $this->selectedRowsQuery()->pluck($this->query()->qualifyColumn($this->primaryKey))->toArray();
     }
 
     public function getSelectedKeysProperty(): array
diff --git a/src/Traits/WithFilters.php b/src/Traits/WithFilters.php
@@ -80,6 +80,8 @@ public function resetFilters(): void
         $this->reset('filters');
 
         $this->filters['search'] = $search;
+
+        $this->checkFilters();
     }
 
     /**
@@ -114,10 +116,19 @@ public function filters(): array
      */
     public function checkFilters(): void
     {
-        foreach ($this->filters() as $filter => $_default) {
-            if (! isset($this->filters[$filter]) || $this->filters[$filter] === '') {
-                $this->filters[$filter] = null;
+        foreach ($this->filters() as $key => $filter) {
+            if (isset($this->filters[$key]) && filled($this->filters[$key])) {
+                continue;
             }
+
+            // If the filter is multiselect, we'll initialize it as an array.
+            if ($filter->isMultiSelect()) {
+                $this->filters[$key] = [];
+
+                continue;
+            }
+
+            $this->filters[$key] = null;
         }
     }
 
@@ -161,6 +172,17 @@ public function cleanFilters(): void
                 }
             }
 
+            // Handle 'multiselect' filters
+            if ($filterDefinitions[$filterName]->isMultiSelect() && is_array($filterValue)) {
+                foreach ($filterValue as $selectedValue) {
+                    if (! in_array($selectedValue, $this->getFilterOptions($filterName))) {
+                        return false;
+                    }
+                }
+
+                return true;
+            }
+
             if ($filterDefinitions[$filterName]->isDate()) {
                 // array_sum trick is a terse way of ensuring that PHP
                 // did not do "month shifting"
@@ -210,7 +232,11 @@ public function getFilter(string $filter)
                 return $this->hasIntegerKeys($filter) ? (int)$this->filters[$filter] : trim($this->filters[$filter]);
             }
 
-            return trim($this->filters[$filter]);
+            if (is_string($this->filters[$filter])) {
+                return trim($this->filters[$filter]);
+            }
+
+            return $this->filters[$filter];
         }
 
         return null;
@@ -222,7 +248,7 @@ public function getFilter(string $filter)
     public function getFilters(): array
     {
         return collect($this->filters)
-            ->reject(fn ($value) => $value === null || $value === '')
+            ->reject(fn ($value) => blank($value))
             ->toArray();
     }
 
diff --git a/src/Views/Filter.php b/src/Views/Filter.php
@@ -11,6 +11,8 @@ class Filter
 
     public const TYPE_SELECT = 'select';
 
+    public const TYPE_MULTISELECT = 'multiselect';
+
     /**
      * @var string
      */
@@ -60,6 +62,20 @@ public function select(array $options = []): Filter
         return $this;
     }
 
+    /**
+     * @param array $options
+     *
+     * @return $this
+     */
+    public function multiSelect(array $options = []): Filter
+    {
+        $this->type = self::TYPE_MULTISELECT;
+
+        $this->options = $options;
+
+        return $this;
+    }
+
     /**
      * @param array $options
      *
@@ -98,6 +114,14 @@ public function isSelect(): bool
         return $this->type === self::TYPE_SELECT;
     }
 
+    /**
+     * @return bool
+     */
+    public function isMultiSelect(): bool
+    {
+        return $this->type === self::TYPE_MULTISELECT;
+    }
+
     /**
      * @return bool
      */
