handsontable 0.0.0-next-9059914-20231025 → 0.0.0-next-cecf979-20231026

package/plugins/contextMenu/menu/shortcuts.js

@@ -0,0 +1,114 @@
+"use strict";
+
+exports.__esModule = true;
+exports.createKeyboardShortcutsCtrl = createKeyboardShortcutsCtrl;
+require("core-js/modules/es.array.push.js");
+var _defaultShortcutsList = require("./defaultShortcutsList");
+const SHORTCUTS_CONTEXT = 'menu';
+const SHORTCUTS_GROUP = SHORTCUTS_CONTEXT;
+
+/**
+ * @typedef KeyboardShortcutsMenuController
+ * @property {function(KeyboardShortcut[]): void} addCustomShortcuts Adds (by replacing) new keyboard shortcuts to the menu.
+ * @property {function(string): number} getContext Gets the keyboard shortcuts context by name.
+ * @property {function(string): void} listen Sets the active keyboard shortcuts context of the menu.
+ */
+/**
+ * Creates the controller object that allows extending the keyboard shortcuts of the menu.
+ *
+ * @param {Menu} menu The menu instance.
+ * @param {Array<{ shortcuts: KeyboardShortcut, contextName: string }>} [customKeyboardShortcuts] The list of the custom keyboard shortcuts.
+ * @returns {KeyboardShortcutsMenuController}
+ */
+function createKeyboardShortcutsCtrl(menu) {
+  let customKeyboardShortcuts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+  const customShortcuts = [];
+  _addShortcuts((0, _defaultShortcutsList.createDefaultShortcutsList)(menu));
+  customKeyboardShortcuts.forEach(_ref => {
+    let {
+      shortcuts,
+      contextName
+    } = _ref;
+    addCustomShortcuts(shortcuts, contextName);
+  });
+
+  /**
+   * Adds keyboard shortcuts to the menu.
+   *
+   * @param {KeyboardShortcut[]} shortcuts Keyboard shortcuts to add.
+   * @param {string} [contextName] The context name to create or use.
+   */
+  function _addShortcuts(shortcuts, contextName) {
+    getContext(contextName).addShortcuts(shortcuts, {
+      group: SHORTCUTS_CONTEXT
+    });
+  }
+
+  /**
+   * Adds custom keyboard shortcuts to the menu.
+   *
+   * @param {KeyboardShortcut[]} shortcuts Keyboard shortcuts to add.
+   * @param {string} [contextName] The context name to create or use.
+   */
+  function addCustomShortcuts(shortcuts, contextName) {
+    const context = getContext(contextName);
+    shortcuts.forEach(_ref2 => {
+      let {
+        keys
+      } = _ref2;
+      keys.forEach(k => context.removeShortcutsByKeys(k));
+    });
+    customShortcuts.push({
+      shortcuts,
+      contextName
+    });
+    _addShortcuts(shortcuts, contextName);
+  }
+
+  /**
+   * Gets all registered custom keyboard shortcuts.
+   *
+   * @returns {Array<{ shortcuts: KeyboardShortcut, contextName: string }>}
+   */
+  function getCustomShortcuts() {
+    return [...customShortcuts];
+  }
+
+  /**
+   * Gets the context name.
+   *
+   * @param {string} contextName The context name.
+   * @returns {string}
+   */
+  function _getContextName(contextName) {
+    return contextName ? `${SHORTCUTS_GROUP}:${contextName}` : SHORTCUTS_GROUP;
+  }
+
+  /**
+   * Gets the keyboard shortcut context by its name.
+   *
+   * @param {string} contextName The context name.
+   * @returns {object}
+   */
+  function getContext(contextName) {
+    var _manager$getContext;
+    const manager = menu.hotMenu.getShortcutManager();
+    const name = _getContextName(contextName);
+    return (_manager$getContext = manager.getContext(name)) !== null && _manager$getContext !== void 0 ? _manager$getContext : manager.addContext(name);
+  }
+
+  /**
+   * Makes the specified context active.
+   *
+   * @param {string} contextName The context name.
+   */
+  function listen(contextName) {
+    menu.hotMenu.getShortcutManager().setActiveContextName(_getContextName(contextName));
+  }
+  return {
+    addCustomShortcuts,
+    getCustomShortcuts,
+    getContext,
+    listen
+  };
+}

package/plugins/contextMenu/menu/shortcuts.mjs

