improve gridview table attrs

yiisoft · Nov 22, 2023 · ff74cc7 · ff74cc7
1 parent dae6583
commit ff74cc7
Show file tree

Hide file tree

Showing 12 changed files with 138 additions and 101 deletions.
diff --git a/composer.json b/composer.json
@@ -63,7 +63,8 @@
         },
         "config-plugin": {
             "params": "params.php",
-            "di": "di.php"
+            "di": "di.php",
+            "widgets-themes": "widgets-themes.php"
         }
     },
     "autoload": {

diff --git a/config/widgets-themes.php b/config/widgets-themes.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+use Yiisoft\Yii\DataView\GridView;
+
+return [
+    'bootstrap5' => [
+        GridView::class => [
+            'tableClass' => ['table'],
+        ],
+    ],
+];
diff --git a/src/GridView.php b/src/GridView.php
@@ -51,7 +51,7 @@ final class GridView extends BaseListView
     private bool $headerTableEnabled = true;
     private array $headerRowAttributes = [];
     private array $rowAttributes = [];
-    private array $tableAttributes = ['class' => 'table'];
+    private array $tableAttributes = [];
 
     public function __construct(
         private CurrentRoute $currentRoute,
@@ -257,15 +257,38 @@ public function rowAttributes(array $values): self
     }
 
     /**
-     * Return new instance with the HTML attributes for the table.
+     * Return new instance with the HTML attributes for the table tag.
      *
-     * @param array $values Attribute values indexed by attribute names.
+     * @param array $attributes The tag attributes in terms of name-value pairs.
+     */
+    public function tableAttributes(array $attributes): self
+    {
+        $new = clone $this;
+        $new->tableAttributes = $attributes;
+        return $new;
+    }
+
+    /**
+     * Add one or more CSS classes to the table tag.
+     *
+     * @param string|null ...$class One or many CSS classes.
      */
-    public function tableAttributes(array $values): self
+    public function addTableClass(?string ...$class): self
     {
         $new = clone $this;
-        $new->tableAttributes = $values;
+        Html::addCssClass($new->tableAttributes, $class);
+        return $new;
+    }
 
+    /**
+     * Replace current table tag CSS classes with a new set of classes.
+     *
+     * @param string|null ...$class One or many CSS classes.
+     */
+    public function tableClass(?string ...$class): static
+    {
+        $new = clone $this;
+        $new->tableAttributes['class'] = array_filter($class, static fn ($c) => $c !== null);
         return $new;
     }
 

diff --git a/tests/Column/ActionColumnTest.php b/tests/Column/ActionColumnTest.php
@@ -36,7 +36,7 @@ public function testContent(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>Actions</th>
@@ -84,7 +84,7 @@ public function testContentAttributes(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>Actions</th>
@@ -133,7 +133,7 @@ public function testCustomButton(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>Actions</th>
@@ -188,7 +188,7 @@ public function testDataLabel(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>Actions</th>
@@ -233,7 +233,7 @@ public function testFooterAttributes(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>Actions</th>
@@ -286,7 +286,7 @@ public function testLabel(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>test.label</th>
@@ -331,7 +331,7 @@ public function testLabelWithMbString(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>Ενέργειες</th>
@@ -376,7 +376,7 @@ public function testLabelAttributes(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th class="test.class">test.label</th>
@@ -421,7 +421,7 @@ public function testName(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>Actions</th>
@@ -466,7 +466,7 @@ public function testNotVisible(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr></tr>
             </thead>
@@ -497,7 +497,7 @@ public function testPrimaryKey(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>Actions</th>
@@ -550,7 +550,7 @@ public function testRender(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>Id</th>
@@ -605,7 +605,7 @@ public function testUrlArguments(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>Actions</th>
@@ -650,7 +650,7 @@ public function testUrlCreator(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>Actions</th>
@@ -701,7 +701,7 @@ public function testUrlQueryParameters(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>Actions</th>
@@ -746,7 +746,7 @@ public function testUrlParamsConfig(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>Actions</th>
@@ -791,7 +791,7 @@ public function testVisibleButtonsClosure(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>Actions</th>

diff --git a/tests/Column/CheckboxColumnTest.php b/tests/Column/CheckboxColumnTest.php
@@ -35,7 +35,7 @@ public function testContent(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>Id</th>
@@ -84,7 +84,7 @@ public function testContentAttributes(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>Id</th>
@@ -135,7 +135,7 @@ public function testDataLabel(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>Id</th>
@@ -182,7 +182,7 @@ public function testLabel(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>Id</th>
@@ -229,7 +229,7 @@ public function testLabelMbString(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>Id</th>
@@ -276,7 +276,7 @@ public function testLabelAttributes(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>Id</th>
@@ -323,7 +323,7 @@ public function testName(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>Id</th>
@@ -370,7 +370,7 @@ public function testNotMultiple(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>Id</th>
@@ -417,7 +417,7 @@ public function testNotVisible(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>Id</th>
@@ -461,7 +461,7 @@ public function testRender(): void
         Assert::equalsWithoutLE(
             <<<HTML
             <div id="w1-grid">
-            <table class="table">
+            <table>
             <thead>
             <tr>
             <th>Id</th>