Merge pull request #224 from rappasoft/develop

v1.2.0

Author: rappasoft

CHANGELOG.md

@@ -4,6 +4,26 @@ All notable changes to `laravel-livewire-tables` will be documented in this file
 
 ## [Unreleased]
 
+## [1.2.0] - 2021-04-22
+
+### Added
+
+- Ability to disable pagination (https://github.com/rappasoft/laravel-livewire-tables/pull/222)
+- Ability to define the sorting direction names for each column. i.e. A-Z, Z-A, Yes, No, Enabled, Disabled, etc.
+- Added ability to define primary key of rows for bulk select
+- Added selectedKeys property that returns an array of the ids of the selected rows
+
+### Changed
+
+- Clarified where rowView looks in read me
+- Null the search filter when it's empty
+- Fill per page options from $perPageAccepted in views
+- Make $perPageAccepted public
+
+### Removed
+
+- Removed `text-secondary` class from sorting title
+
 ## [1.1.0] - 2021-04-21
 
 ### Added
@@ -205,7 +225,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.1.0...development
+[Unreleased]: https://github.com/rappasoft/laravel-livewire-tables/compare/v1.2.0...development
+[1.2.0]: https://github.com/rappasoft/laravel-livewire-tables/compare/v1.0.4...v1.2.0
 [1.1.0]: https://github.com/rappasoft/laravel-livewire-tables/compare/v1.0.4...v1.1.0
 [1.0.4]: https://github.com/rappasoft/laravel-livewire-tables/compare/v1.0.3...v1.0.4
 [1.0.3]: https://github.com/rappasoft/laravel-livewire-tables/compare/v1.0.2...v1.0.3

README.md

@@ -110,11 +110,14 @@ Column::make('Name')
 
 If you would like full control over your rows without using the Column formatter, than you can define a `rowView` and return the string to the view to render the rows. The view will be passed the current $row.
 
+The string is just passed to a regular Laravel `@include()` so it starts at the resources/views directory which you do not need to specify.
+
 **row.blade.php**
 
 ```php
 public function rowView(): string
 {
+     // Becomes /resources/views/location/to/my/row.blade.php
      return 'location.to.my.row.view';
 }
 ```
@@ -226,6 +229,18 @@ public array $sortNames = [
 ];
 ```
 
+#### Configuring Sort Direction Names
+
+The default sort direction names are A-Z for ascending and Z-A for descending.
+
+```php
+public array $sortDirectionNames = [
+    'enabled' => [
+        'asc' => 'Yes',
+        'desc' => 'No',
+    ],
+];
+
 ### Defining The Query
 
 Your datatable must have a base query, which you define in the **query()** method:
@@ -360,10 +375,16 @@ And then using it like this:
 }
 ```
 
-### Creating Bulk Actions
+### Bulk Actions
 
 Bulk actions are not required, and the bulk actions box, as well as the left-hand checkboxes will be hidden if none are defined.
 
+#### The primary key
+
+Each row must have a primary key, it's `'id'` by default but you can override it with the `$primaryKey` property.
+
+#### Defining Bulk Actions
+
 To define your bulk actions, you add them to the **$bulkActions** array.
 
 ```php
@@ -389,17 +410,46 @@ public function exportSelected()
 
 In the component you have access to `$this->selectedRowsQuery` which is a **Builder** instance of the selected rows.
 
+You may also call `selectedKeys` which gives you an array of the primary keys in order they were selected:
+
+**Note:** See above to setting the primary key if not `'id`.
+
+```php
+public function exportSelected()
+{
+    if (count($this->selectedKeys)) {
+        // Do something with the selected rows
+        dd($this->selectedKeys);
+        
+//        => [
+//            1,
+//            2,
+//            3,
+//            4,
+//        ]   
+    }
+
+    // Notify there is nothing to export
+}
+```
+
 ### Options
 
 There are some class level properties you can set:
 
 | Property | Default | Options | Usage |
 | -------- | ------- | ------- | ----- |
 | $showSearch | true | bool | Show the search box |
-| $showPerPage | true | bool | Show the per page selector |
-| $showPagination | true | bool | Show the pagination |
+| $paginationEnabled | true | bool | Enable pagination or fetch all records with no pagination |
+| $showPerPage | true | bool | Show the per page selector when pagination is enabled |
+| $showPagination | true | bool | Show the pagination when pagination is enabled |
 | $showSorting | true | bool | Show the sorting pills |
 | $showFilters | true | bool | Show the filter pills |
