Livewire Sortable

A plugin/wrapper around Shopify's sortable package. It makes implementing sortable interfaces super simple using Livewire.

Installation

CDN

<scriptsrc="https://cdn.jsdelivr.net/gh/livewire/sortable@v0.x.x/dist/livewire-sortable.js"></script>

NPM

npm install livewire-sortable --save-dev

Import the package in your bundle:

import 'livewire-sortable'
// Or.
require('livewire-sortable')

Usage

For simple layouts that only require simple sorting like a todo list, add the wire:sortable, wire:sortable.item, and wire:sortable.handle attributes to your markup as follows.

<ulwire:sortable="updateTaskOrder">
@foreach ($tasks as $task)
<liwire:sortable.item="{{ $task->id }}" wire:key="task-{{ $task->id }}"><h4wire:sortable.handle>{{ $task->title }}</h4><buttonwire:click="removeTask({{ $task->id }})">Remove</button></li>
@endforeach
</ul>

For creating a nested layout with draggable groups with draggable items inside each group, similar to Trello, add the wire:sortable, wire:sortable-group, wire:sortable.item, wire:sortable.handle, wire:sortable-group.item-group, and wire:sortable-group.item attributes to your markup as follows.

<divwire:sortable="updateGroupOrder" wire:sortable-group="updateTaskOrder" style="display: flex">
@foreach ($groups as $group)
<divwire:key="group-{{ $group->id }}" wire:sortable.item="{{ $group->id }}"><divstyle="display: flex"><h4wire:sortable.handle>{{ $group->label }}</h4><buttonwire:click="removeGroup({{ $group->id }})">Remove</button></div><ulwire:sortable-group.item-group="{{ $group->id }}">
@foreach ($group->tasks()->orderBy('order')->get() as $task)
<liwire:key="task-{{ $task->id }}" wire:sortable-group.item="{{ $task->id }}">
{{ $task->title }}
<buttonwire:click="removeTask({{ $task->id }})">Remove</button></li>
@endforeach
</ul><formwire:submit.prevent="addTask({{ $group->id }}, $event.target.title.value)"><inputtype="text" name="title"><button>Add Task</button></form></div>
@endforeach
<formwire:submit.prevent="addGroup"><inputtype="text" wire:model="newGroupLabel"><button>Add Task Group</button></form></div>

Styling

If you want to add your own styles to elements during various "draggable" states (like adding a shadow to an item while dragging), reference Shopify's Draggable/Sortable plugin's docs directly: https://github.com/Shopify/draggable/blob/58d79dc9fb5b82271c5dfec74a5c9207cfab01f5/src/Draggable/README.md#classes