README

根据当前状态显示记录/数据的 Livewire 组件

预览

安装

您可以通过 composer 安装此包

composer require asantibanez/livewire-status-board

需求

此包在底层使用 livewire/livewire (https://laravel-livewire.com/)。

它还使用 TailwindCSS (https://tailwind.org.cn/) 进行基本样式设置。

在使用此组件之前，请确保包含这两个依赖项。

用法

为了使用此组件，您必须创建一个新的 Livewire 组件，该组件从 LivewireStatusBoard 扩展

您可以使用 make:livewire 创建一个新组件。例如。

php artisan make:livewire SalesOrdersStatusBoard

在 SalesOrdersStatusBoard 类中，不要从基本的 Livewire Component 类扩展，而是从 LivewireStatusBoard 扩展。此外，删除 render 方法。您将有一个类似于以下片段的类。

class SalesOrdersStatusBoard extends LivewireStatusBoard
{
    //
}

在此类中，您必须重写以下方法以显示数据

public function statuses() : Collection 
{
    //
}

public function records() : Collection 
{
    //
}

如您所注意到的，这两个方法都返回一个集合。statuses() 指的是您的数据可能在不同的时间点具有的所有不同的状态值。records() 则代表您想要显示的数据，这些数据可能位于之前定义的 statuses() 集合中的任何一种状态。

为了说明这两个方法如何协同工作，让我们讨论一个销售订单及其在整个销售过程中不同状态的例子：已注册、待确认、已确认、已交付。每个销售订单在特定时间可能处于不同的状态。对于此示例，我们可能为 statuses() 定义以下集合

public function statuses() : Collection
{
    return collect([
        [
            'id' => 'registered',
            'title' => 'Registered',
        ],
        [
            'id' => 'awaiting_confirmation',
            'title' => 'Awaiting Confirmation',
        ],
        [
            'id' => 'confirmed',
            'title' => 'Confirmed',
        ],
        [
            'id' => 'delivered',
            'title' => 'Delivered',
        ],
    ]);
}

对于我们定义的每个 status，我们必须返回一个包含至少 2 个键的数组：id 和 title。

现在，对于 records()，我们可以在我们的项目中定义一个销售订单列表，这些销售订单来自 Eloquent 模型

public function records() : Collection
{
    return SalesOrder::query()
        ->map(function (SalesOrder $salesOrder) {
            return [
                'id' => $salesOrder->id,
                'title' => $salesOrder->client,
                'status' => $salesOrder->status,
            ];
        });
}

如您在上面的片段中看到的，我们必须返回一个包含数组项的集合，每个项至少必须包含 3 个键：id、title 和 status。最后一个是最重要的，因为它将被用来匹配记录所属的哪个 status。为此，组件通过以下比较将 status 和 records 匹配

$status['id'] === $record['status'];

要在视图中渲染组件，只需使用 Livewire 标签或包含语法

<livewire:sales-orders-status-board />

填充销售订单模型，您应该得到以下截图所示的类似结果

您可以使用这种方法渲染项目中任何渲染和状态 👍

排序和拖动

默认情况下，排序和在不同状态之间拖动是禁用的。要启用它，您必须在使用视图时包含以下属性：sortable 和 sortable-between-statuses

<livewire:sales-orders-status-board 
    :sortable="true"
    :sortable-between-statuses="true"
/>

sortable 启用每个状态内的排序，而 sortable-between-statuses 允许将项目从一个状态拖动到另一个状态。添加这两个属性，允许您实现拖放。

您还必须在项目中安装以下 JS 依赖项以启用排序和拖动。

npm install jquery
npm install sortablejs

安装后，请将其在全局 window 对象中可用。这可以在您的 Laravel 应用程序附带的自定义 bootstrap.js 文件中完成。

window.$ = require('jquery');
window.Sortable = require('sortablejs').default;

行为和交互

当启用排序和拖动时，您的组件可以通知当以下事件发生时。这两个事件触发的回调是 onStatusSorted 和 onStatusChanged

在onStatusSorted中，您将收到通知，了解哪个record在其status中的位置已发生变化。您还将获得一个包含records排序后ID的$orderedIds数组。您必须重写以下方法来接收此变化的通知。

public function onStatusSorted($recordId, $statusId, $orderedIds)
{
    //   
}

当record被移动到另一个status时，会触发onStatusChanged。在这种情况下，您将收到有关已更改的record、新的status、来自上一个状态的有序ID以及该记录进入的新状态的有序ID的通知。要接收此事件的提醒，您必须重写以下方法

public function onStatusChanged($recordId, $statusId, $fromOrderedIds, $toOrderedIds)
{
    //
}

onStatusSorted和onStatusChanged不会同时触发。当发生交互时，您将收到其中一个通知。

样式

要修改组件的外观和感觉，您可以重写styles方法，并将此方法返回的基本样式修改为视图。styles()返回一个带有Tailwind CSS类别的键值数组，用于渲染组件的每个部分。这些基本键和样式如下

return [
    'wrapper' => 'w-full h-full flex space-x-4 overflow-x-auto', // component wrapper
    'statusWrapper' => 'h-full flex-1', // statuses wrapper
    'status' => 'bg-blue-200 rounded px-2 flex flex-col h-full', // status column wrapper 
    'statusHeader' => 'p-2 text-sm text-gray-700', // status header
    'statusFooter' => '', // status footer
    'statusRecords' => 'space-y-2 p-2 flex-1 overflow-y-auto', // status records wrapper 
    'record' => 'shadow bg-white p-2 rounded border', // record
    'ghost' => 'bg-indigo-200', // ghost class used when sorting/dragging. Must be only 1
];

以下是一个重写styles()方法的示例

public function styles()
{
    $baseStyles = parent::styles();

    $baseStyles['wrapper'] = 'w-full flex space-x-4 overflow-x-auto bg-blue-500 px-4 py-8';

    $baseStyles['statusWrapper'] = 'flex-1';

    $baseStyles['status'] = 'bg-gray-200 rounded px-2 flex flex-col flex-1';

    $baseStyles['record'] = 'shadow bg-white p-2 rounded border text-sm text-gray-800';

    $baseStyles['statusRecords'] = 'space-y-2 px-1 pt-2 pb-2';

    $baseStyles['statusHeader'] = 'text-sm font-medium py-2 text-gray-700';

    $baseStyles['ghost'] = 'bg-gray-400';

    return $baseStyles;
}

使用这些新样式后，您的组件应类似于下面的截图

看起来像Trello，对吧？ 😅

高级样式和行为

可以通过将它们导出到您的项目中来根据需要自定义组件的基本视图。为此，请运行php artisan vendor:publish命令并导出livewire-status-board-views标签。该命令将在/resources/views/vendor/livewire-status-board下发布基本视图。您可以根据需要修改这些基本组件，同时注意在过程中维护data属性和ids。

另一种方法是复制基本视图文件到您自己的视图文件中，并直接将它们传递给组件

<livewire:sales-orders-status-board 
    status-board-view="path/to/your/status-board-view"
    status-view="path/to/your/status-view"
    status-header-view="path/to/your/status-header-view"
    status-footer-view="path/to/your/status-footer-view"
    record-view="path/to/your/record-view"
/>

注意：使用此方法还可以让您向组件添加额外的行为，如记录项上的点击事件 💪

添加额外视图

组件允许您在状态板渲染前后添加一个视图。这两个占位符可以用于向组件添加额外功能，如搜索输入或操作工具栏。要使用它们，只需在显示组件时传递before-status-board-view和after-status-board-view属性中您想使用的视图。

<livewire:sales-orders-status-board 
    before-status-board-view="path/to/your/before-status-board-view"
    after-status-board-view="path/to/your/after-status-board-view"  
/>

注意：这些视图是可选的。

以下示例中指定了before-status-board-view以添加搜索文本框和按钮

测试

composer test

变更日志

请参阅CHANGELOG获取有关最近更改的更多信息。

贡献

请参阅CONTRIBUTING以获取详细信息。

安全

如果您发现任何安全问题，请通过电子邮件santibanez.andres@gmail.com而不是使用问题跟踪器来报告。

鸣谢

许可证

MIT许可证（MIT）。请参阅许可证文件以获取更多信息。

rohitrd31 / livewire-status-board

维护者

详细信息