From 2755a0be42482870749d357d270ecc3b3a461ae7 Mon Sep 17 00:00:00 2001
From: Vildan Softic <vsoftic@ranorex.com>
Date: Thu, 13 Dec 2018 08:55:14 +0100
Subject: [PATCH] feat(keyboard): allow to configure keyevent type

when configuring the plugin one can pass the keyEvent as a setting, which accepts 'keyup' and 'keydown'.
Ported for v1
---
 src/dialog-renderer.ts            |  8 ++++++--
 src/dialog-settings.ts            |  9 +++++++++
 test/unit/dialog-renderer.spec.ts | 12 ++++++++++++
 3 files changed, 27 insertions(+), 2 deletions(-)

diff --git a/src/dialog-renderer.ts b/src/dialog-renderer.ts
index 22ab54e..9533e5f 100644
--- a/src/dialog-renderer.ts
+++ b/src/dialog-renderer.ts
@@ -80,7 +80,7 @@ export class DialogRenderer implements Renderer {
 
   public static trackController(dialogController: DialogController): void {
     if (!DialogRenderer.dialogControllers.length) {
-      DOM.addEventListener('keyup', DialogRenderer.keyboardEventHandler, false);
+      DOM.addEventListener(dialogController.settings.keyEvent || 'keyup', DialogRenderer.keyboardEventHandler, false);
     }
     DialogRenderer.dialogControllers.push(dialogController);
   }
@@ -91,7 +91,11 @@ export class DialogRenderer implements Renderer {
       DialogRenderer.dialogControllers.splice(i, 1);
     }
     if (!DialogRenderer.dialogControllers.length) {
-      DOM.removeEventListener('keyup', DialogRenderer.keyboardEventHandler, false);
+      DOM.removeEventListener(
+        dialogController.settings.keyEvent || 'keyup',
+        DialogRenderer.keyboardEventHandler,
+        false
+      );
     }
   }
 
diff --git a/src/dialog-settings.ts b/src/dialog-settings.ts
index 773d45f..ee7469a 100644
--- a/src/dialog-settings.ts
+++ b/src/dialog-settings.ts
@@ -2,6 +2,7 @@ import { Container } from 'aurelia-dependency-injection';
 import { ViewStrategy } from 'aurelia-templating';
 
 export type ActionKey = 'Escape' | 'Enter';
+export type KeyEventType = 'keyup' | 'keydown';
 
 /**
  * All available dialog settings.
@@ -52,6 +53,14 @@ export interface DialogSettings {
    */
   keyboard?: boolean | ActionKey | ActionKey[];
 
+  /**
+   * Determines which type of keyevent should be used to listen for
+   * ENTER and ESC keys
+   *
+   * Default: keyup
+   */
+  keyEvent?: KeyEventType;
+
   /**
    * When set to "true" allows for the dismissal of the dialog by clicking outside of it.
    */
diff --git a/test/unit/dialog-renderer.spec.ts b/test/unit/dialog-renderer.spec.ts
index e6f58d9..11fae38 100644
--- a/test/unit/dialog-renderer.spec.ts
+++ b/test/unit/dialog-renderer.spec.ts
@@ -209,6 +209,18 @@ describe('DialogRenderer', () => {
       expect(DialogRenderer.dialogControllers.length).toBe(2);
       done();
     });
+
+    it('sets ESC key event handler with custom event type', async done => {
+      spyOn(DOM, 'addEventListener');
+      const keyEvent = 'keydown';
+      const first = createRenderer({ keyEvent });
+      const last = createRenderer();
+      await show(done, first, last);
+      expect(DOM.addEventListener).toHaveBeenCalledWith(keyEvent, jasmine.any(Function), false);
+      expect((DOM.addEventListener as jasmine.Spy).calls.count()).toBe(1);
+      expect(DialogRenderer.dialogControllers.length).toBe(2);
+      done();
+    });
   });
 
   describe('on last closed dialog', () => {