introduce ability to make i18nable custom column category labels (MedicOneSystems#297)

* introduce ability to make i18nable custom column category labels

* column group labelling improvements

* remove some unnecessary code

Co-authored-by: Herbert Maschke <thyseus@pm.me>
Co-authored-by: Mark Salmon <mark.salmon@mediconesystems.com>

Author: 3 people

README.md

@@ -216,6 +216,27 @@ NumberColumn::name('students.age:max')->label('Student Max'),
 ### Column Groups
 
 When you have a very big table with a lot of columns, it is possible to create 'column groups' that allows the user to toggle the visibility of a whole group at once. Use `->group('NAME')` at any column to achieve this.
+You can human readable labels and translations of your groups via the `groupLabels` property of your table:
+
+```php
+class GroupDemoTable extends LivewireDatatable
+{
+    public $groupLabels = [
+         'group1' => 'app.translation_for_group_1'
+         'group2' => 'app.translation_for_group_2'
+    ];
+
+public function columns()
+{
+    return [
+        Column::name('planets.name')
+            ->group('group1')
+            ->label('Planet'),
+
+        Column::name('planets.name')
+            ->group('group2')
+            ->label('Planet'),
+```
 
 ### Custom column names
 It is still possible to take full control over your table, you can define a ```builder``` method using whatever query you like, using your own joins, groups whatever, and then name your columns using your normal SQL syntax:

resources/views/livewire/datatables/datatable.blade.php

@@ -53,8 +53,10 @@
                 @endif
 
                 @foreach ($columnGroups as $name => $group)
-                    <button wire:click="toggleGroup('{{ $name }}')" class="px-3 py-2 border border-green-400 rounded-md bg-white text-green-500 text-xs leading-4 font-medium uppercase tracking-wider hover:bg-green-200 focus:outline-none"><span class="flex items-center h-5">{{ __('Toggle :group', ['group' => $name]) }}</span>
-                        </button>
+                    <button wire:click="toggleGroup('{{ $name }}')"
+                        class="px-3 py-2 border border-green-400 rounded-md bg-white text-green-500 text-xs leading-4 font-medium uppercase tracking-wider hover:bg-green-200 focus:outline-none">
+                        <span class="flex items-center h-5">{{ isset($this->groupLabels[$name]) ? __($this->groupLabels[$name]) : __('Toggle :group', ['group' => $name]) }}</span>
+                    </button>
                 @endforeach
             </div>
         </div>

src/Column.php

@@ -9,7 +9,6 @@ class Column
 {
     public $type = 'string';
     public $label;
-    public $group;
     public $name;
     public $select;
     public $joins;
@@ -34,6 +33,11 @@ class Column
     public $width;
     public $exportCallback;
 
+    /**
+     * @var string (optional) you can group your columns to let the user toggle the visibility of a group at once.
+     */
+    public $group;
+
     /** @var array list all column types that are not sortable by SQL here */
     public const UNSORTABLE_TYPES = ['label', 'checkbox'];
 
@@ -336,6 +340,8 @@ public function field()
 
     /**
      * You can use group(null) to revoke a column from a group, if necessary.
+     *
+     * @see array LivewireDatatable->groupLabels to assign a human readable and translatable label for the group
      */
     public function group($group)
     {

src/Http/Livewire/LivewireDatatable.php

@@ -67,6 +67,16 @@ class LivewireDatatable extends Component
     public $persistPerPage = true;
     public $persistFilters = true;
 
+    /**
+     * @var array List your groups and the corresponding label (or translation) here.
+     *            The label can be a i18n placeholder like 'app.my_string' and it will be automatically translated via __().
+     *
+     * Group labels are optional. If they are omitted, the 'name' of the group will be displayed to the user.
+     *
+     * @example ['group1' => 'app.toggle_group1', 'group2' => 'app.toggle_group2']
+     */
+    public $groupLabels = [];
+
     protected $query;
     protected $listeners = ['refreshLivewireDatatable', 'complexQuery', 'saveQuery', 'deleteQuery', 'applyToTable', 'resetTable'];
 
@@ -543,7 +553,7 @@ public function initialisePerPage()
     public function initialiseColumnGroups()
     {
         array_map(function ($column) {
-            if ($column['group'] ?? false) {
+            if (isset($column['group'])) {
                 $this->columnGroups[$column['group']][] = $column['name'] ?? $column['label'];
             }
         }, $this->columns);
@@ -673,6 +683,34 @@ public function toggleGroup($group)
         }
     }
 
+    /**
+     * @return bool returns true if all columns of the given group are _completely_ visible.
+     */
+    public function isGroupVisible($group)
+    {
+        foreach ($this->columns as $column) {
+            if ($column['group'] === $group && $column['hidden']) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * @return bool returns true if all columns of the given group are _completely_ hidden.
+     */
+    public function isGroupHidden($group)
+    {
+        foreach ($this->columns as $column) {
+            if ($column['group'] === $group && ! $column['hidden']) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
     public function doBooleanFilter($index, $value)
     {
         $this->activeBooleanFilters[$index] = $value;