michielkempen/nova-order-field

A Laravel Nova field.

2.0.4 2019-11-30 18:02 UTC

This package is auto-updated.

Last update: 2020-10-17 10:47:25 UTC


README

Latest Version on Packagist Total Downloads

Description

A field that adds reordering functionality to your Laravel Nova resource's index using the eloquent-sortable package by Spatie.

Demo

Demo

Installation

This package can be installed through Composer.

composer require michielkempen/nova-order-field

Usage

  1. Follow the usage instructions on the eloquent-sortable repository to make your model sortable.
  2. Add the MichielKempen\NovaOrderField\Orderable trait to your Nova Resource.
  3. Add a public static property called $defaultOrderField to your resource, containing your order column.
  4. Add the OrderField to your Nova Resource fields method.

Grouping

If your model/table has a grouping field (usually a foreign key): id, user_id, title, order_column and you'd like the above methods to take it into considerations, you can create a buildSortQuery method at your model:

public function buildSortQuery()
{
    return static::query()->where('user_id', $this->user_id);
}

This will restrict the calculations to fields value of the model instance.

Example

use MichielKempen\NovaOrderField\Orderable;
use MichielKempen\NovaOrderField\OrderField;

class Page extends Resource
{
    use Orderable;
    
    public static $defaultOrderField = 'order';
    
    public function fields(Request $request)
    {
        return [
            OrderField::make('Order'),
        ];
    }
}