handsontable 0.0.0-next-010265d-20231005 → 0.0.0-next-9379dd1-20231020

package/plugins/contextMenu/menu/navigator.js

@@ -0,0 +1,152 @@
+"use strict";
+
+exports.__esModule = true;
+require("core-js/modules/es.error.cause.js");
+var _utils = require("./utils");
+function _classPrivateMethodInitSpec(obj, privateSet) { _checkPrivateRedeclaration(obj, privateSet); privateSet.add(obj); }
+function _classPrivateFieldInitSpec(obj, privateMap, value) { _checkPrivateRedeclaration(obj, privateMap); privateMap.set(obj, value); }
+function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
+function _classPrivateMethodGet(receiver, privateSet, fn) { if (!privateSet.has(receiver)) { throw new TypeError("attempted to get private field on non-instance"); } return fn; }
+function _classPrivateFieldGet(receiver, privateMap) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "get"); return _classApplyDescriptorGet(receiver, descriptor); }
+function _classApplyDescriptorGet(receiver, descriptor) { if (descriptor.get) { return descriptor.get.call(receiver); } return descriptor.value; }
+function _classPrivateFieldSet(receiver, privateMap, value) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "set"); _classApplyDescriptorSet(receiver, descriptor, value); return value; }
+function _classExtractFieldDescriptor(receiver, privateMap, action) { if (!privateMap.has(receiver)) { throw new TypeError("attempted to " + action + " private field on non-instance"); } return privateMap.get(receiver); }
+function _classApplyDescriptorSet(receiver, descriptor, value) { if (descriptor.set) { descriptor.set.call(receiver, value); } else { if (!descriptor.writable) { throw new TypeError("attempted to set read only private field"); } descriptor.value = value; } }
+/**
+ * Helper class that supports navigating throughout the menu and submenus.
+ *
+ * @private
+ * @class Navigator
+ */
+var _hotMenu = /*#__PURE__*/new WeakMap();
+var _current = /*#__PURE__*/new WeakMap();
+var _prev = /*#__PURE__*/new WeakMap();
+var _visited = /*#__PURE__*/new WeakMap();
+var _updateMenuSelection = /*#__PURE__*/new WeakSet();
+class Navigator {
+  constructor() {
+    /**
+     * Selects the menu based on the internal state of the class.
+     */
+    _classPrivateMethodInitSpec(this, _updateMenuSelection);
+    /**
+     * The instance of the Handsontable as menu.
+     *
+     * @type {Handsontable}
+     */
+    _classPrivateFieldInitSpec(this, _hotMenu, {
+      writable: true,
+      value: void 0
+    });
+    /**
+     * The index of the current selected menu item.
+     *
+     * @type {number}
+     */
+    _classPrivateFieldInitSpec(this, _current, {
+      writable: true,
+      value: -1
+    });
+    /**
+     * The index of the previously selected menu item.
+     *
+     * @type {number}
+     */
+    _classPrivateFieldInitSpec(this, _prev, {
+      writable: true,
+      value: -1
+    });
+    /**
+     * The collection of the already visited menu item indexes. The collection allows for preventing
+     * infinite loops in cases when all menu items are disabled, or there is only one item available
+     * and the navigation is triggered.
+     *
+     * @type {Set<number>}
+     */
+    _classPrivateFieldInitSpec(this, _visited, {
+      writable: true,
+      value: new Set()
+    });
+  }
+  /**
+   * Sets the menu Handsontable instance.
+   *
+   * @param {Handsontable} hotMenu The menu Handsontable instance.
+   */
+  setMenu(hotMenu) {
+    _classPrivateFieldSet(this, _hotMenu, hotMenu);
+  }
+
+  /**
+   * Selects the first menu item in the menu.
+   */
+  selectFirst() {
+    _classPrivateFieldGet(this, _visited).clear();
+    _classPrivateFieldSet(this, _current, 0);
+    _classPrivateFieldSet(this, _prev, _classPrivateFieldGet(this, _current) - 1);
+    _classPrivateMethodGet(this, _updateMenuSelection, _updateMenuSelection2).call(this);
+  }
+
+  /**
+   * Selects the last menu item in the menu.
+   */
+  selectLast() {
+    _classPrivateFieldGet(this, _visited).clear();
+    _classPrivateFieldSet(this, _current, _classPrivateFieldGet(this, _hotMenu).countRows() - 1);
+    _classPrivateFieldSet(this, _prev, _classPrivateFieldGet(this, _current) + 1);
+    _classPrivateMethodGet(this, _updateMenuSelection, _updateMenuSelection2).call(this);
+  }
+
+  /**
+   * Selects the next menu item in the menu. The navigator tries to select the closes non-disabled menu
+   * item. When all next items are disabled the first (or next non-disabled) menu item is selected.
+   */
+  selectNext() {
+    _classPrivateFieldGet(this, _visited).clear();
+    _classPrivateFieldSet(this, _current, _classPrivateFieldGet(this, _current) + 1);
+    _classPrivateMethodGet(this, _updateMenuSelection, _updateMenuSelection2).call(this);
+  }
+
+  /**
+   * Selects the previous menu item in the menu. The navigator tries to select the closes non-disabled menu
+   * item. When all previous items are disabled the last (or previous non-disabled) menu item is selected.
+   */
+  selectPrev() {
+    _classPrivateFieldGet(this, _visited).clear();
+    _classPrivateFieldSet(this, _current, _classPrivateFieldGet(this, _current) - 1);
+    _classPrivateMethodGet(this, _updateMenuSelection, _updateMenuSelection2).call(this);
+  }
+
+  /**
+   * Clears the internal state to the initial values.
+   */
+  clear() {
+    _classPrivateFieldGet(this, _visited).clear();
+    _classPrivateFieldSet(this, _prev, -1);
+    _classPrivateFieldSet(this, _current, -1);
+  }
+}
+exports.Navigator = Navigator;
+function _updateMenuSelection2() {
+  const maxItems = _classPrivateFieldGet(this, _hotMenu).countRows() - 1;
+  if (_classPrivateFieldGet(this, _current) < 0) {
+    _classPrivateFieldSet(this, _current, maxItems);
+    _classPrivateFieldSet(this, _prev, maxItems);
+  }
+  if (_classPrivateFieldGet(this, _current) > maxItems) {
+    _classPrivateFieldSet(this, _current, 0);
+    _classPrivateFieldSet(this, _prev, -1);
+  }
+  if (_classPrivateFieldGet(this, _visited).has(_classPrivateFieldGet(this, _current))) {
+    return;
+  }
+  const cell = _classPrivateFieldGet(this, _hotMenu).getCell(_classPrivateFieldGet(this, _current), 0);
+  _classPrivateFieldGet(this, _visited).add(_classPrivateFieldGet(this, _current));
+  if (!cell || (0, _utils.isSeparator)(cell) || (0, _utils.isDisabled)(cell) || (0, _utils.isSelectionDisabled)(cell)) {
+    _classPrivateFieldSet(this, _current, _classPrivateFieldGet(this, _current) + (_classPrivateFieldGet(this, _current) > _classPrivateFieldGet(this, _prev) ? 1 : -1));
+    _classPrivateMethodGet(this, _updateMenuSelection, _updateMenuSelection2).call(this);
+  } else {
+    _classPrivateFieldGet(this, _hotMenu).selectCell(_classPrivateFieldGet(this, _current), 0);
+  }
+  _classPrivateFieldSet(this, _prev, _classPrivateFieldGet(this, _current));
+}

