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的record。为此，组件通过以下比较匹配status和records

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

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

<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 中改变了位置。您还会收到一个 $orderedIds 数组，该数组包含排序后的 records 的 ID。您必须重写以下方法以在更改时收到通知。

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

在 onStatusChanged 被触发时，一个 record 被移动到另一个 status。在这种情况下，您会收到有关更改的 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 下发布基本视图。您可以根据需要修改这些基本组件，同时注意保持数据属性和 ID。

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

<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 props。

<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

更新日志

有关最近更改的更多信息，请参阅更新日志

贡献

有关详细信息，请参阅贡献指南

安全

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

致谢

许可证

MIT 许可证 (MIT)。有关更多信息，请参阅许可证文件

aanorbel / livewire-status-board

维护者

详细信息