From fbc9a39485a500f3589f3e87ef04fd2d3f5b43df Mon Sep 17 00:00:00 2001 From: John Livingston Date: Tue, 30 Jul 2024 12:54:05 +0200 Subject: [PATCH] Refactoring: moving the draggable code in a common class. --- .../notes/components/muc-notes-view.js | 39 +++- .../plugins/notes/templates/muc-note.js | 4 +- .../tasks/components/muc-task-lists-view.js | 157 ++------------- .../plugins/tasks/styles/muc-task-drag.scss | 27 --- .../plugins/tasks/templates/muc-task-list.js | 2 +- .../plugins/tasks/templates/muc-task.js | 4 +- .../shared/components/draggables/index.js | 189 ++++++++++++++++++ .../draggables/styles/draggables.scss | 19 ++ 8 files changed, 260 insertions(+), 181 deletions(-) delete mode 100644 conversejs/custom/plugins/tasks/styles/muc-task-drag.scss create mode 100644 conversejs/custom/shared/components/draggables/index.js create mode 100644 conversejs/custom/shared/components/draggables/styles/draggables.scss diff --git a/conversejs/custom/plugins/notes/components/muc-notes-view.js b/conversejs/custom/plugins/notes/components/muc-notes-view.js index 902bb356..f7e82a92 100644 --- a/conversejs/custom/plugins/notes/components/muc-notes-view.js +++ b/conversejs/custom/plugins/notes/components/muc-notes-view.js @@ -2,16 +2,14 @@ // // SPDX-License-Identifier: AGPL-3.0-only -import { CustomElement } from 'shared/components/element.js' import { api } from '@converse/headless' import tplMucNotes from '../templates/muc-notes' import { __ } from 'i18n' +import { DraggablesCustomElement } from '../../../shared/components/draggables/index.js' import '../styles/muc-notes.scss' -export default class MUCNotesView extends CustomElement { - currentDraggedNote = null - +export default class MUCNotesView extends DraggablesCustomElement { static get properties () { return { model: { type: Object, attribute: true }, @@ -27,16 +25,16 @@ export default class MUCNotesView extends CustomElement { return } + this.draggableTagName = 'livechat-converse-muc-note' + this.droppableTagNames = ['livechat-converse-muc-note'] + this.droppableAlwaysBottomTagNames = [] + // Adding or removing a new note: we must update. this.listenTo(this.model, 'add', () => this.requestUpdate()) this.listenTo(this.model, 'remove', () => this.requestUpdate()) this.listenTo(this.model, 'sort', () => this.requestUpdate()) - // this._handleDragStartBinded = this._handleDragStart.bind(this) - // this._handleDragOverBinded = this._handleDragOver.bind(this) - // this._handleDragLeaveBinded = this._handleDragLeave.bind(this) - // this._handleDragEndBinded = this._handleDragEnd.bind(this) - // this._handleDropBinded = this._handleDrop.bind(this) + await super.initialize() } render () { @@ -90,6 +88,29 @@ export default class MUCNotesView extends CustomElement { }) } } + + _dropDone (draggedEl, droppedOnEl, onTopHalf) { + super._dropDone(...arguments) + console.log('[livechat note drag&drop] Note dropped...') + + const note = draggedEl.model + if (!note) { + throw new Error('No model for the draggedEl') + } + const targetNote = droppedOnEl.model + if (!targetNote) { + throw new Error('No model for the droppedOnEl') + } + if (note === targetNote) { + console.log('[livechat note drag&drop] Note dropped on itself, nothing to do') + return + } + + let newOrder = targetNote.get('order') ?? 0 + if (!onTopHalf) { newOrder = Math.max(0, newOrder + 1) } + + this._saveOrders(this.model, note, newOrder) + } } api.elements.define('livechat-converse-muc-notes', MUCNotesView) diff --git a/conversejs/custom/plugins/notes/templates/muc-note.js b/conversejs/custom/plugins/notes/templates/muc-note.js index dde1ffec..0eebcd4b 100644 --- a/conversejs/custom/plugins/notes/templates/muc-note.js +++ b/conversejs/custom/plugins/notes/templates/muc-note.js @@ -11,7 +11,7 @@ export function tplMucNote (el, note) { return !el.edit ? html` -
+
${note.get('description') ?? ''}
` : html` -
+
${_tplNoteForm(note)}
diff --git a/conversejs/custom/plugins/tasks/components/muc-task-lists-view.js b/conversejs/custom/plugins/tasks/components/muc-task-lists-view.js index 7c0df41c..a04faa2e 100644 --- a/conversejs/custom/plugins/tasks/components/muc-task-lists-view.js +++ b/conversejs/custom/plugins/tasks/components/muc-task-lists-view.js @@ -2,17 +2,14 @@ // // SPDX-License-Identifier: AGPL-3.0-only -import { CustomElement } from 'shared/components/element.js' import { api } from '@converse/headless' import tplMucTaskLists from '../templates/muc-task-lists' import { __ } from 'i18n' +import { DraggablesCustomElement } from '../../../shared/components/draggables/index.js' import '../styles/muc-task-lists.scss' -import '../styles/muc-task-drag.scss' - -export default class MUCTaskListsView extends CustomElement { - currentDraggedTask = null +export default class MUCTaskListsView extends DraggablesCustomElement { static get properties () { return { model: { type: Object, attribute: true }, @@ -27,42 +24,22 @@ export default class MUCTaskListsView extends CustomElement { return } + this.draggableTagName = 'livechat-converse-muc-task' + this.droppableTagNames = ['livechat-converse-muc-task', 'livechat-converse-muc-task-list'] + this.droppableAlwaysBottomTagNames = ['livechat-converse-muc-task-list'] + // Adding or removing a new task list: we must update. this.listenTo(this.model, 'add', () => this.requestUpdate()) this.listenTo(this.model, 'remove', () => this.requestUpdate()) this.listenTo(this.model, 'sort', () => this.requestUpdate()) - this._handleDragStartBinded = this._handleDragStart.bind(this) - this._handleDragOverBinded = this._handleDragOver.bind(this) - this._handleDragLeaveBinded = this._handleDragLeave.bind(this) - this._handleDragEndBinded = this._handleDragEnd.bind(this) - this._handleDropBinded = this._handleDrop.bind(this) + return super.initialize() } render () { return tplMucTaskLists(this, this.model) } - connectedCallback () { - super.connectedCallback() - this.currentDraggedTask = null - this.addEventListener('dragstart', this._handleDragStartBinded) - this.addEventListener('dragover', this._handleDragOverBinded) - this.addEventListener('dragleave', this._handleDragLeaveBinded) - this.addEventListener('dragend', this._handleDragEndBinded) - this.addEventListener('drop', this._handleDropBinded) - } - - disconnectedCallback () { - super.disconnectedCallback() - this.currentDraggedTask = null - this.removeEventListener('dragstart', this._handleDragStartBinded) - this.removeEventListener('dragover', this._handleDragOverBinded) - this.removeEventListener('dragleave', this._handleDragLeaveBinded) - this.removeEventListener('dragend', this._handleDragEndBinded) - this.removeEventListener('drop', this._handleDropBinded) - } - async submitCreateTaskList (ev) { ev.preventDefault() @@ -96,15 +73,7 @@ export default class MUCTaskListsView extends CustomElement { } } - _getParentTaskEl (target) { - return target.closest?.('livechat-converse-muc-task') - } - - _getParentTaskOrTaskListEl (target) { - return target.closest?.('livechat-converse-muc-task, livechat-converse-muc-task-list') - } - - _isATaskEl (target) { + isATaskEl (target) { return target.nodeName?.toLowerCase() === 'livechat-converse-muc-task' } @@ -112,71 +81,18 @@ export default class MUCTaskListsView extends CustomElement { return target.nodeName?.toLowerCase() === 'livechat-converse-muc-task-list' } - _isOnTopHalf (ev, taskEl) { - const y = ev.clientY - const bounding = taskEl.getBoundingClientRect() - return (y <= bounding.y + (bounding.height / 2)) - } - - _resetDropOver () { - document.querySelectorAll('.livechat-drag-bottom-half, .livechat-drag-top-half').forEach( - el => el.classList.remove('livechat-drag-bottom-half', 'livechat-drag-top-half') - ) - } - - _handleDragStart (ev) { - // The draggable=true is on a livechat-converse-muc-task child - const possibleTaskEl = ev.target.parentElement - if (!this._isATaskEl(possibleTaskEl)) { return } - console.log('[livechat task drag&drop] Starting to drag a task...') - this.currentDraggedTask = possibleTaskEl - this._resetDropOver() - } - - _handleDragOver (ev) { - if (!this.currentDraggedTask) { return } - const taskOrTaskListEl = this._getParentTaskOrTaskListEl(ev.target) - if (!taskOrTaskListEl) { return } - - // https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/drop_event says we should preventDefault - ev.preventDefault() - - // Are we on the top or bottom part of the taskEl? - // Note: for task list, we always add the task in the task list, so no need to test here. - const topHalf = this._isATaskEl(taskOrTaskListEl) ? this._isOnTopHalf(ev, taskOrTaskListEl) : false - taskOrTaskListEl.classList.add(topHalf ? 'livechat-drag-top-half' : 'livechat-drag-bottom-half') - taskOrTaskListEl.classList.remove(topHalf ? 'livechat-drag-bottom-half' : 'livechat-drag-top-half') - } - - _handleDragLeave (ev) { - if (!this.currentDraggedTask) { return } - const taskOrTaskListEl = this._getParentTaskOrTaskListEl(ev.target) - if (!taskOrTaskListEl) { return } - taskOrTaskListEl.classList.remove('livechat-drag-bottom-half', 'livechat-drag-top-half') - } - - _handleDragEnd (_ev) { - this.currentDraggedTask = null - this._resetDropOver() - } - - _handleDrop (_ev) { - if (!this.currentDraggedTask) { return } - - const droppedOnEl = document.querySelector('.livechat-drag-bottom-half, .livechat-drag-top-half') - const droppedOntaskOrTaskListEl = this._getParentTaskOrTaskListEl(droppedOnEl) - if (!droppedOntaskOrTaskListEl) { return } - + _dropDone (draggedEl, droppedOnEl, onTopHalf) { + super._dropDone(...arguments) console.log('[livechat task drag&drop] Task dropped...') - const task = this.currentDraggedTask.model + const task = draggedEl.model let newOrder, targetTasklist - if (this.isATaskListEl(droppedOntaskOrTaskListEl)) { + if (this.isATaskListEl(droppedOnEl)) { // We dropped on a task list, we must add as first entry. newOrder = 0 - targetTasklist = droppedOntaskOrTaskListEl.model + targetTasklist = droppedOnEl.model if (task.get('list') !== targetTasklist.get('id')) { console.log('[livechat task drag&drop] Changing task list...') task.set('list', targetTasklist.get('id')) @@ -185,9 +101,9 @@ export default class MUCTaskListsView extends CustomElement { console.log('[livechat task drag&drop] Task dropped on tasklist, but already first item, nothing to do') return } - } else if (this._isATaskEl(droppedOntaskOrTaskListEl)) { + } else if (this.isATaskEl(droppedOnEl)) { // We dropped on a task, we must get its order (+1 if !onTopHalf) - const droppedOnTask = droppedOntaskOrTaskListEl.model + const droppedOnTask = droppedOnEl.model if (task === droppedOnTask) { // But of course, if dropped on itself there is nothing to do. console.log('[livechat task drag&drop] Task dropped on itself, nothing to do') @@ -199,9 +115,8 @@ export default class MUCTaskListsView extends CustomElement { task.set('list', droppedOnTask.get('list')) } - const topHalf = droppedOnEl.classList.contains('livechat-drag-top-half') newOrder = droppedOnTask.get('order') ?? 0 - if (!topHalf) { newOrder = Math.max(0, newOrder + 1) } + if (!onTopHalf) { newOrder = Math.max(0, newOrder + 1) } if (typeof newOrder !== 'number' || isNaN(newOrder)) { console.error( @@ -217,45 +132,7 @@ export default class MUCTaskListsView extends CustomElement { return } - if (typeof newOrder !== 'number' || isNaN(newOrder)) { - console.error('[livechat task drag&drop] Computed new order is not a number, aborting.') - return - } - console.log('[livechat task drag&drop] Task new order will be ' + newOrder) - - console.log('[livechat task drag&drop] Reordering tasks...') - let currentOrder = newOrder + 1 - for (const t of targetTasklist.getTasks()) { - if (t === task) { - console.log('[livechat task drag&drop] Skipping the currently moved task') - continue - } - - let order = t.get('order') ?? 0 - if (typeof order !== 'number' || isNaN(order)) { - console.error('[livechat task drag&drop] Found a task with an invalid order, fixing it.') - order = currentOrder // this will cause the code bellow to increment task order - } - if (order < newOrder) { continue } - - currentOrder++ - if (order > currentOrder) { - console.log( - `Task "${t.get('name')}" as already on order greater than ${currentOrder.toString()}, stoping.` - ) - break - } - - console.log(`Changing order of task "${t.get('name')}" to ${currentOrder}`) - t.set('order', currentOrder) - t.saveItem() // TODO: handle errors? - } - - console.log('[livechat task drag&drop] Setting new order on the moved task') - task.set('order', newOrder) - task.saveItem() // TODO: handle errors? - - this._resetDropOver() + this._saveOrders(targetTasklist.getTasks(), task, newOrder) } } diff --git a/conversejs/custom/plugins/tasks/styles/muc-task-drag.scss b/conversejs/custom/plugins/tasks/styles/muc-task-drag.scss deleted file mode 100644 index 60904a3d..00000000 --- a/conversejs/custom/plugins/tasks/styles/muc-task-drag.scss +++ /dev/null @@ -1,27 +0,0 @@ -/* - * SPDX-FileCopyrightText: 2024 John Livingston - * - * SPDX-License-Identifier: AGPL-3.0-only - */ - -.conversejs { - livechat-converse-muc-task { - &.livechat-drag-bottom-half .task-line { - border-bottom: 4px solid blue; - } - - &.livechat-drag-top-half .task-line { - border-top: 4px solid blue; - } - } - - livechat-converse-muc-task-list { - &.livechat-drag-bottom-half .task-list-line { - border-bottom: 4px solid blue; - } - - &.livechat-drag-top-half .task-list-line { - border-top: 4px solid blue; - } - } -} diff --git a/conversejs/custom/plugins/tasks/templates/muc-task-list.js b/conversejs/custom/plugins/tasks/templates/muc-task-list.js index d226211f..cc93ea81 100644 --- a/conversejs/custom/plugins/tasks/templates/muc-task-list.js +++ b/conversejs/custom/plugins/tasks/templates/muc-task-list.js @@ -16,7 +16,7 @@ export default function tplMucTaskList (el, tasklist) { // eslint-disable-next-line no-undef const i18nTaskListName = __(LOC_task_list_name) return html` -
+
${el.collapsed ? html`