+| $sortNames | [] | string[] | Change the sort name of the column for the sorting pill display |
+| $sortDirectionNames | [] | string[] | Change the direction name of the column for the sorting pill display (i.e. A-Z, Z-A) |
+| $perPage | 10 | int | The default per page amount selected (must exist in list) |
+| $perPageAccepted | [10, 25, 50] | int[] | The values for the per page dropdown, in order |
+| $primaryKey | id | string | The column to pluck for bulk actions to populate the `selectedKeys` property |
 | $searchFilterDebounce | null | null/int | Adds a debounce of `$searchFilterDebounce` ms to the search input |
 | $searchFilterDefer | null | null/bool | Adds `.defer` to the search input |
 | $searchFilterLazy | null | null/bool | Adds `.lazy` to the search input |

resources/views/bootstrap-4/datatable.blade.php

@@ -27,10 +27,7 @@ class="container-fluid"
 
         <div class="d-md-flex">
             @include('livewire-tables::bootstrap-4.includes.bulk-actions')
-
-            <div class="ml-0 ml-md-3">
-                @include('livewire-tables::bootstrap-4.includes.per-page')
-            </div>
+            @include('livewire-tables::bootstrap-4.includes.per-page')
         </div>
     </div>
 

resources/views/bootstrap-4/includes/filter-pills.blade.php

@@ -1,6 +1,6 @@
 @if ($showFilters && count(array_filter($filters)) && !(count(array_filter($filters)) === 1 && isset($filters['search'])))
     <div class="mb-3">
-        <small class="text-secondary">@lang('Applied Filters'):</small>
+        <small>@lang('Applied Filters'):</small>
 
         @foreach($filters as $key => $value)
             @if ($key !== 'search' && strlen($value))

resources/views/bootstrap-4/includes/pagination.blade.php

@@ -1,4 +1,4 @@
-@if ($showPagination)
+@if ($paginationEnabled && $showPerPage)
     <div class="row">
         <div class="col-12 col-md-6">
             {{ $rows->links() }}

resources/views/bootstrap-4/includes/per-page.blade.php

@@ -1,11 +1,13 @@
-@if ($showPerPage)
-    <select
-        wire:model="perPage"
-        id="perPage"
-        class="form-control"
-    >
-        <option value="10">10</option>
-        <option value="25">25</option>
-        <option value="50">50</option>
-    </select>
+@if ($paginationEnabled && $showPerPage)
+    <div class="ml-0 ml-md-3">
+        <select
+            wire:model="perPage"
+            id="perPage"
+            class="form-control"
+        >
+            @foreach ($perPageAccepted as $item)
+                <option value="{{ $item }}">{{ $item }}</option>
+            @endforeach
+        </select>
+    </div>
 @endif

resources/views/bootstrap-4/includes/sorting-pills.blade.php

@@ -1,13 +1,13 @@
 @if ($showSorting && count($sorts))
     <div class="mb-3">
-        <small class="text-secondary">@lang('Applied Sorting'):</small>
+        <small>@lang('Applied Sorting'):</small>
 
         @foreach($sorts as $col => $dir)
             <span
                 wire:key="sorting-pill-{{ $col }}"
                 class="badge badge-pill badge-info d-inline-flex align-items-center"
             >
-                <span>{{ $sortNames[$col] ?? ucwords(strtr($col, ['_' => ' ', '-' => ' '])) }}: {{ $dir === 'asc' ? 'A-Z' : 'Z-A' }}</span>
+                <span>{{ $sortNames[$col] ?? ucwords(strtr($col, ['_' => ' ', '-' => ' '])) }}: {{ $dir === 'asc' ? ($sortDirectionNames[$col]['asc'] ?? 'A-Z') : ($sortDirectionNames[$col]['desc'] ?? 'Z-A') }}</span>
 
                 <a
                     href="#"

resources/views/bootstrap-5/datatable.blade.php

@@ -27,10 +27,7 @@ class="container-fluid"
 
         <div class="d-md-flex">
             @include('livewire-tables::bootstrap-5.includes.bulk-actions')
-
-            <div class="ms-0 ms-md-3">
-                @include('livewire-tables::bootstrap-5.includes.per-page')
-            </div>
+            @include('livewire-tables::bootstrap-5.includes.per-page')
         </div>
     </div>
 

resources/views/bootstrap-5/includes/filter-pills.blade.php

@@ -1,6 +1,6 @@
 @if ($showFilters && count(array_filter($filters)) && !(count(array_filter($filters)) === 1 && isset($filters['search'])))
     <div class="mb-3">
-        <small class="text-secondary">@lang('Applied Filters'):</small>
+        <small>@lang('Applied Filters'):</small>
 
         @foreach($filters as $key => $value)
             @if ($key !== 'search' && strlen($value))

resources/views/bootstrap-5/includes/pagination.blade.php

@@ -1,4 +1,4 @@
-@if ($showPagination)
+@if ($paginationEnabled && $showPerPage)
     <div class="row">
         <div class="col-12 col-md-6">
             {{ $rows->links() }}