handsontable 11.0.0 → 12.0.0

package/shortcuts/recorder.mjs

@@ -0,0 +1,171 @@
+import "core-js/modules/es.array.includes.js";
+import "core-js/modules/es.array.concat.js";
+import "core-js/modules/es.string.includes.js";
+import { createKeysObserver } from "./keyObserver.mjs";
+import { normalizeEventKey } from "./utils.mjs";
+import { isImmediatePropagationStopped } from "../helpers/dom/event.mjs";
+import { isMacOS } from "../helpers/browser.mjs";
+var MODIFIER_KEYS = ['meta', 'alt', 'shift', 'control'];
+var modifierKeysObserver = createKeysObserver();
+/* eslint-disable jsdoc/require-description-complete-sentence */
+
+/**
+ * A key recorder, used for tracking key events.
+ *
+ * @param {EventTarget} ownerWindow A starting `window` element
+ * @param {Function} beforeKeyDown A hook fired before the `keydown` event is handled. You can use it to [block a keyboard shortcut's actions](@/guides/accessories-and-menus/keyboard-shortcuts.md#blocking-a-keyboard-shortcut-s-actions).
+ * @param {Function} afterKeyDown A hook fired after the `keydown` event is handled
+ * @param {Function} callback `KeyEvent`'s listener's callback function
+ * @returns {object}
+ */
+
+export function useRecorder(ownerWindow, beforeKeyDown, afterKeyDown, callback) {
+  /**
+   * Check if a pressed key is tracked or not.
+   *
+   * @param {string} pressedKey A pressed key
+   * @returns {boolean}
+   */
+  var isModifierKey = function isModifierKey(pressedKey) {
+    return MODIFIER_KEYS.includes(pressedKey);
+  };
+  /**
+   * Get every pressed modifier key from the performed `KeyboardEvent`.
+   *
+   * @private
+   * @param {KeyboardEvent} event The event object.
+   * @param {boolean} [mergeMetaKeys=false] If `true,` the function will return the "control" and "meta"
+   *                                        modifiers keys as the "control/meta" name. This allows creating
+   *                                        keyboard shortcuts with modifier key that trigger the shortcut
+   *                                        actions depend on the OS keyboard layout (the Meta key for macOS
+   *                                        and Control for non macOS system).
+   * @returns {string[]}
+   */
+
+
+  var getPressedModifierKeys = function getPressedModifierKeys(event) {
+    var mergeMetaKeys = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+    var pressedModifierKeys = [];
+
+    if (event.altKey) {
+      pressedModifierKeys.push('alt');
+    }
+
+    if (mergeMetaKeys && (event.ctrlKey || event.metaKey)) {
+      pressedModifierKeys.push('control/meta');
+    } else {
+      if (event.ctrlKey) {
+        pressedModifierKeys.push('control');
+      }
+
+      if (event.metaKey) {
+        pressedModifierKeys.push('meta');
+      }
+    }
+
+    if (event.shiftKey) {
+      pressedModifierKeys.push('shift');
+    }
+
+    return pressedModifierKeys;
+  };
+  /**
+   * `KeyboardEvent`'s callback function
+   *
+   * @private
+   * @param {KeyboardEvent} event The event object
+   */
+
+
+  var onkeydown = function onkeydown(event) {
+    var result = beforeKeyDown(event);
+
+    if (result === false || isImmediatePropagationStopped(event)) {
+      return;
+    }
+
+    var pressedKey = normalizeEventKey(event.key);
+    var extraModifierKeys = [];
+
+    if (isModifierKey(pressedKey)) {
+      modifierKeysObserver.press(pressedKey);
+    } else {
+      extraModifierKeys = getPressedModifierKeys(event);
+    }
+
+    var pressedKeys = [pressedKey].concat(extraModifierKeys);
+    var isExecutionCancelled = callback(event, pressedKeys);
+
+    if (!isExecutionCancelled && (isMacOS() && extraModifierKeys.includes('meta') || !isMacOS() && extraModifierKeys.includes('control'))) {
+      // Trigger the callback for the virtual OS-dependent "control/meta" key
+      callback(event, [pressedKey].concat(getPressedModifierKeys(event, true)));
+    }
+
+    afterKeyDown(event);
+  };
+  /**
+   * `KeyboardEvent`'s callback function
+   *
+   * @private
+   * @param {KeyboardEvent} event The event object
+   */
+
+
+  var onkeyup = function onkeyup(event) {
+    var pressedKey = normalizeEventKey(event.key);
+
+    if (isModifierKey(pressedKey) === false) {
+      return;
+    }
+
+    modifierKeysObserver.release(pressedKey);
+  };
+  /**
+   * `FocusEvent`'s callback function
+   *
+   * @private
+   */
+
+
+  var onblur = function onblur() {
+    modifierKeysObserver.releaseAll();
+  };
+  /**
+   * Add event listeners to the starting window and its parents' windows.
+   */
+
+
+  var mount = function mount() {
+    var eventTarget = ownerWindow;
+
+    while (eventTarget) {
+      eventTarget.addEventListener('keydown', onkeydown);
+      eventTarget.addEventListener('keyup', onkeyup);
+      eventTarget.addEventListener('blur', onblur);
+      eventTarget = eventTarget.frameElement;
+    }
+  };
+  /**
+   * Remove event listeners from the starting window and its parents' windows.
+   */
+
+
+  var unmount = function unmount() {
+    var eventTarget = ownerWindow;
+
+    while (eventTarget) {
+      eventTarget.removeEventListener('keydown', onkeydown);
+      eventTarget.removeEventListener('keyup', onkeyup);
+      eventTarget.removeEventListener('blur', onblur);
+      eventTarget = eventTarget.frameElement;
+    }
+  };
+
+  return {
+    mount: mount,
+    unmount: unmount,
+    isPressed: function isPressed(key) {
+      return modifierKeysObserver.isPressed(key);
+    }
+  };
+}

