feat: add util function for common keyboard event handling (#715)

* feat: add util function for better keyboard event handling

* chore: adjust

* chore: adjust

* add test case

* test case

* chore: adjust

Author: aojunhao123

src/KeyCode.ts

@@ -517,6 +517,26 @@ const KeyCode = {
         return false;
     }
   },
+
+  isEditableTarget: function isEditableTarget(e: KeyboardEvent) {
+    const target = e.target;
+
+    if (!(target instanceof HTMLElement)) {
+      return false;
+    }
+
+    const tagName = target.tagName;
+    if (
+      tagName === 'INPUT' ||
+      tagName === 'TEXTAREA' ||
+      tagName === 'SELECT' ||
+      target.isContentEditable
+    ) {
+      return true;
+    }
+
+    return false;
+  },
 };
 
 export default KeyCode;

tests/KeyCode.test.ts

@@ -0,0 +1,48 @@
+import KeyCode from '../src/KeyCode';
+import { createEvent } from '@testing-library/react';
+
+describe('KeyCode.isEditableTarget', () => {
+  it('check editable target', () => {
+    const eleList = [
+      {
+        element: 'window',
+        expected: false,
+      },
+      {
+        element: 'div',
+        expected: false,
+      },
+      {
+        element: 'input',
+        expected: true,
+      },
+      {
+        element: 'textarea',
+        expected: true,
+      },
+      {
+        element: 'select',
+        expected: true,
+      },
+      {
+        element: 'div',
+        isContentEditable: true,
+        expected: true,
+      },
+    ];
+
+    eleList.forEach(({ element, isContentEditable, expected }) => {
+      const target =
+        element === 'window' ? window : document.createElement(element);
+      if (isContentEditable) {
+        // mock isContentEditable cause JSDOM don't support it
+        Object.defineProperty(target, 'isContentEditable', { value: true });
+      }
+      const event = createEvent.keyDown(target) as KeyboardEvent;
+      target.dispatchEvent(event);
+      const result = KeyCode.isEditableTarget(event);
+
+      expect(result).toBe(expected);
+    });
+  });
+});