From 7f6f8963e7db236f3beb9e6a36fab4ba479b969b Mon Sep 17 00:00:00 2001
From: konrad <k@knt.li>
Date: Wed, 7 Sep 2022 17:55:59 +0000
Subject: [PATCH] feat: add keyboard shortcut to toggle task description edit
 (#2332)

Co-authored-by: kolaente <k@knt.li>
Reviewed-on: https://kolaente.dev/vikunja/frontend/pulls/2332
Reviewed-by: Dominik Pschenitschni <dpschen@noreply.kolaente.de>
---
 src/components/input/editor.vue               | 33 ++++++++++++++++---
 .../misc/keyboard-shortcuts/shortcuts.ts      |  4 +++
 src/components/tasks/partials/description.vue |  1 +
 src/directives/shortcut.ts                    |  3 ++
 src/i18n/lang/en.json                         |  3 +-
 5 files changed, 39 insertions(+), 5 deletions(-)

diff --git a/src/components/input/editor.vue b/src/components/input/editor.vue
index ab4383fa..e2ec5d66 100644
--- a/src/components/input/editor.vue
+++ b/src/components/input/editor.vue
@@ -16,14 +16,29 @@
 		<p class="has-text-centered has-text-grey is-italic my-5" v-if="showPreviewText">
 			{{ emptyText }}
 			<template v-if="isEditEnabled">
-				<ButtonLink @click="toggleEdit" class="d-print-none">{{ $t('input.editor.edit') }}</ButtonLink>.
+				<ButtonLink
+					@click="toggleEdit"
+					v-shortcut="editShortcut"
+					class="d-print-none">
+					{{ $t('input.editor.edit') }}
+				</ButtonLink>.
 			</template>
 		</p>
 
 		<ul class="actions d-print-none" v-if="bottomActions.length > 0">
 			<li v-if="isEditEnabled && !showPreviewText && showSave">
-				<BaseButton v-if="showEditButton" @click="toggleEdit">{{ $t('input.editor.edit') }}</BaseButton>
-				<BaseButton v-else-if="isEditActive" @click="toggleEdit" class="done-edit">{{ $t('misc.save') }}</BaseButton>
+				<BaseButton
+					v-if="showEditButton"
+					@click="toggleEdit"
+					v-shortcut="editShortcut">
+					{{ $t('input.editor.edit') }}
+				</BaseButton>
+				<BaseButton
+					v-else-if="isEditActive"
+					@click="toggleEdit"
+					class="done-edit">
+					{{ $t('misc.save') }}
+				</BaseButton>
 			</li>
 			<li v-for="(action, k) in bottomActions" :key="k">
 				<BaseButton @click="action.action">{{ action.title }}</BaseButton>
@@ -32,7 +47,11 @@
 		<template v-else-if="isEditEnabled && showSave">
 			<ul v-if="showEditButton" class="actions d-print-none">
 				<li>
-					<BaseButton @click="toggleEdit">{{ $t('input.editor.edit') }}</BaseButton>
+					<BaseButton
+						@click="toggleEdit"
+						v-shortcut="editShortcut">
+						{{ $t('input.editor.edit') }}
+					</BaseButton>
 				</li>
 			</ul>
 			<x-button
@@ -110,6 +129,12 @@ export default defineComponent({
 			type: Boolean,
 			default: false,
 		},
+		// If a key is passed the editor will go in "edit" mode when the key is pressed.
+		// Disabled if an empty string is passed.
+		editShortcut: {
+			type: String,
+			default: '',
+		},
 	},
 	emits: ['update:modelValue', 'change'],
 	computed: {
diff --git a/src/components/misc/keyboard-shortcuts/shortcuts.ts b/src/components/misc/keyboard-shortcuts/shortcuts.ts
index b51e4f8c..2a3423fd 100644
--- a/src/components/misc/keyboard-shortcuts/shortcuts.ts
+++ b/src/components/misc/keyboard-shortcuts/shortcuts.ts
@@ -136,6 +136,10 @@ export const KEYBOARD_SHORTCUTS : ShortcutGroup[] = [
 				title: 'keyboardShortcuts.task.reminder',
 				keys: ['alt', 'r'],
 			},
+			{
+				title: 'keyboardShortcuts.task.description',
+				keys: ['e'],
+			},
 		],
 	},
 ]
diff --git a/src/components/tasks/partials/description.vue b/src/components/tasks/partials/description.vue
index c2623c9e..7eca6931 100644
--- a/src/components/tasks/partials/description.vue
+++ b/src/components/tasks/partials/description.vue
@@ -24,6 +24,7 @@
 			:placeholder="$t('task.description.placeholder')"
 			:empty-text="$t('task.description.empty')"
 			:show-save="true"
+			edit-shortcut="e"
 			v-model="task.description"
 		/>
 	</div>
diff --git a/src/directives/shortcut.ts b/src/directives/shortcut.ts
index 842e05ec..001ed960 100644
--- a/src/directives/shortcut.ts
+++ b/src/directives/shortcut.ts
@@ -4,6 +4,9 @@ import {isAppleDevice} from '@/helpers/isAppleDevice'
 
 const directive: Directive = {
 	mounted(el, {value}) {
+		if(value === '') {
+			return
+		}
 		if (isAppleDevice() && value.includes('Control')) {
 			value = value.replace('Control', 'Meta')
 		}
diff --git a/src/i18n/lang/en.json b/src/i18n/lang/en.json
index 7158efcd..0653cfcf 100644
--- a/src/i18n/lang/en.json
+++ b/src/i18n/lang/en.json
@@ -873,7 +873,8 @@
       "related": "Modify related tasks of this task",
       "color": "Change the color of this task",
       "move": "Move this task to another list",
-      "reminder": "Manage reminders of this task"
+      "reminder": "Manage reminders of this task",
+      "description": "Toggle editing of the task description"
     },
     "list": {
       "title": "List Views",