package/shortcuts/utils.js

@@ -0,0 +1,77 @@
+"use strict";
+
+exports.__esModule = true;
+exports.normalizeKeys = exports.normalizeEventKey = exports.getKeysList = void 0;
+
+require("core-js/modules/es.array.iterator.js");
+
+require("core-js/modules/es.map.js");
+
+require("core-js/modules/es.object.to-string.js");
+
+require("core-js/modules/es.string.iterator.js");
+
+require("core-js/modules/web.dom-collections.iterator.js");
+
+require("core-js/modules/es.array.join.js");
+
+require("core-js/modules/es.array.sort.js");
+
+require("core-js/modules/es.array.map.js");
+
+require("core-js/modules/es.regexp.exec.js");
+
+require("core-js/modules/es.string.split.js");
+
+// This file handles key-name discrepancies between browsers.
+// For the list of discrepancies, go to: https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values.
+var mappings = new Map([[' ', 'space'], // custom mapping
+['spacebar', 'space'], ['scroll', 'scrolllock'], ['del', 'delete'], ['esc', 'escape'], ['medianexttrack', 'mediatracknext'], ['mediaprevioustrack', 'mediatrackprevious'], ['volumeup', 'audiovolumeup'], ['volumedown', 'audiovolumedown'], ['volumemute', 'audiovolumemute'], ['multiply', '*'], ['add', '+'], ['divide', '/'], ['subtract', '-'], ['left', 'arrowleft'], ['right', 'arrowright'], ['up', 'arrowup'], ['down', 'arrowdown']]);
+/* eslint-disable jsdoc/require-description-complete-sentence */
+
+/**
+ * Get a single, normalized string from the list of the `KeyboardEvent.key` properties.
+ *
+ * @param {Array<string>} keys The list of the `KeyboardEvent.key` properties
+ * @returns {string}
+ */
+
+var normalizeKeys = function normalizeKeys(keys) {
+  return keys.map(function (key) {
+    var lowercaseKey = key.toLowerCase();
+
+    if (mappings.has(lowercaseKey)) {
+      return mappings.get(lowercaseKey);
+    }
+
+    return lowercaseKey;
+  }).sort().join('+');
+};
+/**
+ * Get the list of the `KeyboardEvent.key` properties from a single, normalized string.
+ *
+ * @param {string} normalizedKeys A single, normalized string that contains the list of the `KeyboardEvent.key` properties
+ * @returns {Array<string>}
+ */
+
+
+exports.normalizeKeys = normalizeKeys;
+
+var getKeysList = function getKeysList(normalizedKeys) {
+  return normalizedKeys.split('+');
+};
+/**
+ * Normalize a `KeyboardEvent.key` property, to use it for keyboard shortcuts.
+ *
+ * @param {string} key KeyboardEvent's key property.
+ * @returns {string}
+ */
+
+
+exports.getKeysList = getKeysList;
+
+var normalizeEventKey = function normalizeEventKey(key) {
+  return key.toLowerCase();
+};
+
+exports.normalizeEventKey = normalizeEventKey;

