Merge pull request #242 from rappasoft/develop

rappasoft · web-flow · commit fd98bfc9e7f7 · 2021-04-29T00:01:08.000-04:00
v1.4.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,22 @@ All notable changes to `laravel-livewire-tables` will be documented in this file
 
 ## [Unreleased]
 
+## [1.4.0] - 2021-04-29
+
+### Added
+
+- Added option for single column sorting only.
+- Ability to change empty message per table.
+- Added en.json lang file.
+- Ability to add 'All' option to per-page.
+
+### Changed
+
+- Modified views to support localization better where necessary (republish views).
+- Alphabetize en.json
+- Fixed bulk actions using wrong key to select instead of $primaryKey
+- Make bulk select checkbox use primary key
+
 ## [1.3.1] - 2021-04-26
 
 ### Added
@@ -263,7 +279,8 @@ All notable changes to `laravel-livewire-tables` will be documented in this file
 
 - Initial release
 
-[Unreleased]: https://github.com/rappasoft/laravel-livewire-tables/compare/v1.3.1...development
+[Unreleased]: https://github.com/rappasoft/laravel-livewire-tables/compare/v1.4.0...development
+[1.4.0]: https://github.com/rappasoft/laravel-livewire-tables/compare/v1.3.1...v1.4.0
 [1.3.1]: https://github.com/rappasoft/laravel-livewire-tables/compare/v1.3.0...v1.3.1
 [1.3.0]: https://github.com/rappasoft/laravel-livewire-tables/compare/v1.2.2...v1.3.0
 [1.2.2]: https://github.com/rappasoft/laravel-livewire-tables/compare/v1.2.1...v1.2.2
diff --git a/README.md b/README.md
@@ -7,6 +7,8 @@
 
 A dynamic Laravel Livewire component for data tables.
 
