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标签或包含语法即可

<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 sortablejs

安装完成后，在窗口对象中全局使用它们。这可以在与您的Laravel应用程序一起提供的bootstrap.js文件中完成。

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

行为和交互

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

在onStatusSorted中，您可以收到关于哪个record在其status中的位置发生了变化的通知。您还将收到一个包含排序后records的ID的$orderedIds数组。您必须覆盖以下方法来接收此更改的通知。

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

在onStatusChanged触发时，表示一个record被移动到另一个status。在这种情况下，您可以收到关于被更改的record、新的status、从上一个状态到新状态的排序ID以及即将进入的新状态的记录的通知。要接收此事件的通知，您必须覆盖以下方法

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

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

您还可以通过onRecordClick事件在状态板中点击记录时收到通知

public function onRecordClick($recordId)
{
    //
}

要启用onRecordClick，您必须在通过record-click-enabled参数渲染组件时指定此行为

<livewire:sales-orders-status-board 
    :record-click-enabled="true"
/>

样式

要修改组件的外观和感觉，您可以覆盖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 wrapper
    'recordContent' => '', // record content
];

以下是一个覆盖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['statusHeader'] = 'text-sm font-medium py-2 text-gray-700';

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

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

    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"
    record-content-view="path/to/your/record-content-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）。有关更多信息，请参阅许可文件

cristyanhenrich / livewire-kanban

维护者

详细信息