vikunja-frontend/src/views/list/views/Kanban.vue

<template>
	<div class="kanban-view">
		<div class="filter-container" v-if="isSavedFilter">
			<div class="items">
				<x-button
					@click.prevent.stop="toggleFilterPopup"
					icon="filter"
					type="secondary"
				>
					{{ $t('filters.title') }}
				</x-button>
			</div>
			<filter-popup
				:visible="showFilters"
				v-model="params"
			/>
		</div>
		<div
			:class="{ 'is-loading': loading && !oneTaskUpdating}"
			class="kanban kanban-bucket-container loader-container"
		>
			<draggable
				v-bind="dragOptions"
				:modelValue="buckets"
				@update:modelValue="updateBuckets"
				@end="updateBucketPosition"
				@start="() => dragBucket = true"
				group="buckets"
				:disabled="!canWrite"
				tag="transition-group"
				:item-key="({id}) => `bucket${id}`"
				:component-data="bucketDraggableComponentData"
			>
				<template #item="{element: bucket, index: bucketIndex }">
					<div
						class="bucket"
						:class="{'is-collapsed': collapsedBuckets[bucket.id]}"
					>
						<div class="bucket-header" @click="() => unCollapseBucket(bucket)">
							<span
								v-if="bucket.isDoneBucket"
								class="icon is-small has-text-success mr-2"
								v-tooltip="$t('list.kanban.doneBucketHint')"
							>
								<icon icon="check-double"/>
							</span>
							<h2
								@keydown.enter.prevent.stop="$event.target.blur()"
								@keydown.esc.prevent.stop="$event.target.blur()"
								@blur="saveBucketTitle(bucket.id, $event.target.textContent)"
								@click="focusBucketTitle"
								class="title input"
								:contenteditable="bucketTitleEditable && canWrite && !collapsedBuckets[bucket.id]"
								spellcheck="false">{{ bucket.title }}</h2>
							<span
								:class="{'is-max': bucket.tasks.length >= bucket.limit}"
								class="limit"
								v-if="bucket.limit > 0">
								{{ bucket.tasks.length }}/{{ bucket.limit }}
							</span>
							<dropdown
								class="is-right options"
								v-if="canWrite && !collapsedBuckets[bucket.id]"
								trigger-icon="ellipsis-v"
								@close="() => showSetLimitInput = false"
							>
								<a
									@click.stop="showSetLimitInput = true"
									class="dropdown-item"
								>
									<div class="field has-addons" v-if="showSetLimitInput">
										<div class="control">
											<input
												@keyup.esc="() => showSetLimitInput = false"
												@keyup.enter="() => showSetLimitInput = false"
												:value="bucket.limit"
												@input="(event) => setBucketLimit(bucket.id, parseInt(event.target.value))"
												class="input"
												type="number"
												min="0"
												v-focus.always
											/>
										</div>
										<div class="control">
											<x-button
												:disabled="bucket.limit < 0"
												:icon="['far', 'save']"
												:shadow="false"
											/>
										</div>
									</div>
									<template v-else>
										{{
											$t('list.kanban.limit', {limit: bucket.limit > 0 ? bucket.limit : $t('list.kanban.noLimit')})
										}}
									</template>
								</a>
								<a
									@click.stop="toggleDoneBucket(bucket)"
									class="dropdown-item"
									v-tooltip="$t('list.kanban.doneBucketHintExtended')"
								>
									<span class="icon is-small" :class="{'has-text-success': bucket.isDoneBucket}">
										<icon icon="check-double"/>
									</span>
									{{ $t('list.kanban.doneBucket') }}
								</a>
								<a
									class="dropdown-item"
									@click.stop="() => collapseBucket(bucket)"
								>
									{{ $t('list.kanban.collapse') }}
								</a>
								<a
									:class="{'is-disabled': buckets.length <= 1}"
									@click.stop="() => deleteBucketModal(bucket.id)"
									class="dropdown-item has-text-danger"
									v-tooltip="buckets.length <= 1 ? $t('list.kanban.deleteLast') : ''"
								>
									<span class="icon is-small">
										<icon icon="trash-alt"/>
									</span>
									{{ $t('misc.delete') }}
								</a>
							</dropdown>
						</div>
						<div
							:ref="(el) => setTaskContainerRef(bucket.id, el)"
							@scroll="($event) => handleTaskContainerScroll(bucket.id, bucket.listId, $event.target)"
							class="tasks"
						>
							<draggable
								v-bind="dragOptions"
								:modelValue="bucket.tasks"
								@update:modelValue="(tasks) => updateTasks(bucket.id, tasks)"
								@start="() => dragstart(bucket)"
								@end="updateTaskPosition"
								:group="{name: 'tasks', put: shouldAcceptDrop(bucket) && !dragBucket}"
								:disabled="!canWrite"
								:data-bucket-index="bucketIndex"
								tag="transition-group"
								:item-key="(task) => `bucket${bucket.id}-task${task.id}`"
								:component-data="taskDraggableTaskComponentData"
							>
								<template #item="{element: task}">
									<kanban-card :task="task" />
								</template>
							</draggable>
						</div>
						<div class="bucket-footer" v-if="canWrite">
							<div class="field" v-if="showNewTaskInput[bucket.id]">
								<div class="control" :class="{'is-loading': loading}">
									<input
										class="input"
										:disabled="loading || null"
										@focusout="toggleShowNewTaskInput(bucket.id)"
										@keyup.enter="addTaskToBucket(bucket.id)"
										@keyup.esc="toggleShowNewTaskInput(bucket.id)"
										:placeholder="$t('list.kanban.addTaskPlaceholder')"
										type="text"
										v-focus.always
										v-model="newTaskText"
									/>
								</div>
								<p class="help is-danger" v-if="newTaskError[bucket.id] && newTaskText === ''">
									{{ $t('list.create.addTitleRequired') }}
								</p>
							</div>
							<x-button
								@click="toggleShowNewTaskInput(bucket.id)"
								class="is-transparent is-fullwidth has-text-centered"
								:shadow="false"
								v-if="!showNewTaskInput[bucket.id]"
								icon="plus"
								type="secondary"
							>
								{{
									bucket.tasks.length === 0 ? $t('list.kanban.addTask') : $t('list.kanban.addAnotherTask')
								}}
							</x-button>
						</div>
					</div>
				</template>
			</draggable>

			<div class="bucket new-bucket" v-if="canWrite && !loading && buckets.length > 0">
				<input
					:class="{'is-loading': loading}"
					:disabled="loading || null"
					@blur="() => showNewBucketInput = false"
					@keyup.enter="createNewBucket"
					@keyup.esc="$event.target.blur()"
					class="input"
					:placeholder="$t('list.kanban.addBucketPlaceholder')"
					type="text"
					v-focus.always
					v-if="showNewBucketInput"
					v-model="newBucketTitle"
				/>
				<x-button
					@click="() => showNewBucketInput = true"
					:shadow="false"
					class="is-transparent is-fullwidth has-text-centered"
					v-else
					type="secondary"
					icon="plus"
				>
					{{ $t('list.kanban.addBucket') }}
				</x-button>
			</div>
		</div>

		<!-- This router view is used to show the task popup while keeping the kanban board itself -->
		<router-view v-slot="{ Component }">
			<transition name="modal">
				<component :is="Component" />
			</transition>
		</router-view>

		<transition name="modal">
			<modal
				@close="showBucketDeleteModal = false"
				@submit="deleteBucket()"
				v-if="showBucketDeleteModal"
			>
				<template #header><span>{{ $t('list.kanban.deleteHeaderBucket') }}</span></template>
		
				<template #text>
					<p>{{ $t('list.kanban.deleteBucketText1') }}<br/>
					{{ $t('list.kanban.deleteBucketText2') }}</p>
				</template>
			</modal>
		</transition>
	</div>
