Laravel Nova 可排序资源插件：nova-sortable 完全指南

Laravel Nova 可排序资源插件：nova-sortable 完全指南

项目介绍

nova-sortable 是一个为 Laravel Nova 开发的开源软件包，它基于 MIT 许可证分发。此包允许开发者在 Nova 的资源索引视图中通过拖放功能轻松地重新排列模型顺序。它支持对具有多态关系或属于（BelongsTo）、通过关联表的 MorphsTo 关系的模型进行排序，并提供了从 spatie/eloquent-sortable 库底层的支持。要求环境包括 PHP 8.0 及以上版本以及 Laravel Nova 4.24.0 或更高版本。

项目快速启动

安装步骤

首先，通过 Composer 在你的 Laravel Nova 项目中添加该插件：

composer require outl1ne/nova-sortable

安装完成后，需要在数据库中为模型添加排序字段。这通常通过创建一个新的迁移来实现，例如为 some_model 添加 sort_order 字段：

// 迁移示例
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

class AddSortOrderToSomeModelsTable extends Migration
{
    public function up()
    {
        Schema::table('some_model', function (Blueprint $table) {
            $table->integer('sort_order')->nullable()->default(null);
        });
    }

    public function down()
    {
        Schema::table('some_model', function (Blueprint $table) {
            $table->dropColumn('sort_order');
        });
    }
}

接着，你需要发布配置文件和本地化文件（如果需要自定义翻译）：

php artisan vendor:publish --provider="Outl1ne\NovaSortable\ToolServiceProvider" --tag="translations"

最后，在你的 Nova 资源类中启用并配置排序选项：

use Laravel\Nova\HasSortableRows;
use Outl1ne\NovaSortable\Traits\SortableTrait;

class SomeModelResource extends Resource
{
    use HasSortableRows, SortableTrait;

    public static function indexQuery(NovaRequest $request, $query)
    {
        return $query->orderBy('sort_order', 'asc'); // 示例，按你的需求调整
    }

    public $sortable = [
        'order_column_name' => 'sort_order',
        'sort_when_creating' => true,
        'nova_order_by' => 'asc', // 默认为 ASC，根据需要调整
    ];
}

确保访问 Nova 界面时，相应的资源列表现在支持拖拽排序。

应用案例和最佳实践

• 动态布局管理：对于那些需要用户自定义页面元素顺序的应用，如网站构建器或仪表板配置，此插件可以帮助用户通过界面简单调整元素顺序。
• 文章或菜单管理：博客平台或网站导航管理可以利用此功能让用户直观地调整文章发表顺序或菜单项的排列。

最佳实践

• 当启用排序时，考虑数据的一致性，确保数据库迁移正确处理 sort_order 字段。
• 对于大量记录的排序，监控性能以避免前端响应延迟。
• 利用 Nova 的政策系统控制哪些用户能够进行排序操作，增强安全性。

典型生态项目

虽然直接提及的典型生态项目未在原始引用中提供，nova-sortable本身就是一个典型的Laravel Nova生态系统组件，它可以与其他诸如角色权限管理、定制字段类型等 Nova 包结合，共同构建复杂且高度可定制的后台管理系统。

---

以上就是 nova-sortable 插件的快速上手指南及一些基本应用建议，帮助你在 Laravel Nova 中实现高效的数据排序管理。