@@ -0,0 +1,110 @@
+import "core-js/modules/es.array.push.js";
+import { createDefaultShortcutsList } from "./defaultShortcutsList.mjs";
+const SHORTCUTS_CONTEXT = 'menu';
+const SHORTCUTS_GROUP = SHORTCUTS_CONTEXT;
+
+/**
+ * @typedef KeyboardShortcutsMenuController
+ * @property {function(KeyboardShortcut[]): void} addCustomShortcuts Adds (by replacing) new keyboard shortcuts to the menu.
+ * @property {function(string): number} getContext Gets the keyboard shortcuts context by name.
+ * @property {function(string): void} listen Sets the active keyboard shortcuts context of the menu.
+ */
+/**
+ * Creates the controller object that allows extending the keyboard shortcuts of the menu.
+ *
+ * @param {Menu} menu The menu instance.
+ * @param {Array<{ shortcuts: KeyboardShortcut, contextName: string }>} [customKeyboardShortcuts] The list of the custom keyboard shortcuts.
+ * @returns {KeyboardShortcutsMenuController}
+ */
+export function createKeyboardShortcutsCtrl(menu) {
+  let customKeyboardShortcuts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+  const customShortcuts = [];
+  _addShortcuts(createDefaultShortcutsList(menu));
+  customKeyboardShortcuts.forEach(_ref => {
+    let {
+      shortcuts,
+      contextName
+    } = _ref;
+    addCustomShortcuts(shortcuts, contextName);
+  });
+
+  /**
+   * Adds keyboard shortcuts to the menu.
+   *
+   * @param {KeyboardShortcut[]} shortcuts Keyboard shortcuts to add.
+   * @param {string} [contextName] The context name to create or use.
+   */
+  function _addShortcuts(shortcuts, contextName) {
+    getContext(contextName).addShortcuts(shortcuts, {
+      group: SHORTCUTS_CONTEXT
+    });
+  }
+
+  /**
+   * Adds custom keyboard shortcuts to the menu.
+   *
+   * @param {KeyboardShortcut[]} shortcuts Keyboard shortcuts to add.
+   * @param {string} [contextName] The context name to create or use.
+   */
+  function addCustomShortcuts(shortcuts, contextName) {
+    const context = getContext(contextName);
+    shortcuts.forEach(_ref2 => {
+      let {
+        keys
+      } = _ref2;
+      keys.forEach(k => context.removeShortcutsByKeys(k));
+    });
+    customShortcuts.push({
+      shortcuts,
+      contextName
+    });
+    _addShortcuts(shortcuts, contextName);
+  }
+
+  /**
+   * Gets all registered custom keyboard shortcuts.
+   *
+   * @returns {Array<{ shortcuts: KeyboardShortcut, contextName: string }>}
+   */
+  function getCustomShortcuts() {
+    return [...customShortcuts];
+  }
+
+  /**
+   * Gets the context name.
+   *
+   * @param {string} contextName The context name.
+   * @returns {string}
+   */
+  function _getContextName(contextName) {
+    return contextName ? `${SHORTCUTS_GROUP}:${contextName}` : SHORTCUTS_GROUP;
+  }
+
+  /**
+   * Gets the keyboard shortcut context by its name.
+   *
+   * @param {string} contextName The context name.
+   * @returns {object}
+   */
+  function getContext(contextName) {
+    var _manager$getContext;
+    const manager = menu.hotMenu.getShortcutManager();
+    const name = _getContextName(contextName);
+    return (_manager$getContext = manager.getContext(name)) !== null && _manager$getContext !== void 0 ? _manager$getContext : manager.addContext(name);
+  }
+
+  /**
+   * Makes the specified context active.
+   *
+   * @param {string} contextName The context name.
+   */
+  function listen(contextName) {
+    menu.hotMenu.getShortcutManager().setActiveContextName(_getContextName(contextName));
+  }
+  return {
+    addCustomShortcuts,
+    getCustomShortcuts,
+    getContext,
+    listen
+  };
+}

package/plugins/contextMenu/menu/utils.js