package/shortcuts/utils.mjs

@@ -0,0 +1,54 @@
+import "core-js/modules/es.array.iterator.js";
+import "core-js/modules/es.map.js";
+import "core-js/modules/es.object.to-string.js";
+import "core-js/modules/es.string.iterator.js";
+import "core-js/modules/web.dom-collections.iterator.js";
+import "core-js/modules/es.array.join.js";
+import "core-js/modules/es.array.sort.js";
+import "core-js/modules/es.array.map.js";
+import "core-js/modules/es.regexp.exec.js";
+import "core-js/modules/es.string.split.js";
+// This file handles key-name discrepancies between browsers.
+// For the list of discrepancies, go to: https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values.
+var mappings = new Map([[' ', 'space'], // custom mapping
+['spacebar', 'space'], ['scroll', 'scrolllock'], ['del', 'delete'], ['esc', 'escape'], ['medianexttrack', 'mediatracknext'], ['mediaprevioustrack', 'mediatrackprevious'], ['volumeup', 'audiovolumeup'], ['volumedown', 'audiovolumedown'], ['volumemute', 'audiovolumemute'], ['multiply', '*'], ['add', '+'], ['divide', '/'], ['subtract', '-'], ['left', 'arrowleft'], ['right', 'arrowright'], ['up', 'arrowup'], ['down', 'arrowdown']]);
+/* eslint-disable jsdoc/require-description-complete-sentence */
+
+/**
+ * Get a single, normalized string from the list of the `KeyboardEvent.key` properties.
+ *
+ * @param {Array<string>} keys The list of the `KeyboardEvent.key` properties
+ * @returns {string}
+ */
+
+export var normalizeKeys = function normalizeKeys(keys) {
+  return keys.map(function (key) {
+    var lowercaseKey = key.toLowerCase();
+
+    if (mappings.has(lowercaseKey)) {
+      return mappings.get(lowercaseKey);
+    }
+
+    return lowercaseKey;
+  }).sort().join('+');
+};
+/**
+ * Get the list of the `KeyboardEvent.key` properties from a single, normalized string.
+ *
+ * @param {string} normalizedKeys A single, normalized string that contains the list of the `KeyboardEvent.key` properties
+ * @returns {Array<string>}
+ */
+
+export var getKeysList = function getKeysList(normalizedKeys) {
+  return normalizedKeys.split('+');
+};
+/**
+ * Normalize a `KeyboardEvent.key` property, to use it for keyboard shortcuts.
+ *
+ * @param {string} key KeyboardEvent's key property.
+ * @returns {string}
+ */
+
+export var normalizeEventKey = function normalizeEventKey(key) {
+  return key.toLowerCase();
+};