Merge pull request #608 from Laravel-Backpack/update-v7-docs

update v7 docs with last v6 changes

7.x-dev/crud-columns.md

@@ -740,6 +740,8 @@ The select_multiple column will output a comma separated list of its connected e
    'entity'    => 'tags', // the method that defines the relationship in your Model
    'attribute' => 'name', // foreign key attribute that is shown to user
    'model'     => 'App\Models\Tag', // foreign key model
+   // OPTIONAL
+   'separator' => ',', // if you want to use a different separator than the default ','
 ],
 ```
 
@@ -877,6 +879,8 @@ Show a link which opens in the new tab by default.
     'type'  => 'url',
     'label' => 'URL',
     //'target' => '_blank' // let's you change link target window.
+    //'element' => 'a' // let's you change the element of the link.
+    //'rel' => false OR 'rel' => 'noopener' // let's you disable or change the rel attribute of the link.
 ],
 ```
 

7.x-dev/crud-fields.md

@@ -2291,6 +2291,7 @@ CRUD::field([   // select2_from_array
     'allows_null' => false,
     'default'     => 'one',
     // 'allows_multiple' => true, // OPTIONAL; needs you to cast this to array in your model;
+    // 'sortable' => true, // requires the field to accept multiple values, and allow the selected options to be sorted.
 ]);
 ```
 

7.x-dev/crud-filters.md

@@ -621,6 +621,23 @@ CRUD::filter('trashed')
 <a name="tips-and-tricks"></a>
 ## Tips and Tricks
 
+<a name="debouncing-filters"></a>
+### Add a debounce time to filters
+
+Filters can be debounced, so that the filtering logic is only applied after the user has stopped typing for a certain amount of time. This is useful when the filtering logic is expensive and you don't want it to run on every keystroke. To debounce a filter, you can use the following code:
+
+```php
+
+CRUD::filter('name')
+    ->type('text')
+    ->debounce(1000) // debounce time in milliseconds
+    ->whenActive(function($value) {
+        // CRUD::addClause('where', 'name', 'LIKE', "%$value%");
+    });
+```
+
+All filter types accept a `debounce`, like for example the simple filter, range filter etc.
+
 <a name="adding-a-filter-using-array-syntax"></a>
 ### Adding a filter using array syntax
 

7.x-dev/crud-operation-clone.md

@@ -50,6 +50,15 @@ class ProductCrudController extends CrudController
         CRUD::setModel(\App\Models\Product::class);
         CRUD::setRoute(backpack_url('product'));
         CRUD::setEntityNameStrings('product', 'products');
+
+        // optionally you can redirect the user after the clone operation succeeds
+        // if you set the `redirect_after_clone` option to true, it defaults to the edit page
+        $this->crud->set('clone.redirect_after_clone', true);
+
+        // you can also use a closure to define the redirect URL
+        $this->crud->set('clone.redirect_after_clone', function($entry) {
+            return backpack_url('product/'.$entry->id.'/show'); // redirect to show view instead of edit
+        });
     }
 }
 ```

7.x-dev/crud-operation-list-entries.md