+![Full Table](https://i.imgur.com/2kfibjR.png)
+
 This plugin assumes you already have [Laravel Livewire](https://laravel-livewire.com) and [Alpine.js](https://github.com/alpinejs/alpine) installed and configured in your project.
 
 ## Installation
diff --git a/resources/lang/en.json b/resources/lang/en.json
@@ -0,0 +1,22 @@
+{
+    "All": "All",
+    "Applied Filters": "Applied Filters",
+    "Applied Sorting": "Applied Sorting",
+    "Bulk Actions": "Bulk Actions",
+    "Clear": "Clear",
+    "Filters": "Filters",
+    "Remove filter option": "Remove filter option",
+    "Remove sort option": "Remove sort option",
+    "Search": "Search",
+    "Select All": "Select All",
+    "Showing": "Showing",
+    "Unselect All": "Unselect All",
+    "You are currently selecting all": "You are currently selecting all",
+    "You are not connected to the internet.": "You are not connected to the internet.",
+    "You have selected": "You have selected",
+    "of": "of",
+    "results": "results",
+    "rows": "rows",
+    "rows, do you want to select all": "rows, do you want to select all",
+    "to": "to"
+}
diff --git a/resources/views/bootstrap-4/includes/bulk-actions.blade.php b/resources/views/bootstrap-4/includes/bulk-actions.blade.php
@@ -1,7 +1,7 @@
 @if (count($bulkActions))
     <div class="dropdown mb-3 mb-md-0 d-block d-md-inline">
         <button class="btn dropdown-toggle d-block w-100 d-md-inline" type="button" id="bulkActions" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
-            {{ __('Bulk Actions') }}
+            @lang('Bulk Actions')
         </button>
 
         <div class="dropdown-menu dropdown-menu-right w-100" aria-labelledby="bulkActions">
diff --git a/resources/views/bootstrap-4/includes/filters.blade.php b/resources/views/bootstrap-4/includes/filters.blade.php
@@ -1,7 +1,7 @@
 @if ($filtersView || count($customFilters))
     <div class="btn-group d-block d-md-inline">
         <button type="button" class="btn dropdown-toggle d-block w-100 d-md-inline" data-toggle="dropdown">
-            {{ __('Filters') }}
+            @lang('Filters')
 
             @if (count(array_filter($filters)) && !(count(array_filter($filters)) === 1 && isset($filters['search'])))
                 <span class="badge badge-info">
diff --git a/resources/views/bootstrap-4/includes/pagination.blade.php b/resources/views/bootstrap-4/includes/pagination.blade.php
@@ -5,17 +5,21 @@
         </div>
 
         <div class="col-12 col-md-6 text-center text-md-right text-muted">
-            @lang('Showing :first to :last out of :total results', [
-                'first' => $rows->count() ? $rows->firstItem() : 0,
-                'last' => $rows->count() ? $rows->lastItem() : 0,
-                'total' => $rows->total()
-            ])
+            @lang('Showing')
+            <strong>{{ $rows->count() ? $rows->firstItem() : 0 }}</strong>
+            @lang('to')
+            <strong>{{ $rows->count() ? $rows->lastItem() : 0 }}</strong>
+            @lang('of')
+            <strong>{{ $rows->total() }}</strong>
+            @lang('results')
         </div>
     </div>
 @else
     <div class="row">
         <div class="col-12 text-muted">
-            {!! __('Showing <strong>:count</strong> results', ['count' => $rows->count()]) !!}
+            @lang('Showing')
+            <strong>{{ $rows->count() }}</strong>
+            @lang('results')
         </div>
     </div>
 @endif
diff --git a/resources/views/bootstrap-4/includes/per-page.blade.php b/resources/views/bootstrap-4/includes/per-page.blade.php
@@ -6,7 +6,7 @@
             class="form-control"
         >
             @foreach ($perPageAccepted as $item)
-                <option value="{{ $item }}">{{ $item }}</option>
+                <option value="{{ $item }}">{{ $item === -1 ? __('All') : $item }}</option>
             @endforeach
         </select>
     </div>
diff --git a/resources/views/bootstrap-4/includes/table.blade.php b/resources/views/bootstrap-4/includes/table.blade.php
@@ -30,7 +30,12 @@
                 <x-livewire-tables::bs4.table.cell colspan="{{ count($bulkActions) ? count($columns) + 1 : count($columns) }}">
                     @unless ($selectAll)
                         <div>
-                            <span>{!! __('You have selected <strong>:count</strong> rows, do you want to select all <strong>:total</strong>?', ['count' => $rows->count(), 'total' => number_format($rows->total())]) !!}</span>
+                            <span>
+                                @lang('You have selected')
+                                <strong>{{ $rows->count() }}</strong>
+                                @lang('rows, do you want to select all')
+                                <strong>{{ number_format($rows->total()) }}</strong>?
+                            </span>
 
                             <button
                                 wire:click="selectAll"
@@ -42,7 +47,11 @@ class="btn btn-primary btn-sm"
                         </div>
                     @else
                         <div>
-                            <span>{!! __('You are currently selecting all <strong>:total</strong> rows.', ['total' => number_format($rows->total())]) !!}</span>
+                            <span>
+                                @lang('You are currently selecting all')
+                                <strong>{{ number_format($rows->total()) }}</strong>
+                                @lang('rows').
+                            </span>
 
                             <button
                                 wire:click="resetBulk"
@@ -67,7 +76,7 @@ class="btn btn-primary btn-sm"
                     <x-livewire-tables::bs4.table.cell>
                         <input
                             wire:model="selected"
-                            value="{{ $row->getKey() }}"
+                            value="{{ $row->{$primaryKey} }}"
                             onclick="event.stopPropagation();return true;"
                             type="checkbox"
                         />
@@ -79,7 +88,7 @@ class="btn btn-primary btn-sm"
         @empty
             <x-livewire-tables::bs4.table.row>
                 <x-livewire-tables::bs4.table.cell colspan="{{ count($bulkActions) ? count($columns) + 1 : count($columns) }}">
-                    @lang('No items found. Try narrowing your search.')
+                    @lang($emptyMessage)
                 </x-livewire-tables::bs4.table.cell>
             </x-livewire-tables::bs4.table.row>
         @endforelse
diff --git a/resources/views/bootstrap-5/includes/bulk-actions.blade.php b/resources/views/bootstrap-5/includes/bulk-actions.blade.php
@@ -1,7 +1,7 @@
 @if (count($bulkActions))
     <div class="dropdown mb-3 mb-md-0 d-block d-md-inline">
         <button class="btn dropdown-toggle d-block w-100 d-md-inline" type="button" id="bulkActions" data-bs-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
-            {{ __('Bulk Actions') }}
+            @lang('Bulk Actions')
         </button>
 
         <div class="dropdown-menu dropdown-menu-end w-100" aria-labelledby="bulkActions">
diff --git a/resources/views/bootstrap-5/includes/filters.blade.php b/resources/views/bootstrap-5/includes/filters.blade.php
@@ -1,7 +1,7 @@
 @if ($filtersView || count($customFilters))
     <div class="btn-group d-block d-md-inline">
         <button type="button" class="btn dropdown-toggle d-block w-100 d-md-inline" data-bs-toggle="dropdown">
-            {{ __('Filters') }}
+            @lang('Filters')
 
             @if (count(array_filter($filters)) && !(count(array_filter($filters)) === 1 && isset($filters['search'])))
                 <span class="badge bg-info">
diff --git a/resources/views/bootstrap-5/includes/pagination.blade.php b/resources/views/bootstrap-5/includes/pagination.blade.php
@@ -5,17 +5,21 @@
         </div>
 
         <div class="col-12 col-md-6 text-center text-md-end text-muted">
-            @lang('Showing :first to :last out of :total results', [
-                'first' => $rows->count() ? $rows->firstItem() : 0,
-                'last' => $rows->count() ? $rows->lastItem() : 0,
-                'total' => $rows->total()
-            ])
+            @lang('Showing')
+            <strong>{{ $rows->count() ? $rows->firstItem() : 0 }}</strong>
+            @lang('to')
+            <strong>{{ $rows->count() ? $rows->lastItem() : 0 }}</strong>
+            @lang('of')
+            <strong>{{ $rows->total() }}</strong>
+            @lang('results')
         </div>
     </div>
 @else
     <div class="row">
         <div class="col-12 text-muted">
-            {!! __('Showing <strong>:count</strong> results', ['count' => $rows->count()]) !!}
+            @lang('Showing')
+            <strong>{{ $rows->count() }}</strong>
+            @lang('results')
         </div>
     </div>
 @endif
diff --git a/resources/views/bootstrap-5/includes/per-page.blade.php b/resources/views/bootstrap-5/includes/per-page.blade.php
@@ -6,7 +6,7 @@
             class="form-select"
         >
             @foreach ($perPageAccepted as $item)
-                <option value="{{ $item }}">{{ $item }}</option>
+                <option value="{{ $item }}">{{ $item === -1 ? __('All') : $item }}</option>
             @endforeach
         </select>
     </div>
diff --git a/resources/views/bootstrap-5/includes/table.blade.php b/resources/views/bootstrap-5/includes/table.blade.php
@@ -31,7 +31,12 @@ class="form-check-input"
                 <x-livewire-tables::bs5.table.cell colspan="{{ count($bulkActions) ? count($columns) + 1 : count($columns) }}">
                     @unless ($selectAll)
                         <div>
-                            <span>{!! __('You have selected <strong>:count</strong> rows, do you want to select all <strong>:total</strong>?', ['count' => $rows->count(), 'total' => number_format($rows->total())]) !!}</span>
+                            <span>
+                                @lang('You have selected')
+                                <strong>{{ $rows->count() }}</strong>
+                                @lang('rows, do you want to select all')
+                                <strong>{{ number_format($rows->total()) }}</strong>?
+                            </span>
 
                             <button
                                 wire:click="selectAll"
@@ -43,7 +48,11 @@ class="btn btn-primary btn-sm"
                         </div>
                     @else
                         <div>
-                            <span>{!! __('You are currently selecting all <strong>:total</strong> rows.', ['total' => number_format($rows->total())]) !!}</span>
+                            <span>
+                                @lang('You are currently selecting all')
+                                <strong>{{ number_format($rows->total()) }}</strong>
+                                @lang('rows').
+                            </span>
 
                             <button
                                 wire:click="resetBulk"
@@ -68,7 +77,7 @@ class="btn btn-primary btn-sm"
                     <x-livewire-tables::bs5.table.cell class="align-middle">
                         <input
                             wire:model="selected"
-                            value="{{ $row->getKey() }}"
+                            value="{{ $row->{$primaryKey} }}"
                             onclick="event.stopPropagation();return true;"
                             class="form-check-input"
                             type="checkbox"
@@ -81,7 +90,7 @@ class="form-check-input"
         @empty
             <x-livewire-tables::bs5.table.row>
                 <x-livewire-tables::bs5.table.cell colspan="{{ count($bulkActions) ? count($columns) + 1 : count($columns) }}">
-                    @lang('No items found. Try narrowing your search.')
+                    @lang($emptyMessage)
                 </x-livewire-tables::bs5.table.cell>
             </x-livewire-tables::bs5.table.row>
         @endforelse
diff --git a/resources/views/tailwind/includes/bulk-actions.blade.php b/resources/views/tailwind/includes/bulk-actions.blade.php
@@ -17,7 +17,7 @@ class="inline-flex justify-center w-full rounded-md border border-gray-300 px-4
                         x-bind:aria-expanded="open"
                         aria-expanded="true"
                     >
-                        {{ __('Bulk Actions') }}
+                        @lang('Bulk Actions')
 
                         <svg class="-mr-1 ml-2 h-5 w-5" x-description="Heroicon name: chevron-down" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor">
                             <path fill-rule="evenodd" d="M5.293 7.293a1 1 0 011.414 0L10 10.586l3.293-3.293a1 1 0 111.414 1.414l-4 4a1 1 0 01-1.414 0l-4-4a1 1 0 010-1.414z" clip-rule="evenodd"></path>
diff --git a/resources/views/tailwind/includes/pagination.blade.php b/resources/views/tailwind/includes/pagination.blade.php
@@ -2,6 +2,10 @@
     @if ($paginationEnabled && $showPerPage && $rows->lastPage() > 1)
         {{ $rows->links() }}
     @else
-        <p class="text-sm text-gray-700 leading-5">{!! __('Showing <span class="font-medium">:count</span> results', ['count' => $rows->count()]) !!}</p>
+        <p class="text-sm text-gray-700 leading-5">
+            @lang('Showing')
+            <span class="font-medium">{{ $rows->count() }}</span>
+            @lang('results')
+        </p>
     @endif
 </div>
diff --git a/resources/views/tailwind/includes/per-page.blade.php b/resources/views/tailwind/includes/per-page.blade.php
@@ -6,7 +6,7 @@
             class="rounded-md shadow-sm block w-full pl-3 pr-10 py-2 text-base leading-6 border-gray-300 focus:outline-none focus:border-indigo-300 focus:shadow-outline-indigo sm:text-sm sm:leading-5"
         >
             @foreach ($perPageAccepted as $item)
-                <option value="{{ $item }}">{{ $item }}</option>
+                <option value="{{ $item }}">{{ $item === -1 ? __('All') : $item }}</option>
             @endforeach
         </select>
     </div>
diff --git a/resources/views/tailwind/includes/table.blade.php b/resources/views/tailwind/includes/table.blade.php
@@ -33,7 +33,12 @@ class="rounded-md shadow-sm border-gray-300 block transition duration-150 ease-i
                 <x-livewire-tables::table.cell :colspan="count($bulkActions) ? count($columns) + 1 : count($columns)">
                     @unless ($selectAll)
                         <div>
-                            <span>{!! __('You have selected <strong>:count</strong> rows, do you want to select all <strong>:total</strong>?', ['count' => $rows->count(), 'total' => number_format($rows->total())]) !!}</span>
+                            <span>
+                                @lang('You have selected')
+                                <strong>{{ $rows->count() }}</strong>
+                                @lang('rows, do you want to select all')
+                                <strong>{{ number_format($rows->total()) }}</strong>?
+                            </span>
 
                             <button
                                 wire:click="selectAll"
@@ -45,7 +50,11 @@ class="ml-1 text-blue-600 underline text-gray-700 text-sm leading-5 font-medium
                         </div>
                     @else
                         <div>
-                            <span>{!! __('You are currently selecting all <strong>:total</strong> rows.', ['total' => number_format($rows->total())]) !!}</span>
+                            <span>
+                                @lang('You are currently selecting all')
+                                <strong>{{ number_format($rows->total()) }}</strong>
+                                @lang('rows').
+                            </span>
 
                             <button
                                 wire:click="resetBulk"
@@ -72,7 +81,7 @@ class="ml-1 text-blue-600 underline text-gray-700 text-sm leading-5 font-medium
                         <div class="flex rounded-md shadow-sm">
                             <input
                                 wire:model="selected"
-                                value="{{ $row->getKey() }}"
+                                value="{{ $row->{$primaryKey} }}"
                                 onclick="event.stopPropagation();return true;"
                                 type="checkbox"
                                 class="rounded-md shadow-sm border-gray-300 block transition duration-150 ease-in-out sm:text-sm sm:leading-5"
@@ -91,7 +100,7 @@ class="rounded-md shadow-sm border-gray-300 block transition duration-150 ease-i
                             <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M20 13V6a2 2 0 00-2-2H6a2 2 0 00-2 2v7m16 0v5a2 2 0 01-2 2H6a2 2 0 01-2-2v-5m16 0h-2.586a1 1 0 00-.707.293l-2.414 2.414a1 1 0 01-.707.293h-3.172a1 1 0 01-.707-.293l-2.414-2.414A1 1 0 006.586 13H4" />
                         </svg>
 
-                        <span class="font-medium py-8 text-gray-400 text-xl">@lang('No items found. Try narrowing your search.')</span>
+                        <span class="font-medium py-8 text-gray-400 text-xl">@lang($emptyMessage)</span>
                     </div>
                 </x-livewire-tables::table.cell>
             </x-livewire-tables::table.row>
diff --git a/src/DataTableComponent.php b/src/DataTableComponent.php
@@ -49,7 +49,14 @@ abstract class DataTableComponent extends Component
      *
      * @var bool
      */
-    public $offlineIndicator = true;
+    public bool $offlineIndicator = true;
+
+    /**
+     * The message to show when there are no results from a search or query
+     *
+     * @var string
+     */
+    public string $emptyMessage = 'No items found. Try narrowing your search.';
 
     /**
      * Name of the page parameter for pagination
diff --git a/src/LaravelLivewireTablesServiceProvider.php b/src/LaravelLivewireTablesServiceProvider.php
@@ -42,6 +42,7 @@ public function configurePackage(Package $package): void
         $package
             ->name('laravel-livewire-tables')
             ->hasConfigFile()
-            ->hasViews();
+            ->hasViews()
+            ->hasTranslations();
     }
 }
diff --git a/src/Traits/WithBulkActions.php b/src/Traits/WithBulkActions.php
@@ -61,7 +61,7 @@ public function resetBulk(): void
     public function selectedRowsQuery(): Builder
     {
         return (clone $this->rowsQuery())
-            ->unless($this->selectAll, fn ($query) => $query->whereKey($this->selected));
+            ->unless($this->selectAll, fn ($query) => $query->whereIn($this->primaryKey, $this->selected));
     }
 
     public function getSelectedRowsQueryProperty(): Builder
diff --git a/src/Traits/WithPerPagePagination.php b/src/Traits/WithPerPagePagination.php
@@ -12,9 +12,14 @@ trait WithPerPagePagination
     public bool $showPagination = true;
     public int $perPage = 10;
     public array $perPageAccepted = [10, 25, 50];
+    public bool $perPageAll = false;
 
     public function mountWithPerPagePagination(): void
     {
+        if ($this->perPageAll) {
+            $this->perPageAccepted[] = -1;
+        }
+
         if (in_array(session()->get($this->tableName.'-perPage', $this->perPage), $this->perPageAccepted, true)) {
             $this->perPage = session()->get($this->tableName.'-perPage', $this->perPage);
         } else {
@@ -42,6 +47,6 @@ public function updatedPerPage($value): void
      */
     public function applyPagination($query)
     {
-        return $query->paginate($this->perPage, ['*'], $this->pageName());
+        return $query->paginate($this->perPage === -1 ? $query->count() : $this->perPage, ['*'], $this->pageName());
     }
 }
diff --git a/src/Traits/WithSorting.php b/src/Traits/WithSorting.php

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`class="form-control"`
`7`	`7`	`>`
`8`	`8`	`@foreach ($perPageAccepted as $item)`
`9`		`- <option value="{{ $item }}">{{ $item }}</option>`
	`9`	`+ <option value="{{ $item }}">{{ $item === -1 ? __('All') : $item }}</option>`
`10`	`10`	`@endforeach`
`11`	`11`	`</select>`
`12`	`12`	`</div>`