package/plugins/contextMenu/menu/navigator.mjs

@@ -0,0 +1,148 @@
+import "core-js/modules/es.error.cause.js";
+function _classPrivateMethodInitSpec(obj, privateSet) { _checkPrivateRedeclaration(obj, privateSet); privateSet.add(obj); }
+function _classPrivateFieldInitSpec(obj, privateMap, value) { _checkPrivateRedeclaration(obj, privateMap); privateMap.set(obj, value); }
+function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
+function _classPrivateMethodGet(receiver, privateSet, fn) { if (!privateSet.has(receiver)) { throw new TypeError("attempted to get private field on non-instance"); } return fn; }
+function _classPrivateFieldGet(receiver, privateMap) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "get"); return _classApplyDescriptorGet(receiver, descriptor); }
+function _classApplyDescriptorGet(receiver, descriptor) { if (descriptor.get) { return descriptor.get.call(receiver); } return descriptor.value; }
+function _classPrivateFieldSet(receiver, privateMap, value) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "set"); _classApplyDescriptorSet(receiver, descriptor, value); return value; }
+function _classExtractFieldDescriptor(receiver, privateMap, action) { if (!privateMap.has(receiver)) { throw new TypeError("attempted to " + action + " private field on non-instance"); } return privateMap.get(receiver); }
+function _classApplyDescriptorSet(receiver, descriptor, value) { if (descriptor.set) { descriptor.set.call(receiver, value); } else { if (!descriptor.writable) { throw new TypeError("attempted to set read only private field"); } descriptor.value = value; } }
+import { isSeparator, isDisabled, isSelectionDisabled } from "./utils.mjs";
+/**
+ * Helper class that supports navigating throughout the menu and submenus.
+ *
+ * @private
+ * @class Navigator
+ */
+var _hotMenu = /*#__PURE__*/new WeakMap();
+var _current = /*#__PURE__*/new WeakMap();
+var _prev = /*#__PURE__*/new WeakMap();
+var _visited = /*#__PURE__*/new WeakMap();
+var _updateMenuSelection = /*#__PURE__*/new WeakSet();
+export class Navigator {
+  constructor() {
+    /**
+     * Selects the menu based on the internal state of the class.
+     */
+    _classPrivateMethodInitSpec(this, _updateMenuSelection);
+    /**
+     * The instance of the Handsontable as menu.
+     *
+     * @type {Handsontable}
+     */
+    _classPrivateFieldInitSpec(this, _hotMenu, {
+      writable: true,
+      value: void 0
+    });
+    /**
+     * The index of the current selected menu item.
+     *
+     * @type {number}
+     */
+    _classPrivateFieldInitSpec(this, _current, {
+      writable: true,
+      value: -1
+    });
+    /**
+     * The index of the previously selected menu item.
+     *
+     * @type {number}
+     */
+    _classPrivateFieldInitSpec(this, _prev, {
+      writable: true,
+      value: -1
+    });
+    /**
+     * The collection of the already visited menu item indexes. The collection allows for preventing
+     * infinite loops in cases when all menu items are disabled, or there is only one item available
+     * and the navigation is triggered.
+     *
+     * @type {Set<number>}
+     */
+    _classPrivateFieldInitSpec(this, _visited, {
+      writable: true,
+      value: new Set()
+    });
+  }
+  /**
+   * Sets the menu Handsontable instance.
+   *
+   * @param {Handsontable} hotMenu The menu Handsontable instance.
+   */
+  setMenu(hotMenu) {
+    _classPrivateFieldSet(this, _hotMenu, hotMenu);
+  }
+
+  /**
+   * Selects the first menu item in the menu.
+   */
+  selectFirst() {
+    _classPrivateFieldGet(this, _visited).clear();
+    _classPrivateFieldSet(this, _current, 0);
+    _classPrivateFieldSet(this, _prev, _classPrivateFieldGet(this, _current) - 1);
+    _classPrivateMethodGet(this, _updateMenuSelection, _updateMenuSelection2).call(this);
+  }
+
+  /**
+   * Selects the last menu item in the menu.
+   */
+  selectLast() {
+    _classPrivateFieldGet(this, _visited).clear();
+    _classPrivateFieldSet(this, _current, _classPrivateFieldGet(this, _hotMenu).countRows() - 1);
+    _classPrivateFieldSet(this, _prev, _classPrivateFieldGet(this, _current) + 1);
+    _classPrivateMethodGet(this, _updateMenuSelection, _updateMenuSelection2).call(this);
+  }
+
+  /**
+   * Selects the next menu item in the menu. The navigator tries to select the closes non-disabled menu
+   * item. When all next items are disabled the first (or next non-disabled) menu item is selected.
+   */
+  selectNext() {
+    _classPrivateFieldGet(this, _visited).clear();
+    _classPrivateFieldSet(this, _current, _classPrivateFieldGet(this, _current) + 1);
+    _classPrivateMethodGet(this, _updateMenuSelection, _updateMenuSelection2).call(this);
+  }
+
+  /**
+   * Selects the previous menu item in the menu. The navigator tries to select the closes non-disabled menu
+   * item. When all previous items are disabled the last (or previous non-disabled) menu item is selected.
+   */
+  selectPrev() {
+    _classPrivateFieldGet(this, _visited).clear();
+    _classPrivateFieldSet(this, _current, _classPrivateFieldGet(this, _current) - 1);
+    _classPrivateMethodGet(this, _updateMenuSelection, _updateMenuSelection2).call(this);
+  }
+
+  /**
+   * Clears the internal state to the initial values.
+   */
+  clear() {
+    _classPrivateFieldGet(this, _visited).clear();
+    _classPrivateFieldSet(this, _prev, -1);
+    _classPrivateFieldSet(this, _current, -1);
+  }
+}
+function _updateMenuSelection2() {
+  const maxItems = _classPrivateFieldGet(this, _hotMenu).countRows() - 1;
+  if (_classPrivateFieldGet(this, _current) < 0) {
+    _classPrivateFieldSet(this, _current, maxItems);
+    _classPrivateFieldSet(this, _prev, maxItems);
+  }
+  if (_classPrivateFieldGet(this, _current) > maxItems) {
+    _classPrivateFieldSet(this, _current, 0);
+    _classPrivateFieldSet(this, _prev, -1);
+  }
+  if (_classPrivateFieldGet(this, _visited).has(_classPrivateFieldGet(this, _current))) {
+    return;
+  }
+  const cell = _classPrivateFieldGet(this, _hotMenu).getCell(_classPrivateFieldGet(this, _current), 0);
+  _classPrivateFieldGet(this, _visited).add(_classPrivateFieldGet(this, _current));
+  if (!cell || isSeparator(cell) || isDisabled(cell) || isSelectionDisabled(cell)) {
+    _classPrivateFieldSet(this, _current, _classPrivateFieldGet(this, _current) + (_classPrivateFieldGet(this, _current) > _classPrivateFieldGet(this, _prev) ? 1 : -1));
+    _classPrivateMethodGet(this, _updateMenuSelection, _updateMenuSelection2).call(this);
+  } else {
+    _classPrivateFieldGet(this, _hotMenu).selectCell(_classPrivateFieldGet(this, _current), 0);
+  }
+  _classPrivateFieldSet(this, _prev, _classPrivateFieldGet(this, _current));
+}

