[FEATURE] Introduce hotkeys to scheduler task editing

Similar to editing regular content elements, it is now possible to save scheduler tasks being edited via keyboard shortcuts as well. Resolves: #103563 Releases: main Change-Id: Ia159293670f3f3dc762f3c23da35e0e71d5541fd Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/83702 Reviewed-by: Andreas Kienast <a.fernandez@scripting-base.de> Tested-by: Stefan Bürk <stefan@buerk.tech> Reviewed-by: Stefan Bürk <stefan@buerk.tech> Tested-by: core-ci <typo3@b13.com> Tested-by: Garvin Hicking <gh@faktor-e.de> Tested-by: Andreas Kienast <a.fernandez@scripting-base.de> Reviewed-by: Garvin Hicking <gh@faktor-e.de>
TYPO3 · Apr 8, 2024 · 8f0662e · 8f0662e
1 parent e8e7d2a
commit 8f0662e
Show file tree

Hide file tree

Showing 3 changed files with 85 additions and 6 deletions.
diff --git a/Build/Sources/TypeScript/scheduler/scheduler.ts b/Build/Sources/TypeScript/scheduler/scheduler.ts
@@ -23,6 +23,7 @@ import { MultiRecordSelectionSelectors } from '@typo3/backend/multi-record-selec
 import Severity from '@typo3/backend/severity';
 import DocumentService from '@typo3/core/document-service';
 import SubmitInterceptor from '@typo3/backend/form/submit-interceptor';
+import Hotkeys, { ModifierKeys } from '@typo3/backend/hotkeys';
 
 interface TableNumberMapping {
   [s: string]: number;
@@ -37,6 +38,7 @@ class Scheduler {
     DocumentService.ready().then((): void => {
       this.initializeSubmitInterceptor();
       this.initializeEvents();
+      this.registerHotKeys();
       this.initializeDefaultStates();
       this.initializeCloseConfirm();
     });
@@ -245,12 +247,12 @@ class Scheduler {
     new RegularEvent('click', (e: Event): void => {
       e.preventDefault();
 
-      this.saveDocument(e);
+      this.saveDocument(e.target as HTMLElement);
     }).delegateTo(document, 'button[form]');
   }
 
-  private saveDocument(e: Event): void {
-    const schedulerForm: HTMLFormElement = document.querySelector('form[name=tx_scheduler_form]');
+  private saveDocument(submitter?: HTMLElement): void {
+    const schedulerForm = this.getTaskEditForm();
     if (!schedulerForm) {
       return;
     }
@@ -261,7 +263,55 @@ class Scheduler {
     hidden.name = 'CMD';
 
     schedulerForm.append(hidden);
-    schedulerForm.requestSubmit(e.target as HTMLElement);
+    schedulerForm.requestSubmit(submitter);
+  }
+
+  private saveAndCloseDocument(submitter?: HTMLElement): void {
+    const schedulerForm = this.getTaskEditForm();
+    if (!schedulerForm) {
+      return;
+    }
+
+    const hidden = document.createElement('input')
+    hidden.type = 'hidden';
+    hidden.value = 'saveclose';
+    hidden.name = 'CMD';
+
+    schedulerForm.append(hidden);
+    schedulerForm.requestSubmit(submitter);
+  }
+
+  private registerHotKeys(): void {
+    const form = this.getTaskEditForm();
+    if (form === null) {
+      return;
+    }
+
+    let submitterElement = null;
+    if (form.CMD instanceof HTMLElement) {
+      submitterElement = form.CMD;
+    } else if (form.CMD instanceof NodeList) {
+      submitterElement = form.CMD.item(0) as HTMLButtonElement;
+    }
+
+    Hotkeys.setScope('scheduler/edit-task');
+    Hotkeys.register([Hotkeys.normalizedCtrlModifierKey, 's'], (e: KeyboardEvent): void => {
+      e.preventDefault();
+
+      this.saveDocument(submitterElement);
+    }, {
+      scope: 'scheduler/edit-task',
+      allowOnEditables: true,
+      bindElement: submitterElement,
+    });
+    Hotkeys.register([Hotkeys.normalizedCtrlModifierKey, ModifierKeys.SHIFT, 's'], (e: KeyboardEvent): void => {
+      e.preventDefault();
+
+      this.saveAndCloseDocument(submitterElement);
+    }, {
+      scope: 'scheduler/edit-task',
+      allowOnEditables: true,
+    });
   }
 
   /**
@@ -346,7 +396,7 @@ class Scheduler {
   }
 
   private initializeCloseConfirm() {
-    const schedulerForm: HTMLFormElement = document.querySelector('form[name=tx_scheduler_form]');
+    const schedulerForm = this.getTaskEditForm();
     if(!schedulerForm) {
       return;
     }
@@ -404,6 +454,10 @@ class Scheduler {
       }
     })
   }
+
+  private getTaskEditForm(): HTMLFormElement|null {
+    return document.querySelector('form[name=tx_scheduler_form]');
+  }
 }
 
 export default new Scheduler();
diff --git a/...ngelog/13.1/Feature-103563-AddSaving-relatedHotkeysToSchedulerBackendModule.rst b/...ngelog/13.1/Feature-103563-AddSaving-relatedHotkeysToSchedulerBackendModule.rst
@@ -0,0 +1,25 @@
+.. include:: /Includes.rst.txt
+
+.. _feature-103563-1712569921:
+
+=========================================================================
+Feature: #103563 - Add saving-related hotkeys to scheduler backend module
+=========================================================================
+
+See :issue:`103563`
+
+Description
+===========
+
+Similar to editing regular content elements, it is now possible to save
+scheduler tasks being edited via keyboard shortcuts as well.
+
+
+Impact
+======
+
+It is possible to invoke the :kbd:`Ctrl`/:kbd:`Cmd` + :kbd:`s` hotkey to save a
+scheduler task, altogether with the hotkey :kbd:`Ctrl`/:kbd:`Cmd` + :kbd:`Shift` + :kbd:`S`
+to save and close a scheduler task.
+
+.. index:: Backend, JavaScript, ext:scheduler