@@ -0,0 +1,177 @@
+"use strict";
+
+exports.__esModule = true;
+exports.filterSeparators = filterSeparators;
+exports.hasSubMenu = hasSubMenu;
+exports.isDisabled = isDisabled;
+exports.isItemDisabled = isItemDisabled;
+exports.isItemHidden = isItemHidden;
+exports.isItemSelectionDisabled = isItemSelectionDisabled;
+exports.isItemSeparator = isItemSeparator;
+exports.isItemSubMenu = isItemSubMenu;
+exports.isSelectionDisabled = isSelectionDisabled;
+exports.isSeparator = isSeparator;
+exports.normalizeSelection = normalizeSelection;
+require("core-js/modules/es.array.push.js");
+var _array = require("../../../helpers/array");
+var _object = require("../../../helpers/object");
+var _element = require("../../../helpers/dom/element");
+var _predefinedItems = require("./../predefinedItems");
+/**
+ * @param {CellRange[]} selRanges An array of the cell ranges.
+ * @returns {object[]}
+ */
+function normalizeSelection(selRanges) {
+  return (0, _array.arrayMap)(selRanges, range => ({
+    start: range.getTopStartCorner(),
+    end: range.getBottomEndCorner()
+  }));
+}
+
+/**
+ * Check if the provided element is a submenu opener.
+ *
+ * @param {object} itemToTest Item element.
+ * @returns {boolean}
+ */
+function isItemSubMenu(itemToTest) {
+  return (0, _object.hasOwnProperty)(itemToTest, 'submenu');
+}
+
+/**
+ * Check if the provided element is a menu separator.
+ *
+ * @param {object} itemToTest Item element.
+ * @returns {boolean}
+ */
+function isItemSeparator(itemToTest) {
+  return new RegExp(_predefinedItems.SEPARATOR, 'i').test(itemToTest.name);
+}
+
+/**
+ * Check if the provided element presents the disabled menu item.
+ *
+ * @param {object} itemToTest Item element.
+ * @param {object} hot The context for the item function.
+ * @returns {boolean}
+ */
+function isItemDisabled(itemToTest, hot) {
+  return itemToTest.disabled === true || typeof itemToTest.disabled === 'function' && itemToTest.disabled.call(hot) === true;
+}
+
+/**
+ * Check if the provided element presents the disabled selection menu item.
+ *
+ * @param {object} itemToTest Item element.
+ * @returns {boolean}
+ */
+function isItemSelectionDisabled(itemToTest) {
+  return (0, _object.hasOwnProperty)(itemToTest, 'disableSelection');
+}
+
+/**
+ * @param {HTMLElement} cell The HTML cell element to check.
+ * @returns {boolean}
+ */
+function isSeparator(cell) {
+  return (0, _element.hasClass)(cell, 'htSeparator');
+}
+
+/**
+ * @param {HTMLElement} cell The HTML cell element to check.
+ * @returns {boolean}
+ */
+function hasSubMenu(cell) {
+  return (0, _element.hasClass)(cell, 'htSubmenu');
+}
+
+/**
+ * @param {HTMLElement} cell The HTML cell element to check.
+ * @returns {boolean}
+ */
+function isDisabled(cell) {
+  return (0, _element.hasClass)(cell, 'htDisabled');
+}
+
+/**
+ * @param {HTMLElement} cell The HTML cell element to check.
+ * @returns {boolean}
+ */
+function isSelectionDisabled(cell) {
+  return (0, _element.hasClass)(cell, 'htSelectionDisabled');
+}
+
+/**
+ * @param {object} item The object which describes the context menu item properties.
+ * @param {Core} instance The Handsontable instance.
+ * @returns {boolean}
+ */
+function isItemHidden(item, instance) {
+  return !item.hidden || !(typeof item.hidden === 'function' && item.hidden.call(instance));
+}
+
+/**
+ * @param {object[]} items The context menu items collection.
+ * @param {string} separator The string which identifies the context menu separator item.
+ * @returns {object[]}
+ */
+function shiftSeparators(items, separator) {
+  const result = items.slice(0);
+  for (let i = 0; i < result.length;) {
+    if (result[i].name === separator) {
+      result.shift();
+    } else {
+      break;
+    }
+  }
+  return result;
+}
+
+/**
+ * @param {object[]} items The context menu items collection.
+ * @param {string} separator The string which identifies the context menu separator item.
+ * @returns {object[]}
+ */
+function popSeparators(items, separator) {
+  let result = items.slice(0);
+  result.reverse();
+  result = shiftSeparators(result, separator);
+  result.reverse();
+  return result;
+}
+
+/**
+ * Removes duplicated menu separators from the context menu items collection.
+ *
+ * @param {object[]} items The context menu items collection.
+ * @returns {object[]}
+ */
+function removeDuplicatedSeparators(items) {
+  const result = [];
+  (0, _array.arrayEach)(items, (value, index) => {
+    if (index > 0) {
+      if (result[result.length - 1].name !== value.name) {
+        result.push(value);
+      }
+    } else {
+      result.push(value);
+    }
+  });
+  return result;
+}
+
+/**
+ * Removes menu separators from the context menu items collection.
+ *
+ * @param {object[]} items The context menu items collection.
+ * @param {string} separator The string which identifies the context menu separator item.
+ * @returns {object[]}
+ */
+function filterSeparators(items) {
+  let separator = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _predefinedItems.SEPARATOR;
+  let result = items.slice(0);
+  result = shiftSeparators(result, separator);
+  result = popSeparators(result, separator);
+  result = removeDuplicatedSeparators(result);
+  return result;
+}