package/plugins/contextMenu/menu/positioner.js

@@ -0,0 +1,213 @@
+"use strict";
+
+exports.__esModule = true;
+require("core-js/modules/es.error.cause.js");
+var _cursor2 = require("./cursor");
+function _classPrivateFieldInitSpec(obj, privateMap, value) { _checkPrivateRedeclaration(obj, privateMap); privateMap.set(obj, value); }
+function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
+function _classPrivateFieldGet(receiver, privateMap) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "get"); return _classApplyDescriptorGet(receiver, descriptor); }
+function _classApplyDescriptorGet(receiver, descriptor) { if (descriptor.get) { return descriptor.get.call(receiver); } return descriptor.value; }
+function _classPrivateFieldSet(receiver, privateMap, value) { var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "set"); _classApplyDescriptorSet(receiver, descriptor, value); return value; }
+function _classExtractFieldDescriptor(receiver, privateMap, action) { if (!privateMap.has(receiver)) { throw new TypeError("attempted to " + action + " private field on non-instance"); } return privateMap.get(receiver); }
+function _classApplyDescriptorSet(receiver, descriptor, value) { if (descriptor.set) { descriptor.set.call(receiver, value); } else { if (!descriptor.writable) { throw new TypeError("attempted to set read only private field"); } descriptor.value = value; } }
+/**
+ * Helper class for positioning the menu and submenus in the correct place relative to the
+ * cursor position (DOM element or mouse coordinates).
+ *
+ * @private
+ * @class Positioner
+ */
+var _container = /*#__PURE__*/new WeakMap();
+var _parentContainer = /*#__PURE__*/new WeakMap();
+var _cursor = /*#__PURE__*/new WeakMap();
+var _keepInViewport = /*#__PURE__*/new WeakMap();
+var _offset = /*#__PURE__*/new WeakMap();
+class Positioner {
+  constructor(keepInViewport) {
+    /**
+     * The menu container element the positioning will be applied to.
+     *
+     * @type {HTMLElement}
+     */
+    _classPrivateFieldInitSpec(this, _container, {
+      writable: true,
+      value: void 0
+    });
+    /**
+     * For positioning the submenu, the parent element is used to calculate offsets to ensure that submenu
+     * is positioned right next to the parent menu.
+     *
+     * @type {HTMLElement}
+     */
+    _classPrivateFieldInitSpec(this, _parentContainer, {
+      writable: true,
+      value: void 0
+    });
+    /**
+     * The instance of the Cursor class.
+     *
+     * @type {Cursor}
+     */
+    _classPrivateFieldInitSpec(this, _cursor, {
+      writable: true,
+      value: void 0
+    });
+    /**
+     * Enabling the option allows changing the position calculation so that the menus (or submenus)
+     * are always placed within the visible viewport of the browser.
+     *
+     * @type {boolean}
+     */
+    _classPrivateFieldInitSpec(this, _keepInViewport, {
+      writable: true,
+      value: false
+    });
+    /**
+     * Allows apply the position offset for directions.
+     *
+     * @type {{above: number, below: number, left: number, right: number}}
+     */
+    _classPrivateFieldInitSpec(this, _offset, {
+      writable: true,
+      value: {
+        above: 0,
+        below: 0,
+        left: 0,
+        right: 0
+      }
+    });
+    _classPrivateFieldSet(this, _keepInViewport, keepInViewport);
+  }
+
+  /**
+   * Sets offset position for specified directions (`above`, `below`, `left` or `right`).
+   *
+   * @param {'above' | 'below' | 'left' | 'right'} direction A direction name.
+   * @param {number} [offset=0] Offset value.
+   * @returns {Positioner}
+   */
+  setOffset(direction) {
+    let offset = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
+    _classPrivateFieldGet(this, _offset)[direction] = offset;
+    return this;
+  }
+
+  /**
+   * Sets the menu element to work with. The element can be owned by the main menu or the submenu.
+   *
+   * @param {HTMLElement} container The menu container element.
+   * @returns {Positioner}
+   */
+  setElement(container) {
+    _classPrivateFieldSet(this, _container, container);
+    return this;
+  }
+
+  /**
+   * Sets the parent menu element to work with.
+   *
+   * @param {HTMLElement} container The parent menu container element.
+   * @returns {Positioner}
+   */
+  setParentElement(container) {
+    _classPrivateFieldSet(this, _parentContainer, container);
+    return this;
+  }
+
+  /**
+   * Updates the menu position.
+   *
+   * @param {object|MouseEvent} coords The literal object with `top`, `left`, `width` and `height` props or a
+   * mouse event object.
+   */
+  updatePosition(coords) {
+    _classPrivateFieldSet(this, _cursor, new _cursor2.Cursor(coords, _classPrivateFieldGet(this, _container).ownerDocument.defaultView));
+    if (_classPrivateFieldGet(this, _keepInViewport)) {
+      if (_classPrivateFieldGet(this, _cursor).fitsBelow(_classPrivateFieldGet(this, _container))) {
+        this.setPositionBelowCursor();
+      } else if (_classPrivateFieldGet(this, _cursor).fitsAbove(_classPrivateFieldGet(this, _container))) {
+        this.setPositionAboveCursor();
+      } else {
+        this.setPositionBelowCursor();
+      }
+      this.updateHorizontalPosition();
+    } else {
+      this.setPositionBelowCursor();
+      this.setPositionOnRightOfCursor();
+    }
+  }
+
+  /**
+   * Updates the menu horizontal position.
+   */
+  updateHorizontalPosition() {
+    if (_classPrivateFieldGet(this, _container).dir === 'rtl') {
+      if (_classPrivateFieldGet(this, _cursor).fitsOnLeft(_classPrivateFieldGet(this, _container))) {
+        this.setPositionOnLeftOfCursor();
+      } else {
+        this.setPositionOnRightOfCursor();
+      }
+    } else if (_classPrivateFieldGet(this, _cursor).fitsOnRight(_classPrivateFieldGet(this, _container))) {
+      this.setPositionOnRightOfCursor();
+    } else {
+      this.setPositionOnLeftOfCursor();
+    }
+  }
+
+  /**
+   * Sets the menu position above the cursor object.
+   */
+  setPositionAboveCursor() {
+    let top = _classPrivateFieldGet(this, _offset).above + _classPrivateFieldGet(this, _cursor).top - _classPrivateFieldGet(this, _container).offsetHeight;
+    if (_classPrivateFieldGet(this, _parentContainer)) {
+      top = _classPrivateFieldGet(this, _cursor).top + _classPrivateFieldGet(this, _cursor).cellHeight - _classPrivateFieldGet(this, _container).offsetHeight + 3;
+    }
+    _classPrivateFieldGet(this, _container).style.top = `${top}px`;
+  }
+
+  /**
+   * Sets the menu position below the cursor object.
+   */
+  setPositionBelowCursor() {
+    let top = _classPrivateFieldGet(this, _offset).below + _classPrivateFieldGet(this, _cursor).top + 1;
+    if (_classPrivateFieldGet(this, _parentContainer)) {
+      top = _classPrivateFieldGet(this, _cursor).top - 1;
+    }
+    _classPrivateFieldGet(this, _container).style.top = `${top}px`;
+  }
+
+  /**
+   * Sets the menu position on the right of the cursor object.
+   */
+  setPositionOnRightOfCursor() {
+    let left = _classPrivateFieldGet(this, _cursor).left;
+    if (_classPrivateFieldGet(this, _parentContainer)) {
+      const {
+        right: parentMenuRight
+      } = _classPrivateFieldGet(this, _parentContainer).getBoundingClientRect();
+
+      // move the sub menu by the width of the parent's border (usually by 1-2 pixels)
+      left += _classPrivateFieldGet(this, _cursor).cellWidth + parentMenuRight - (_classPrivateFieldGet(this, _cursor).left + _classPrivateFieldGet(this, _cursor).cellWidth);
+    } else {
+      left += _classPrivateFieldGet(this, _offset).right;
+    }
+    _classPrivateFieldGet(this, _container).style.left = `${left}px`;
+  }
+
+  /**
+   * Sets the menu position on the left of the cursor object.
+   */
+  setPositionOnLeftOfCursor() {
+    let left = _classPrivateFieldGet(this, _offset).left + _classPrivateFieldGet(this, _cursor).left - _classPrivateFieldGet(this, _container).offsetWidth;
+    if (_classPrivateFieldGet(this, _parentContainer)) {
+      const {
+        left: parentMenuLeft
+      } = _classPrivateFieldGet(this, _parentContainer).getBoundingClientRect();
+
+      // move the sub menu by the width of the parent's border (usually by 1-2 pixels)
+      left -= _classPrivateFieldGet(this, _cursor).left - parentMenuLeft;
+    }
+    _classPrivateFieldGet(this, _container).style.left = `${left}px`;
+  }
+}
+exports.Positioner = Positioner;