Ability to set per component settings from the mount method

Author: rappasoft

CHANGELOG.md

@@ -14,6 +14,7 @@ All notable changes to `laravel-livewire-tables` will be documented in this file
 - Render method to columns which returns whatever you put into it, you can return a view, html, an attribute, etc.
 - Pulled in and modified the HTML component library from laravelcollective so you an return html components from the render method. i.e.: $this->image(...);
 - Added new loading config on whether to keep displaying the current data while loading or collapse it
+- Added ability to set frontend framework specific options via the mount method on a per component basis.
 
 ### Changed
 

README.md

@@ -284,6 +284,32 @@ public function email($email): string
 public function html($html): HtmlString
 ```
 
+### Setting Options
+
+There are some frontend framework specific options that can be set.
+
+These have to be set from the `mount()` method of your component.
+
+They are done this way instead of the config file that way you can have per-component control over these settings.
+
+```php
+public function mount()
+{
+    $this->setOptions([
+        // The class set on the table when using bootstrap
+        'bootstrap.classes.table' => 'table table-striped table-bordered',
+        
+        // Whether or not the table is wrapped in a `.container-fluid` or not
+        'bootstrap.container' => true,
+    
+        // Whether or not the table is wrapped in a `.table-responsive` or not
+        'bootstrap.responsive' => true,
+    ]);
+}
+```
+
+For this to work you have to pass an associative array of overrides to the `setOptions()` method. The above are the defaults, if you're not changing them then you can leave them out.
+
 ### Passing Properties
 
 To pass properties from your blade view to your table, you can use the normal Livewire mount method:

resources/views/bootstrap-4/table-component.blade.php

@@ -1,9 +1,14 @@
-<div class="container-fluid" @if (is_numeric($refresh)) wire:poll.{{ $refresh }}.ms @elseif(is_string($refresh)) wire:poll="{{ $refresh }}" @endif>
+<div
+    class="{{ $this->getOption('bootstrap.container') ? 'container-fluid' : '' }}"
+    @if (is_numeric($refresh)) wire:poll.{{ $refresh }}.ms @elseif(is_string($refresh)) wire:poll="{{ $refresh }}" @endif
+>
     @include('laravel-livewire-tables::'.config('laravel-livewire-tables.theme').'.includes.offline')
     @include('laravel-livewire-tables::'.config('laravel-livewire-tables.theme').'.includes.options')
 
-    <div class="table-responsive">
-        <table class="table table-bordered table-striped">
+    @if ($this->getOption('bootstrap.responsive'))
+        <div class="table-responsive">
+    @endif
+        <table class="{{ $this->getOption('bootstrap.classes.table') }}">
             @include('laravel-livewire-tables::'.config('laravel-livewire-tables.theme').'.includes.thead')
 
             @include('laravel-livewire-tables::'.config('laravel-livewire-tables.theme').'.includes.loading')
@@ -16,7 +21,9 @@
 
             @include('laravel-livewire-tables::'.config('laravel-livewire-tables.theme').'.includes.tfoot')
         </table>
-    </div><!--table-responsive-->
+    @if ($this->getOption('bootstrap.responsive'))
+        </div><!--table-responsive-->
+    @endif
 
     @include('laravel-livewire-tables::'.config('laravel-livewire-tables.theme').'.includes.pagination')
 </div>

src/TableComponent.php

@@ -8,6 +8,7 @@
 use Livewire\Component;
 use Livewire\WithPagination;
 use Rappasoft\LaravelLivewireTables\Traits\Loading;
+use Rappasoft\LaravelLivewireTables\Traits\Options;
 use Rappasoft\LaravelLivewireTables\Traits\Pagination;
 use Rappasoft\LaravelLivewireTables\Traits\Search;
 use Rappasoft\LaravelLivewireTables\Traits\Sorting;
@@ -20,6 +21,7 @@
 abstract class TableComponent extends Component
 {
     use Loading,
+        Options,
         Pagination,
         Search,
         Sorting,
@@ -62,6 +64,8 @@ public function __construct($id = null)
             $this->paginationTheme = 'bootstrap';
         }
 
+        $this->setOptions();
+
         parent::__construct($id);
     }
 

src/Traits/Options.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Traits;
+
+use Illuminate\Support\Arr;
+
+/**
+ * Trait Options.
+ */
+trait Options
+{
+    /**
+     * @var array
+     */
+    protected $options = [
+        'bootstrap' => [
+            'classes' => [
+                'table' => 'table table-bordered table-striped',
+            ],
+            'container' => true,
+            'responsive' => true,
+        ],
+    ];
+
+    /**
+     * @param $option
+     *
+     * @return mixed
+     */
+    public function getOption($option)
+    {
+        return Arr::dot($this->options)[$option] ?? null;
+    }
+
+    /**
+     * @param  array  $overrides
+     */
+    protected function setOptions(array $overrides = []): void
+    {
+        foreach ($overrides as $key => $value) {
+            data_set($this->options, $key, $value);
+        }
+    }
+}