package/plugins/contextMenu/menu/utils.mjs

@@ -0,0 +1,163 @@
+import "core-js/modules/es.array.push.js";
+import { arrayEach, arrayMap } from "../../../helpers/array.mjs";
+import { hasOwnProperty } from "../../../helpers/object.mjs";
+import { hasClass } from "../../../helpers/dom/element.mjs";
+import { SEPARATOR } from "./../predefinedItems/index.mjs";
+/**
+ * @param {CellRange[]} selRanges An array of the cell ranges.
+ * @returns {object[]}
+ */
+export function normalizeSelection(selRanges) {
+  return arrayMap(selRanges, range => ({
+    start: range.getTopStartCorner(),
+    end: range.getBottomEndCorner()
+  }));
+}
+
+/**
+ * Check if the provided element is a submenu opener.
+ *
+ * @param {object} itemToTest Item element.
+ * @returns {boolean}
+ */
+export function isItemSubMenu(itemToTest) {
+  return hasOwnProperty(itemToTest, 'submenu');
+}
+
+/**
+ * Check if the provided element is a menu separator.
+ *
+ * @param {object} itemToTest Item element.
+ * @returns {boolean}
+ */
+export function isItemSeparator(itemToTest) {
+  return new RegExp(SEPARATOR, 'i').test(itemToTest.name);
+}
+
+/**
+ * Check if the provided element presents the disabled menu item.
+ *
+ * @param {object} itemToTest Item element.
+ * @param {object} hot The context for the item function.
+ * @returns {boolean}
+ */
+export function isItemDisabled(itemToTest, hot) {
+  return itemToTest.disabled === true || typeof itemToTest.disabled === 'function' && itemToTest.disabled.call(hot) === true;
+}
+
+/**
+ * Check if the provided element presents the disabled selection menu item.
+ *
+ * @param {object} itemToTest Item element.
+ * @returns {boolean}
+ */
+export function isItemSelectionDisabled(itemToTest) {
+  return hasOwnProperty(itemToTest, 'disableSelection');
+}
+
+/**
+ * @param {HTMLElement} cell The HTML cell element to check.
+ * @returns {boolean}
+ */
+export function isSeparator(cell) {
+  return hasClass(cell, 'htSeparator');
+}
+
+/**
+ * @param {HTMLElement} cell The HTML cell element to check.
+ * @returns {boolean}
+ */
+export function hasSubMenu(cell) {
+  return hasClass(cell, 'htSubmenu');
+}
+
+/**
+ * @param {HTMLElement} cell The HTML cell element to check.
+ * @returns {boolean}
+ */
+export function isDisabled(cell) {
+  return hasClass(cell, 'htDisabled');
+}
+
+/**
+ * @param {HTMLElement} cell The HTML cell element to check.
+ * @returns {boolean}
+ */
+export function isSelectionDisabled(cell) {
+  return hasClass(cell, 'htSelectionDisabled');
+}
+
+/**
+ * @param {object} item The object which describes the context menu item properties.
+ * @param {Core} instance The Handsontable instance.
+ * @returns {boolean}
+ */
+export function isItemHidden(item, instance) {
+  return !item.hidden || !(typeof item.hidden === 'function' && item.hidden.call(instance));
+}
+
+/**
+ * @param {object[]} items The context menu items collection.
+ * @param {string} separator The string which identifies the context menu separator item.
+ * @returns {object[]}
+ */
+function shiftSeparators(items, separator) {
+  const result = items.slice(0);
+  for (let i = 0; i < result.length;) {
+    if (result[i].name === separator) {
+      result.shift();
+    } else {
+      break;
+    }
+  }
+  return result;
+}
+
+/**
+ * @param {object[]} items The context menu items collection.
+ * @param {string} separator The string which identifies the context menu separator item.
+ * @returns {object[]}
+ */
+function popSeparators(items, separator) {
+  let result = items.slice(0);
+  result.reverse();
+  result = shiftSeparators(result, separator);
+  result.reverse();
+  return result;
+}
+
+/**
+ * Removes duplicated menu separators from the context menu items collection.
+ *
+ * @param {object[]} items The context menu items collection.
+ * @returns {object[]}
+ */
+function removeDuplicatedSeparators(items) {
+  const result = [];
+  arrayEach(items, (value, index) => {
+    if (index > 0) {
+      if (result[result.length - 1].name !== value.name) {
+        result.push(value);
+      }
+    } else {
+      result.push(value);
+    }
+  });
+  return result;
+}
+
+/**
+ * Removes menu separators from the context menu items collection.
+ *
+ * @param {object[]} items The context menu items collection.
+ * @param {string} separator The string which identifies the context menu separator item.
+ * @returns {object[]}
+ */
+export function filterSeparators(items) {
+  let separator = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : SEPARATOR;
+  let result = items.slice(0);
+  result = shiftSeparators(result, separator);
+  result = popSeparators(result, separator);
+  result = removeDuplicatedSeparators(result);
+  return result;
+}

