README

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

预览

安装

您可以通过Composer安装此包

composer require asantibanez/livewire-status-board

需求

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

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

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

用法

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

您可以使用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。最后一个是最重要的，因为它将被用于将record与哪个status匹配。为此，组件通过以下比较将status和records匹配

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

要将组件渲染到视图中，只需使用Livewire标签或include语法即可

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

填充销售订单模型，您应该会得到以下截图类似的内容

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

排序和拖动

默认情况下，排序和状态之间的拖动是禁用的。要启用它，您必须在使用视图时包含以下props：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)。有关更多信息，请参阅许可文件

��iaCRM / board

维护者

详细信息