Merge pull request #79 from leantony/2.0

Add support for using custom title for filters

Author: leantony

src/Filters/GenericFilter.php

@@ -158,9 +158,13 @@ public function render()
             case 'text':
                 // all filters apart from dropdowns are rendered as text elements.
                 // css classes or js libraries can be used to change this
-                return view('leantony::grid.filters.text', $this->compactData(func_get_args()))->render();
+                return view('leantony::grid.filters.text', $this->compactData(
+                    array_collapse(func_get_args())
+                ))->render();
             case 'select':
-                return view('leantony::grid.filters.dropdown', $this->compactData(func_get_args()))->render();
+                return view('leantony::grid.filters.dropdown', $this->compactData(
+                    array_collapse(func_get_args())
+                ))->render();
             default:
                 throw new \Exception("Unknown filter type.");
         }

src/Listeners/AddExtraAttributesToProcessedColumn.php

@@ -34,6 +34,8 @@ public function handle(ColumnProcessed $event)
 
         $this->addHtmlCheckForLabel($data, $col);
 
+        $this->addTitleForFilter($data, $col);
+
         // make sure the column object is returned
         return $col;
     }
@@ -54,4 +56,22 @@ public function addHtmlCheckForLabel($columnData, $col): void
 
         $col->useRawHtmlForLabel = $useRawHtmlForLabel;
     }
+
+    /**
+     * Add title for filter. This will not be used if not set
+     * So, the default one set on the filter will be used if this one is unavailable
+     *
+     * @param $columnData
+     * @param $col
+     */
+    public function addTitleForFilter($columnData, $col): void
+    {
+        if (isset($columnData['filter'])) {
+            $filterTitle = $columnData['filter']['title'] ?? null;
+        } else {
+            $filterTitle = null;
+        }
+
+        $col->filterTitle = $filterTitle;
+    }
 }

src/resources/views/grid/filter.blade.php

@@ -1,11 +1,11 @@
-@foreach($columns as $row)
-    @if(!$row->filter)
+@foreach($columns as $col)
+    @if(!$col->filter)
         <th></th>
-    @elseif(!$row->filter->enabled)
+    @elseif(!$col->filter->enabled)
         <th></th>
     @else
         <th>
-            {!! $row->filter !!}
+            {!! $col->filter->render(['titleSetOnColumn' => $col->filterTitle]) !!}
         </th>
     @endif
     @if($loop->last)

src/resources/views/grid/filters/text.blade.php

@@ -1,6 +1,6 @@
 <input type="text" name="{{ $name }}" id="{{ $id }}"
        form="{{ $formId }}"
-       class="{{ $class }}" value="{{ request($name) }}" title="{{ $title }}" placeholder="{{ $title }}"
+       class="{{ $class }}" value="{{ request($name) }}" title="{{ $titleSetOnColumn ?? $title }}" placeholder="{{ $titleSetOnColumn ?? $title }}"
        @foreach($dataAttributes as $k => $v)
        data-{{ $k }}={{ $v }}
         @endforeach

tests/PackageTest.php

@@ -235,4 +235,22 @@ public function grid_can_render_using_custom_layout()
         // default layout uses a bootstrap4 card
         $this->assertContains("dummy", $content);
     }
+
+    /**
+     * @throws \Throwable
+     * @test
+     */
+    public function grid_can_add_custom_filter_titles()
+    {
+        $filterText = "filter-by-foo-bar";
+        $existingFilterTextSampleNotExisting = "filter by name";
+        $existingFilterTextSampleExisting = "filter by created_at";
+        $grid = $this->getGridInstances()['users_customized'];
+        /** @var $grid UsersGrid */
+        $content = $grid->render();
+
+        $this->assertContains($filterText, $content);
+        $this->assertContains($existingFilterTextSampleExisting, $content);
+        $this->assertNotContains($existingFilterTextSampleNotExisting, $content);
+    }
 }

tests/Setup/Grids/UsersGridCustomized.php

@@ -46,6 +46,7 @@ public function setColumns()
 		    "id" => [
 		        "label" => "ID",
 		        "filter" => [
+		            "title" => "filter-by-foo-bar",
 		            "enabled" => true,
 		            "operator" => "="
 		        ],