</template>

<script>
import draggable from 'vuedraggable'

import BucketModel from '../../../models/bucket'
import {mapState} from 'vuex'
import {saveListView} from '@/helpers/saveListView'
import Rights from '../../../models/constants/rights.json'
import {LOADING, LOADING_MODULE} from '@/store/mutation-types'
import FilterPopup from '@/components/list/partials/filter-popup.vue'
import Dropdown from '@/components/misc/dropdown.vue'
import {getCollapsedBucketState, saveCollapsedBucketState} from '@/helpers/saveCollapsedBucketState'
import {calculateItemPosition} from '../../../helpers/calculateItemPosition'
import KanbanCard from '@/components/tasks/partials/kanban-card'

const DRAG_OPTIONS = {
	// sortable options
	animation: 150,
	ghostClass: 'ghost',
	dragClass: 'task-dragging',
	delayOnTouchOnly: true,
	delay: 150,
}

const MIN_SCROLL_HEIGHT_PERCENT = 0.25

export default {
	name: 'Kanban',
	components: {
		KanbanCard,
		Dropdown,
		FilterPopup,
		draggable,
	},
	data() {
		return {
			taskContainerRefs: {},

			dragOptions: DRAG_OPTIONS,

			drag: false,
			dragBucket: false,
			sourceBucket: 0,

			showBucketDeleteModal: false,
			bucketToDelete: 0,
			bucketTitleEditable: false,

			newTaskText: '',
			showNewTaskInput: {},
			newBucketTitle: '',
			showNewBucketInput: false,
			newTaskError: {},
			showSetLimitInput: false,
			collapsedBuckets: {},

			// We're using this to show the loading animation only at the task when updating it
			taskUpdating: {},
			oneTaskUpdating: false,

			params: {
				filter_by: [],
				filter_value: [],
				filter_comparator: [],
				filter_concat: 'and',
			},
			showFilters: false,
		}
	},
	created() {
		// Save the current list view to local storage
		// We use local storage and not vuex here to make it persistent across reloads.
		saveListView(this.$route.params.listId, this.$route.name)
	},
	watch: {
		loadBucketParameter: {
			handler: 'loadBuckets',
			immediate: true,
		},
	},
	computed: {
		isSavedFilter() {
			return this.list.isSavedFilter && !this.list.isSavedFilter()
		},
		loadBucketParameter() {
			return {
				listId: this.$route.params.listId,
				params: this.params,
			}
		},
		bucketDraggableComponentData() {
			return {
				type: 'transition',
				tag: 'div',
				name: !this.dragBucket ? 'move-bucket': null,
				class: [
					'kanban-bucket-container',
					{ 'dragging-disabled': !this.canWrite },
				],
			}
		},
		taskDraggableTaskComponentData() {
			return {
				type: 'transition',
				tag: 'div',
				name: !this.drag ? 'move-card': null,
				class: [
					'dropper',
					{ 'dragging-disabled': !this.canWrite },
				],
			}
		},
		buckets() {
			return this.$store.state.kanban.buckets
		},
		...mapState({
			loadedListId: state => state.kanban.listId,
			loading: state => state[LOADING] && state[LOADING_MODULE] === 'kanban',
			taskLoading: state => state[LOADING] && state[LOADING_MODULE] === 'tasks',
			canWrite: state => state.currentList.maxRight > Rights.READ,
			list: state => state.currentList,
		}),
	},
 
	methods: {
		toggleFilterPopup() {
			this.showFilters = !this.showFilters
		},

		loadBuckets() {
			// Prevent trying to load buckets if the task popup view is active
			if (this.$route.name !== 'list.kanban') {
				return
			}

			const { listId, params } = this.loadBucketParameter

			this.collapsedBuckets = getCollapsedBucketState(listId)

			console.debug(`Loading buckets, loadedListId = ${this.loadedListId}, $route.params =`, this.$route.params)

			this.$store.dispatch('kanban/loadBucketsForList', {listId, params})
		},

		setTaskContainerRef(id, el) {
			if (!el) return
			this.taskContainerRefs[id] = el
		},

		handleTaskContainerScroll(id, listId, el) {
			if (!el) {
				return
			}
			const scrollTopMax = el.scrollHeight - el.clientHeight
			const threshold = el.scrollTop + el.scrollTop * MIN_SCROLL_HEIGHT_PERCENT
			if (scrollTopMax > threshold) {
				return
			}

			this.$store.dispatch('kanban/loadNextTasksForBucket', {
				listId: listId,
				params: this.params,
				bucketId: id,
			})
		},

		updateTasks(bucketId, tasks) {
			const newBucket = {
				...this.$store.getters['kanban/getBucketById'](bucketId),
				tasks,
			}

			this.$store.dispatch('kanban/updateBucket', newBucket)
		},

		updateTaskPosition(e) {
			this.drag = false

			// While we could just pass the bucket index in through the function call, this would not give us the 
			// new bucket id when a task has been moved between buckets, only the new bucket. Using the data-bucket-id
			// of the drop target works all the time.
			const bucketIndex = parseInt(e.to.dataset.bucketIndex)

			const newBucket = this.buckets[bucketIndex]
			const task = newBucket.tasks[e.newIndex]
			const taskBefore = newBucket.tasks[e.newIndex - 1] ?? null
			const taskAfter = newBucket.tasks[e.newIndex + 1] ?? null

			const newTask = {
				...task,
				bucketId: newBucket.id,
				kanbanPosition: calculateItemPosition(taskBefore !== null ? taskBefore.kanbanPosition : null, taskAfter !== null ? taskAfter.kanbanPosition : null),
			}

			this.$store.dispatch('tasks/update', newTask)
				// .finally(() => {
					this.taskUpdating[task.id] = false
					this.oneTaskUpdating = false
				// })
		},
		toggleShowNewTaskInput(bucketId) {
			this.showNewTaskInput[bucketId] = !this.showNewTaskInput[bucketId]
		},
		addTaskToBucket(bucketId) {

			if (this.newTaskText === '') {
				this.newTaskError[bucketId] = true
				return
			}
			this.newTaskError[bucketId] = false

			this.$store.dispatch('tasks/createNewTask', {
				title: this.newTaskText,
				bucketId,
				listId: this.$route.params.listId,
			})
				.then(r => {
					this.newTaskText = ''
					this.$store.commit('kanban/addTaskToBucket', r)
					this.scrollTaskContainerToBottom(bucketId)
				})
		},
		scrollTaskContainerToBottom(bucketId) {
			const bucketEl = this.taskContainerRefs[bucketId]
			if (!bucketEl) {
				return
			}
			bucketEl.scrollTop = bucketEl.scrollHeight
		},
		createNewBucket() {
			if (this.newBucketTitle === '') {
				return
			}

			const newBucket = new BucketModel({
				title: this.newBucketTitle,
				listId: parseInt(this.$route.params.listId),
			})

			this.$store.dispatch('kanban/createBucket', newBucket)
				.then(() => {
					this.newBucketTitle = ''
					this.showNewBucketInput = false
				})
		},
		deleteBucketModal(bucketId) {
			if (this.buckets.length <= 1) {
				return
			}

			this.bucketToDelete = bucketId
			this.showBucketDeleteModal = true
		},
		deleteBucket() {
			this.$store.dispatch('kanban/deleteBucket', {bucket: {
				id: this.bucketToDelete,
				listId: parseInt(this.$route.params.listId),
			}, params: this.params})
				.then(() => this.$message.success({message: this.$t('list.kanban.deleteBucketSuccess')}))
				.finally(() => {
					this.showBucketDeleteModal = false
				})
		},
		focusBucketTitle(e) {
			// This little helper allows us to drag a bucket around at the title without focusing on it right away.
			this.bucketTitleEditable = true
			this.$nextTick(() => e.target.focus())
		},

		saveBucketTitle(bucketId, bucketTitle) {
			const updatedBucketData = {
				id: bucketId,
				title: bucketTitle,
			}

			this.$store.dispatch('kanban/updateBucketTitle', updatedBucketData)
				.then(() => {
					this.bucketTitleEditable = false
					this.$message.success({message: this.$t('list.kanban.bucketTitleSavedSuccess')})
				})
		},

		updateBuckets(value) {
			// (1) buckets get updated in store and tasks positions get invalidated
			this.$store.commit('kanban/setBuckets', value)
		},

		updateBucketPosition(e) {
			// (2) bucket positon is changed
			this.dragBucket = false

			const bucket = this.buckets[e.newIndex]
			const bucketBefore = this.buckets[e.newIndex - 1] ?? null
			const bucketAfter = this.buckets[e.newIndex + 1] ?? null

			const updatedData = {
				id: bucket.id,
				position: calculateItemPosition(bucketBefore !== null ? bucketBefore.position : null, bucketAfter !== null ? bucketAfter.position : null),
			}

			this.$store.dispatch('kanban/updateBucket', updatedData)
		},
		setBucketLimit(bucketId, limit) {
			if (limit < 0) {
				return
			}

			const newBucket = {
				...this.$store.getters['kanban/getBucketById'](bucketId),
				limit,
			}

			this.$store.dispatch('kanban/updateBucket', newBucket)
				.then(() => this.$message.success({message: this.$t('list.kanban.bucketLimitSavedSuccess')}))
			
		},
		shouldAcceptDrop(bucket) {
			return bucket.id === this.sourceBucket || // When dragging from a bucket who has its limit reached, dragging should still be possible
				bucket.limit === 0 || // If there is no limit set, dragging & dropping should always work
				bucket.tasks.length < bucket.limit // Disallow dropping to buckets which have their limit reached
		},
		dragstart(bucket) {
			this.drag = true
			this.sourceBucket = bucket.id
		},
		toggleDoneBucket(bucket) {
			const newBucket = {
				...bucket,
				isDoneBucket: !bucket.isDoneBucket,
			}
			this.$store.dispatch('kanban/updateBucket', newBucket)
				.then(() => this.$message.success({message: this.$t('list.kanban.doneBucketSavedSuccess')}))
				.catch(e => this.$message.error(e))
		},
		collapseBucket(bucket) {
			this.collapsedBuckets[bucket.id] = true
			saveCollapsedBucketState(this.$route.params.listId, this.collapsedBuckets)
		},
		unCollapseBucket(bucket) {
			if (!this.collapsedBuckets[bucket.id]) {
				return
			}

			this.collapsedBuckets[bucket.id] = false
			saveCollapsedBucketState(this.$route.params.listId, this.collapsedBuckets)
		},
	},
}
</script>