Add filter cell attributes

yiisoft · Feb 20, 2024 · 1c80830 · 1c80830
1 parent 6254003
commit 1c80830
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/config/widgets-themes.php b/config/widgets-themes.php
@@ -19,6 +19,7 @@
             'sortableHeaderPrepend()' => ['<div class="float-end text-secondary text-opacity-50">⭥</div>'],
             'sortableHeaderAscPrepend()' => ['<div class="float-end fw-bold">⭡</div>'],
             'sortableHeaderDescPrepend()' => ['<div class="float-end fw-bold">⭣</div>'],
+            'filterCellAttributes()' => [['class' => 'align-top']],
             'addColumnRendererConfigs()' => [
                 [
                     ActionColumnRenderer::class => [

diff --git a/src/GridView.php b/src/GridView.php
@@ -77,6 +77,8 @@ final class GridView extends BaseListView
     private ?string $sortableLinkAscClass = null;
     private ?string $sortableLinkDescClass = null;
 
+    private array $filterCellAttributes = [];
+
     private RendererContainer $columnRendererContainer;
 
     /**
@@ -102,6 +104,18 @@ public function addColumnRendererConfigs(array $configs): self
         return $new;
     }
 
+    /**
+     * Return new instance with the HTML attributes for the filter cell (`td`) tag.
+     *
+     * @param array $attributes The tag attributes in terms of name-value pairs.
+     */
+    public function filterCellAttributes(array $attributes): self
+    {
+        $new = clone $this;
+        $new->filterCellAttributes = $attributes;
+        return $new;
+    }
+
     public function enableMultiSort(bool $value = true): self
     {
         $new = clone $this;
@@ -446,7 +460,7 @@ protected function renderItems(array $items, ValidationResult $filterValidationR
         );
         foreach ($columns as $i => $column) {
             $cell = $renderers[$i] instanceof FilterableColumnRendererInterface
-                ? $renderers[$i]->renderFilter($column, new Cell(), $filterContext)
+                ? $renderers[$i]->renderFilter($column, new Cell(attributes: $this->filterCellAttributes), $filterContext)
                 : null;
             if ($cell === null) {
                 $tags[] = Html::td('&nbsp;')->encode(false);