Merge branch 'macbookandrew-feature/select-optgroups' into develop

Author: rappasoft

docs/examples/advanced-example.md

@@ -171,6 +171,19 @@ class UsersTable extends DataTableComponent
                         $builder->where('active', false);
                     }
                 }),
+            SelectFilter::make('Address Group')
+                ->options([
+                    '' => 'All',
+                    AddressGroup::query()
+                        ->orderBy('type')
+                        ->get()
+                        ->groupBy('type')
+                        ->map(fn ($addressGroup) => $addressGroup->pluck('type', 'id')->filter())
+                        ->toArray(),
+                ])
+                ->filter(function(Builder $builder, string $value) {
+                    $builder->where('address_groups.type', $value);
+                }),
             DateFilter::make('Verified From')
                 ->config([
                     'min' => '2020-01-01',

docs/filters/creating-filters.md

@@ -38,6 +38,34 @@ public function filters(): array
 
 You should supply the first option as the default value. I.e. nothing selected, so the filter is not applied. This value should be an empty string. When this value is selected, the filter will be removed from the query and the query string.
 
+### Option Groups
+
+To use `<optgroup>` elements, pass a nested array of options to the select filter.
+
+```php
+use Rappasoft\LaravelLivewireTables\Views\Filters\SelectFilter;
+
+public function filters(): array
+{
+    return [
+        SelectFilter::make('Active')
+            ->options([
+                '' => 'All',
+                'Open' => [
+                    1 => 'Type A',
+                    2 => 'Type B',
+                    3 => 'Type C',
+                ],
+                'Closed' => [
+                    24 => 'Type X',
+                    25 => 'Type Y',
+                    26 => 'Type Z',
+                ],
+            ]),
+    ];
+}
+```
+
 ## Multi-select Filters
 
 Multi-select filters are a list of checkboxes. The user can select multiple options from the list. There is also an 'All' option that will select all values.

resources/views/components/tools/filters/select.blade.php

@@ -11,7 +11,15 @@
             class="block w-full border-gray-300 rounded-md shadow-sm transition duration-150 ease-in-out focus:border-indigo-300 focus:ring focus:ring-indigo-200 focus:ring-opacity-50 dark:bg-gray-800 dark:text-white dark:border-gray-600"
         >
             @foreach($filter->getOptions() as $key => $value)
-                <option value="{{ $key }}">{{ $value }}</option>
+                @if (is_iterable($value))
+                    <optgroup label="{{ $key }}">
+                        @foreach ($value as $optionKey => $optionValue)
+                            <option value="{{ $optionKey }}">{{ $optionValue }}</option>
+                        @endforeach
+                    </optgroup>
+                @else
+                    <option value="{{ $key }}">{{ $value }}</option>
+                @endif
             @endforeach
         </select>
     </div>
@@ -23,7 +31,15 @@ class="block w-full border-gray-300 rounded-md shadow-sm transition duration-150
         class="form-control"
     >
         @foreach($filter->getOptions() as $key => $value)
-            <option value="{{ $key }}">{{ $value }}</option>
+            @if (is_iterable($value))
+                <optgroup label="{{ $key }}">
+                    @foreach ($value as $optionKey => $optionValue)
+                        <option value="{{ $optionKey }}">{{ $optionValue }}</option>
+                    @endforeach
+                </optgroup>
+            @else
+                <option value="{{ $key }}">{{ $value }}</option>
+            @endif
         @endforeach
     </select>
 @endif

src/Views/Filters/SelectFilter.php

@@ -24,9 +24,10 @@ public function getOptions(): array
     public function getKeys(): array
     {
         return collect($this->getOptions())
-            ->keys()
+            ->map(fn ($value, $key) => is_iterable($value) ? collect($value)->keys() : $key)
+            ->flatten()
             ->map(fn ($value) => (string)$value)
-            ->filter(fn ($value) => strlen($value))
+            ->filter(fn ($value) => strlen($value) > 0)
             ->values()
             ->toArray();
     }
@@ -42,7 +43,10 @@ public function validate($value)
 
     public function getFilterPillValue($value): ?string
     {
-        return $this->getCustomFilterPillValue($value) ?? $this->getOptions()[$value] ?? null;
+        return $this->getCustomFilterPillValue($value)
+            ?? collect($this->getOptions())
+                ->mapWithKeys(fn ($options, $optgroupLabel) => is_iterable($options) ? $options : [$optgroupLabel => $options])[$value]
+            ?? null;
     }
 
     public function isEmpty($value): bool

tests/Views/Traits/Helpers/FilterHelpersTest.php

@@ -58,6 +58,22 @@ public function can_get_filter_keys(): void
         $this->assertSame(['foo'], $filter->getKeys());
     }
 
+    /** @test */
+    public function can_get_nested_filter_keys(): void
+    {
+        $filter = SelectFilter::make('Active');
+
+        $this->assertSame([], $filter->getKeys());
+
+        $filter->options(['foo' => ['bar' => 'baz']]);
+
+        $this->assertSame(['bar'], $filter->getKeys());
+
+        $filter->options(['foo' => collect(['bar' => 'baz'])]);
+
+        $this->assertSame(['bar'], $filter->getKeys());
+    }
+
     /** @test */
     public function can_get_filter_default_value(): void
     {
@@ -114,6 +130,21 @@ public function can_get_filter_pill_value(): void
         $this->assertSame('baz', $filter->getFilterPillValue('foo'));
     }
 
+    /** @test */
+    public function can_get_nested_filter_pill_value(): void
+    {
+        $filter = SelectFilter::make('Active')
+            ->options(['foo' => ['bar' => 'baz']]);
+
+        $this->assertSame('baz', $filter->getFilterPillValue('bar'));
+
+        $filter = SelectFilter::make('Active')
+            ->options(['foo' => ['bar' => 'baz']])
+            ->setFilterPillValues(['bar' => 'etc']);
+
+        $this->assertSame('etc', $filter->getFilterPillValue('bar'));
+    }
+
     /** @test */
     public function can_check_if_filter_has_configs(): void
     {