@@ -95,6 +95,21 @@ a) For all CrudController (globally) in the `config/backpack/operations/list.php
 
 b) For a specific CrudController, in its `setupListOperation()` define `CRUD::setOperationSetting('lineButtonsAsDropdown', true);`
 
+##### Available options
+
+Additionally you can control the dropdown behavior with `lineButtonsAsDropdownMinimum` and `lineButtonsAsDropdownShowBefore`. By default the dropdown is created no matter how many buttons are present in the line stack. You can change this behavior by setting `lineButtonsAsDropdownMinimum` to a number. If the number of buttons in the line stack is less than this number, the buttons will not be converted to a dropdown. You can also set `lineButtonsAsDropdownShowBefore` to a number to drop the buttons after that number of buttons.
+
+```php
+CRUD::setOperationSetting('lineButtonsAsDropdown', true);
+CRUD::setOperationSetting('lineButtonsAsDropdownMinimum', 5); // if there are less than 5 buttons, don't create the dropdown (default: 1)
+CRUD::setOperationSetting('lineButtonsAsDropdownShowBefore', 3); // force the first 3 buttons to be inline, and the rest in a dropdown (default: 0)
+
+// in the above example, when:
+// - there are 3 or less buttons, they will be shown inline
+// - there are 4 buttons, all 4 will be shown inline
+// - there are 5 or more buttons, the first 3 will be shown inline, and the rest in a dropdown
+```
+
 To learn more about buttons, **check out the [Buttons](/docs/{{version}}/crud-buttons) documentation page**.
 
 <a name="filters"></a>
@@ -149,7 +164,7 @@ Exporting the DataTable to PDF, CSV, XLS is as easy as typing ```CRUD::enableExp
 
 **Please note that when clicked, the button will export**
 - **the _currently visible_ table columns** (except columns marked as ```visibleInExport => false```);
-- **the columns that are forced to export** (with ```visibleInExport => true``` or ```exportOnlyField => true```);
+- **the columns that are forced to export** (with ```visibleInExport => true``` or ```exportOnlyColumn => true```);
 
 **In the UI, the admin can use the "Visibility" button, and the "Items per page" dropdown to manipulate what is visible in the table - and consequently what will be exported.**
 
@@ -159,7 +174,7 @@ Available customization:
 ```
 'visibleInExport' => true/false
 'visibleInTable' => true/false
-'exportOnlyField' => true
+'exportOnlyColumn' => true
 ```
 
 By default, the field will start visible in the table. Users can hide it toggling visibility. Will be exported if visible in the table.
@@ -172,7 +187,7 @@ Setting `visibleInTable => true` will force the field to stay in the table no ma
 
 Using `'visibleInTable' => false` will make the field start hidden in the table. But users can toggle it's visibility.
 
-If you want a field that is not on table, user can't show it, but will **ALWAYS** be exported use the `exportOnlyField => true`. If used will ignore any other custom visibility you defined.
+If you want a field that is not on table, user can't show it, but will **ALWAYS** be exported use the `exportOnlyColumn => true`. If used will ignore any other custom visibility you defined.
 
 #### How to use different separator in DataTables (eg. semicolon instead of comma)
 

7.x-dev/crud-operation-reorder.md

@@ -12,7 +12,20 @@ This operation allows your admins to reorder & nest entries.
 <a name="requirements"></a>
 ## Requirements
 
-Your model should have the following integer fields, with a default value of 0: ```parent_id```, ```lft```, ```rgt```, ```depth```.
+Your model should have the following integer fields, with a default value of 0: ```parent_id```, ```lft```, ```rgt```, ```depth```. The names are optional, you can change them in the ```setupReorderOperation()``` method. 
+
+```php
+
+protected function setupReorderOperation()
+{
+    CRUD::setOperationSetting('reorderColumnNames', [
+        'parent_id' => 'custom_parent_id',
+        'lft' => 'left',
+        'rgt' => 'right',
+        'depth' => 'deep',
+    ]);
+}
+```	
 
 Additionally, the `parent_id` field has to be nullable.
 

7.x-dev/crud-operation-update.md

@@ -374,6 +374,7 @@ class Product extends Model
     protected $primaryKey = 'id';
     protected $fillable = ['name', 'category_id', 'options', 'price', 'tags'];
     protected $translatable = ['name', 'options'];
+}
 ```
 
 > You DO NOT need to cast translatable string columns as array/json/object in the Eloquent model. From Eloquent's perspective they're strings. So:
@@ -453,4 +454,4 @@ If you want to display a **Delete** button right on the **Update** operation, yo
     }
 ```
 
-This will allow admins to remove entries right from the **Update Operation**, and it will redirect them back ot the **List Operation** afterwards.
+This will allow admins to remove entries right from the **Update Operation**, and it will redirect them back to the **List Operation** afterwards.