package/plugins/contextMenu/predefinedItems/alignment.js

@@ -23,6 +23,13 @@ function alignmentItem() {
       if (this.countRows() === 0 || this.countCols() === 0) {
         return true;
       }
+      const range = this.getSelectedRangeLast();
+      if (!range) {
+        return true;
+      }
+      if (range.isSingleHeader()) {
+        return true;
+      }
       return !(this.getSelectedRange() && !this.selection.isSelectedByCorner());
     },
     submenu: {

package/plugins/contextMenu/predefinedItems/alignment.mjs

@@ -16,6 +16,13 @@ export default function alignmentItem() {
       if (this.countRows() === 0 || this.countCols() === 0) {
         return true;
       }
+      const range = this.getSelectedRangeLast();
+      if (!range) {
+        return true;
+      }
+      if (range.isSingleHeader()) {
+        return true;
+      }
       return !(this.getSelectedRange() && !this.selection.isSelectedByCorner());
     },
     submenu: {

package/plugins/contextMenu/predefinedItems/clearColumn.js

@@ -2,7 +2,6 @@
 
 exports.__esModule = true;
 exports.default = clearColumnItem;
-var _utils = require("../utils");
 var C = _interopRequireWildcard(require("../../../i18n/constants"));
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
@@ -26,8 +25,11 @@ function clearColumnItem() {
       }
     },
     disabled() {
-      const selected = (0, _utils.getValidSelection)(this);
-      if (!selected) {
+      const range = this.getSelectedRangeLast();
+      if (!range) {
+        return true;
+      }
+      if (range.isSingleHeader() && range.highlight.col < 0) {
         return true;
       }
       return !this.selection.isSelectedByColumnHeader();

package/plugins/contextMenu/predefinedItems/clearColumn.mjs

@@ -1,4 +1,3 @@
-import { getValidSelection } from "../utils.mjs";
 import * as C from "../../../i18n/constants.mjs";
 export const KEY = 'clear_column';
 
@@ -19,8 +18,11 @@ export default function clearColumnItem() {
       }
     },
     disabled() {
-      const selected = getValidSelection(this);
-      if (!selected) {
+      const range = this.getSelectedRangeLast();
+      if (!range) {
+        return true;
+      }
+      if (range.isSingleHeader() && range.highlight.col < 0) {
         return true;
       }
       return !this.selection.isSelectedByColumnHeader();

package/plugins/contextMenu/predefinedItems/columnLeft.js

@@ -2,7 +2,6 @@
 
 exports.__esModule = true;
 exports.default = columnLeftItem;
-var _utils = require("../utils");
 var C = _interopRequireWildcard(require("../../../i18n/constants"));
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
@@ -27,8 +26,11 @@ function columnLeftItem() {
       if (!this.isColumnModificationAllowed()) {
         return true;
       }
-      const selected = (0, _utils.getValidSelection)(this);
-      if (!selected) {
+      const range = this.getSelectedRangeLast();
+      if (!range) {
+        return true;
+      }
+      if (range.isSingleHeader() && range.highlight.col < 0) {
         return true;
       }
       if (this.selection.isSelectedByCorner()) {

package/plugins/contextMenu/predefinedItems/columnLeft.mjs

@@ -1,4 +1,3 @@
-import { getValidSelection } from "../utils.mjs";
 import * as C from "../../../i18n/constants.mjs";
 export const KEY = 'col_left';
 
@@ -20,8 +19,11 @@ export default function columnLeftItem() {
       if (!this.isColumnModificationAllowed()) {
         return true;
       }
-      const selected = getValidSelection(this);
-      if (!selected) {
+      const range = this.getSelectedRangeLast();
+      if (!range) {
+        return true;
+      }
+      if (range.isSingleHeader() && range.highlight.col < 0) {
         return true;
       }
       if (this.selection.isSelectedByCorner()) {