handsontable 0.0.0-next-9379dd1-20231020 → 0.0.0-next-9059914-20231025

package/plugins/contextMenu/{menu/menu.js → menu.js}

@@ -2,20 +2,19 @@
 
 exports.__esModule = true;
 require("core-js/modules/es.array.push.js");
-var _positioner = require("./positioner");
-var _navigator = require("./navigator");
-var _predefinedItems = require("./../predefinedItems");
+var _cursor = _interopRequireDefault(require("./cursor"));
+var _predefinedItems = require("./predefinedItems");
 var _utils = require("./utils");
-var _eventManager = _interopRequireDefault(require("../../../eventManager"));
-var _array = require("../../../helpers/array");
-var _browser = require("../../../helpers/browser");
-var _element = require("../../../helpers/dom/element");
-var _event = require("../../../helpers/dom/event");
-var _function = require("../../../helpers/function");
-var _mixed = require("../../../helpers/mixed");
-var _object = require("../../../helpers/object");
-var _localHooks = _interopRequireDefault(require("../../../mixins/localHooks"));
-var _a11y = require("../../../helpers/a11y");
+var _core = _interopRequireDefault(require("../../core"));
+var _eventManager = _interopRequireDefault(require("../../eventManager"));
+var _array = require("../../helpers/array");
+var _browser = require("../../helpers/browser");
+var _element = require("../../helpers/dom/element");
+var _event = require("../../helpers/dom/event");
+var _function = require("../../helpers/function");
+var _mixed = require("../../helpers/mixed");
+var _object = require("../../helpers/object");
+var _localHooks = _interopRequireDefault(require("../../mixins/localHooks"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 const MIN_WIDTH = 215;
 const SHORTCUTS_CONTEXT = 'menu';
@@ -54,13 +53,18 @@ class Menu {
     };
     this.eventManager = new _eventManager.default(this);
     this.container = this.createContainer(this.options.name);
-    this.positioner = new _positioner.Positioner(this.options.keepInViewport);
-    this.navigator = new _navigator.Navigator();
     this.hotMenu = null;
     this.hotSubMenus = {};
     this.parentMenu = this.options.parent || null;
     this.menuItems = null;
     this.origOutsideClickDeselects = null;
+    this.keyEvent = false;
+    this.offset = {
+      above: 0,
+      below: 0,
+      left: 0,
+      right: 0
+    };
     this._afterScrollCallback = null;
     this.registerEvents();
   }
@@ -106,6 +110,17 @@ class Menu {
     return Array.isArray(this.hotMenu.getSelectedLast());
   }
 
+  /**
+   * Set offset menu position for specified area (`above`, `below`, `left` or `right`).
+   *
+   * @param {string} area Specified area name (`above`, `below`, `left` or `right`).
+   * @param {number} offset Offset value.
+   */
+  setOffset(area) {
+    let offset = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
+    this.offset[area] = offset;
+  }
+
   /**
    * Check if menu is using as sub-menu.
    *
@@ -122,6 +137,7 @@ class Menu {
    * @fires Hooks#afterContextMenuShow
    */
   open() {
+    var _this = this;
     this.runLocalHooks('beforeOpen');
     this.container.removeAttribute('style');
     this.container.style.display = 'block';
@@ -166,7 +182,6 @@ class Menu {
       outsideClickDeselects: false,
       disableVisualSelection: 'area',
       layoutDirection: this.hot.isRtl() ? 'rtl' : 'ltr',
-      ariaTags: false,
       afterOnCellMouseOver: (event, coords) => {
         if (this.isAllSubMenusClosed()) {
           delayedOpenSubMenu(coords.row);
@@ -184,12 +199,6 @@ class Menu {
           this.close(true);
         }
       },
-      afterSelection: (row, column, row2, column2, preventScrolling) => {
-        // do not scroll the viewport when mouse clicks on partially visible menu item
-        if (this.hotMenu.view.isMouseDown()) {
-          preventScrolling.value = true;
-        }
-      },
       beforeOnCellMouseUp: event => {
         if (this.hasSelectedItem()) {
           shouldAutoCloseMenu = !this.isCommandPassive(this.getSelectedItem());
@@ -207,7 +216,7 @@ class Menu {
           // event hides the tapped element, the click event grabs the element below. As a result, the filter
           // by condition menu is closed and immediately open on tapping the "None" item.
           if ((0, _browser.isMobileBrowser)() || (0, _browser.isIpadOS)()) {
-            this.hot._registerTimeout(() => this.close(true), 325);
+            setTimeout(() => this.close(true), 325);
           } else {
             this.close(true);
           }
@@ -223,11 +232,13 @@ class Menu {
     };
     this.origOutsideClickDeselects = this.hot.getSettings().outsideClickDeselects;
     this.hot.getSettings().outsideClickDeselects = false;
-    this.hotMenu = new this.hot.constructor(this.container, settings);
+    this.hotMenu = new _core.default(this.container, settings);
     this.hotMenu.addHook('afterInit', () => this.onAfterInit());
+    this.hotMenu.addHook('afterSelection', function () {
+      return _this.onAfterSelection(...arguments);
+    });
     this.hotMenu.init();
     this.hotMenu.listen();
-    this.navigator.setMenu(this.hotMenu);
     const shortcutManager = this.hotMenu.getShortcutManager();
     const menuContext = shortcutManager.addContext(SHORTCUTS_GROUP);
     const config = {
@@ -235,84 +246,105 @@ class Menu {
     };
     const menuContextConfig = {
       ...config,
-      runOnlyIf: event => !(0, _element.isInput)(event.target) || !this.container.contains(event.target)
+      runOnlyIf: event => (0, _element.isInput)(event.target) === false || this.container.contains(event.target) === false
     };
 
     // Default shortcuts for Handsontable should not be handled. Changing context will help with that.
     shortcutManager.setActiveContextName('menu');
     menuContext.addShortcuts([{
-      keys: [['Tab'], ['Shift', 'Tab'], ['Control/Meta', 'A']],
-      forwardToContext: this.hot.getShortcutManager().getContext('grid'),
-      callback: () => this.close(true)
-    }, {
       keys: [['Escape']],
-      callback: () => this.close(true)
+      callback: () => {
+        this.keyEvent = true;
+        this.close();
+        this.keyEvent = false;
+      }
     }, {
       keys: [['ArrowDown']],
-      callback: () => this.navigator.selectNext()
+      callback: () => {
+        const selection = this.hotMenu.getSelectedLast();
+        this.keyEvent = true;
+        if (selection) {
+          this.selectNextCell(selection[0], selection[1]);
+        } else {
+          this.selectFirstCell();
+        }
+        this.keyEvent = false;
+      }
     }, {
       keys: [['ArrowUp']],
-      callback: () => this.navigator.selectPrev()
+      callback: () => {
+        const selection = this.hotMenu.getSelectedLast();
+        this.keyEvent = true;
+        if (selection) {
+          this.selectPrevCell(selection[0], selection[1]);
+        } else {
+          this.selectLastCell();
+        }
+        this.keyEvent = false;
+      }
     }, {
       keys: [['ArrowRight']],
       callback: () => {
         const selection = this.hotMenu.getSelectedLast();
+        this.keyEvent = true;
         if (selection) {
-          const subMenu = this.openSubMenu(selection[0]);
-          if (subMenu) {
-            subMenu.navigator.selectFirst();
+          const menu = this.openSubMenu(selection[0]);
+          if (menu) {
+            menu.selectFirstCell();
           }
         }
+        this.keyEvent = false;
       }
     }, {
       keys: [['ArrowLeft']],
       callback: () => {
         const selection = this.hotMenu.getSelectedLast();
+        this.keyEvent = true;
         if (selection && this.isSubMenu()) {
           this.close();
-          if (this.isSubMenu()) {
+          if (this.parentMenu) {
             this.parentMenu.hotMenu.listen();
           }
         }
+        this.keyEvent = false;
       }
     }, {
-      keys: [['Control/Meta', 'ArrowUp'], ['Home']],
-      callback: () => this.navigator.selectFirst()
-    }, {
-      keys: [['Control/Meta', 'ArrowDown'], ['End']],
-      callback: () => this.navigator.selectLast()
-    }, {
-      keys: [['Enter'], ['Space']],
+      keys: [['Enter']],
       callback: event => {
         const selection = this.hotMenu.getSelectedLast();
-        if (this.hotMenu.getSourceDataAtRow(selection[0]).submenu) {
-          this.openSubMenu(selection[0]).navigator.selectFirst();
-        } else {
+        this.keyEvent = true;
+        if (!this.hotMenu.getSourceDataAtRow(selection[0]).submenu) {
           this.executeCommand(event);
           this.close(true);
         }
+        this.keyEvent = false;
       }
     }, {
       keys: [['PageUp']],
       callback: () => {
         const selection = this.hotMenu.getSelectedLast();
+        this.keyEvent = true;
         if (selection) {
           this.hotMenu.selection.transformStart(-this.hotMenu.countVisibleRows(), 0);
         } else {
-          this.navigator.selectFirst();
+          this.selectFirstCell();
         }
+        this.keyEvent = false;
       }
     }, {
       keys: [['PageDown']],
       callback: () => {
         const selection = this.hotMenu.getSelectedLast();
+        this.keyEvent = true;
         if (selection) {
           this.hotMenu.selection.transformStart(this.hotMenu.countVisibleRows(), 0);
         } else {
-          this.navigator.selectLast();
+          this.selectLastCell();
         }
+        this.keyEvent = false;
       }
     }], menuContextConfig);
+    this.blockMainTableCallbacks();
     this.runLocalHooks('afterOpen');
   }
 
@@ -326,24 +358,17 @@ class Menu {
     if (!this.isOpened()) {
       return;
     }
-    if (closeParent && this.isSubMenu()) {
+    if (closeParent && this.parentMenu) {
       this.parentMenu.close();
     } else {
-      this.navigator.clear();
       this.closeAllSubMenus();
       this.container.style.display = 'none';
+      this.releaseMainTableCallbacks();
       this.hotMenu.destroy();
       this.hotMenu = null;
       this.hot.getSettings().outsideClickDeselects = this.origOutsideClickDeselects;
       this.runLocalHooks('afterClose');
-      if (this.isSubMenu()) {
-        if (this.hot.getSettings().ariaTags) {
-          const selection = this.parentMenu.hotMenu.getSelectedLast();
-          if (selection) {
-            const cell = this.parentMenu.hotMenu.getCell(selection[0], 0);
-            (0, _element.setAttribute)(cell, [(0, _a11y.A11Y_EXPANDED)(false)]);
-          }
-        }
+      if (this.parentMenu) {
         this.parentMenu.hotMenu.listen();
       }
     }
@@ -376,11 +401,6 @@ class Menu {
     subMenu.open();
     subMenu.setPosition(cell.getBoundingClientRect());
     this.hotSubMenus[dataItem.key] = subMenu;
-
-    // Update the accessibility tags on the cell being the base for the submenu.
-    if (this.hot.getSettings().ariaTags) {
-      (0, _element.setAttribute)(cell, [(0, _a11y.A11Y_EXPANDED)(true)]);
-    }
     return subMenu;
   }
 
@@ -395,12 +415,6 @@ class Menu {
     if (menus) {
       menus.destroy();
       delete this.hotSubMenus[dataItem.key];
-      const cell = this.hotMenu.getCell(row, 0);
-
-      // Update the accessibility tags on the cell being the base for the submenu.
-      if (this.hot.getSettings().ariaTags) {
-        (0, _element.setAttribute)(cell, [(0, _a11y.A11Y_EXPANDED)(false)]);
-      }
     }
   }
 
@@ -479,30 +493,196 @@ class Menu {
    * @returns {boolean}
    */
   isCommandPassive(commandDescriptor) {
-    return commandDescriptor.isCommand === false || (0, _utils.isItemSeparator)(commandDescriptor) || (0, _utils.isItemDisabled)(commandDescriptor, this.hot) || (0, _utils.isItemSubMenu)(commandDescriptor);
+    const {
+      isCommand,
+      name: commandName,
+      disabled,
+      submenu
+    } = commandDescriptor;
+    const isItemDisabled = disabled === true || typeof disabled === 'function' && disabled.call(this.hot) === true;
+    return isCommand === false || commandName === _predefinedItems.SEPARATOR || isItemDisabled === true || submenu;
   }
 
   /**
-   * Set offset menu position for specified area (`above`, `below`, `left` or `right`).
+   * Set menu position based on dom event or based on literal object.
    *
-   * @param {string} area Specified area name (`above`, `below`, `left` or `right`).
-   * @param {number} offset Offset value.
+   * @param {Event|object} coords Event or literal Object with coordinates.
    */
-  setOffset(area) {
-    let offset = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
-    this.positioner.setOffset(area, offset);
+  setPosition(coords) {
+    const cursor = new _cursor.default(coords, this.container.ownerDocument.defaultView);
+    if (this.options.keepInViewport) {
+      if (cursor.fitsBelow(this.container)) {
+        this.setPositionBelowCursor(cursor);
+      } else if (cursor.fitsAbove(this.container)) {
+        this.setPositionAboveCursor(cursor);
+      } else {
+        this.setPositionBelowCursor(cursor);
+      }
+      if (this.hot.isLtr()) {
+        this.setHorizontalPositionForLtr(cursor);
+      } else {
+        this.setHorizontalPositionForRtl(cursor);
+      }
+    } else {
+      this.setPositionBelowCursor(cursor);
+      this.setPositionOnRightOfCursor(cursor);
+    }
   }
 
   /**
-   * Set menu position based on dom event or based on literal object.
+   * Set menu horizontal position for RTL mode.
    *
-   * @param {Event|object} coords Event or literal Object with coordinates.
+   * @param {Cursor} cursor `Cursor` object.
    */
-  setPosition(coords) {
+  setHorizontalPositionForRtl(cursor) {
+    if (cursor.fitsOnLeft(this.container)) {
+      this.setPositionOnLeftOfCursor(cursor);
+    } else {
+      this.setPositionOnRightOfCursor(cursor);
+    }
+  }
+
+  /**
+   * Set menu horizontal position for LTR mode.
+   *
+   * @param {Cursor} cursor `Cursor` object.
+   */
+  setHorizontalPositionForLtr(cursor) {
+    if (cursor.fitsOnRight(this.container)) {
+      this.setPositionOnRightOfCursor(cursor);
+    } else {
+      this.setPositionOnLeftOfCursor(cursor);
+    }
+  }
+
+  /**
+   * Set menu position above cursor object.
+   *
+   * @param {Cursor} cursor `Cursor` object.
+   */
+  setPositionAboveCursor(cursor) {
+    let top = this.offset.above + cursor.top - this.container.offsetHeight;
+    if (this.isSubMenu()) {
+      top = cursor.top + cursor.cellHeight - this.container.offsetHeight + 3;
+    }
+    this.container.style.top = `${top}px`;
+  }
+
+  /**
+   * Set menu position below cursor object.
+   *
+   * @param {Cursor} cursor `Cursor` object.
+   */
+  setPositionBelowCursor(cursor) {
+    let top = this.offset.below + cursor.top + 1;
+    if (this.isSubMenu()) {
+      top = cursor.top - 1;
+    }
+    this.container.style.top = `${top}px`;
+  }
+
+  /**
+   * Set menu position on the right of cursor object.
+   *
+   * @param {Cursor} cursor `Cursor` object.
+   */
+  setPositionOnRightOfCursor(cursor) {
+    let left = cursor.left;
+    if (this.isSubMenu()) {
+      const {
+        right: parentMenuRight
+      } = this.parentMenu.container.getBoundingClientRect();
+
+      // move the sub menu by the width of the parent's border (usually by 1-2 pixels)
+      left += cursor.cellWidth + parentMenuRight - (cursor.left + cursor.cellWidth);
+    } else {
+      left += this.offset.right;
+    }
+    this.container.style.left = `${left}px`;
+  }
+
+  /**
+   * Set menu position on the left of cursor object.
+   *
+   * @param {Cursor} cursor `Cursor` object.
+   */
+  setPositionOnLeftOfCursor(cursor) {
+    let left = this.offset.left + cursor.left - this.container.offsetWidth;
     if (this.isSubMenu()) {
-      this.positioner.setParentElement(this.parentMenu.container);
+      const {
+        left: parentMenuLeft
+      } = this.parentMenu.container.getBoundingClientRect();
+
+      // move the sub menu by the width of the parent's border (usually by 1-2 pixels)
+      left -= cursor.left - parentMenuLeft;
+    }
+    this.container.style.left = `${left}px`;
+  }
+
+  /**
+   * Select first cell in opened menu.
+   */
+  selectFirstCell() {
+    const cell = this.hotMenu.getCell(0, 0);
+    if ((0, _utils.isSeparator)(cell) || (0, _utils.isDisabled)(cell) || (0, _utils.isSelectionDisabled)(cell)) {
+      this.selectNextCell(0, 0);
+    } else {
+      this.hotMenu.selectCell(0, 0);
+    }
+  }
+
+  /**
+   * Select last cell in opened menu.
+   */
+  selectLastCell() {
+    const lastRow = this.hotMenu.countRows() - 1;
+    const cell = this.hotMenu.getCell(lastRow, 0);
+    if ((0, _utils.isSeparator)(cell) || (0, _utils.isDisabled)(cell) || (0, _utils.isSelectionDisabled)(cell)) {
+      this.selectPrevCell(lastRow, 0);
+    } else {
+      // disable default "scroll-to-cell" option and instead of that...
+      this.hotMenu.selectCell(lastRow, 0, undefined, undefined, false);
+      // ...scroll to the cell with "snap to the bottom" option
+      this.hotMenu.scrollViewportTo(lastRow, 0, true, false);
+    }
+  }
+
+  /**
+   * Select next cell in opened menu.
+   *
+   * @param {number} row Row index.
+   * @param {number} col Column index.
+   */
+  selectNextCell(row, col) {
+    const nextRow = row + 1;
+    const cell = nextRow < this.hotMenu.countRows() ? this.hotMenu.getCell(nextRow, col) : null;
+    if (!cell) {
+      return;
+    }
+    if ((0, _utils.isSeparator)(cell) || (0, _utils.isDisabled)(cell) || (0, _utils.isSelectionDisabled)(cell)) {
+      this.selectNextCell(nextRow, col);
+    } else {
+      this.hotMenu.selectCell(nextRow, col);
+    }
+  }
+
+  /**
+   * Select previous cell in opened menu.
+   *
+   * @param {number} row Row index.
+   * @param {number} col Column index.
+   */
+  selectPrevCell(row, col) {
+    const prevRow = row - 1;
+    const cell = prevRow >= 0 ? this.hotMenu.getCell(prevRow, col) : null;
+    if (!cell) {
+      return;
+    }
+    if ((0, _utils.isSeparator)(cell) || (0, _utils.isDisabled)(cell) || (0, _utils.isSelectionDisabled)(cell)) {
+      this.selectPrevCell(prevRow, col);
+    } else {
+      this.hotMenu.selectCell(prevRow, col);
     }
-    this.positioner.setElement(this.container).updatePosition(coords);
   }
 
   /**
@@ -519,17 +699,18 @@ class Menu {
   menuItemRenderer(hot, TD, row, col, prop, value) {
     const item = hot.getSourceDataAtRow(row);
     const wrapper = this.hot.rootDocument.createElement('div');
+    const isSubMenu = itemToTest => (0, _object.hasOwnProperty)(itemToTest, 'submenu');
+    const itemIsSeparator = itemToTest => new RegExp(_predefinedItems.SEPARATOR, 'i').test(itemToTest.name);
+    const itemIsDisabled = itemToTest => itemToTest.disabled === true || typeof itemToTest.disabled === 'function' && itemToTest.disabled.call(this.hot) === true;
+    const itemIsSelectionDisabled = itemToTest => itemToTest.disableSelection;
     let itemValue = value;
     if (typeof itemValue === 'function') {
       itemValue = itemValue.call(this.hot);
     }
     (0, _element.empty)(TD);
     (0, _element.addClass)(wrapper, 'htItemWrapper');
-    if (this.hot.getSettings().ariaTags) {
-      (0, _element.setAttribute)(TD, [(0, _a11y.A11Y_MENU_ITEM)(), (0, _a11y.A11Y_LABEL)(itemValue), ...((0, _utils.isItemDisabled)(item, this.hot) ? [(0, _a11y.A11Y_DISABLED)()] : []), ...((0, _utils.isItemSubMenu)(item) ? [(0, _a11y.A11Y_EXPANDED)(false)] : [])]);
-    }
     TD.appendChild(wrapper);
-    if ((0, _utils.isItemSeparator)(item)) {
+    if (itemIsSeparator(item)) {
       (0, _element.addClass)(TD, 'htSeparator');
     } else if (typeof item.renderer === 'function') {
       (0, _element.addClass)(TD, 'htCustomMenuRenderer');
@@ -537,22 +718,22 @@ class Menu {
     } else {
       (0, _element.fastInnerHTML)(wrapper, itemValue);
     }
-    if ((0, _utils.isItemDisabled)(item, this.hot)) {
+    if (itemIsDisabled(item)) {
       (0, _element.addClass)(TD, 'htDisabled');
       this.eventManager.addEventListener(TD, 'mouseenter', () => hot.deselectCell());
-    } else if ((0, _utils.isItemSelectionDisabled)(item)) {
+    } else if (itemIsSelectionDisabled(item)) {
       (0, _element.addClass)(TD, 'htSelectionDisabled');
       this.eventManager.addEventListener(TD, 'mouseenter', () => hot.deselectCell());
-    } else if ((0, _utils.isItemSubMenu)(item)) {
+    } else if (isSubMenu(item)) {
       (0, _element.addClass)(TD, 'htSubmenu');
-      if ((0, _utils.isItemSelectionDisabled)(item)) {
+      if (itemIsSelectionDisabled(item)) {
         this.eventManager.addEventListener(TD, 'mouseenter', () => hot.deselectCell());
       } else {
         this.eventManager.addEventListener(TD, 'mouseenter', () => hot.selectCell(row, col, void 0, void 0, false, false));
       }
     } else {
       (0, _element.removeClass)(TD, ['htSubmenu', 'htDisabled']);
-      if ((0, _utils.isItemSelectionDisabled)(item)) {
+      if (itemIsSelectionDisabled(item)) {
         this.eventManager.addEventListener(TD, 'mouseenter', () => hot.deselectCell());
       } else {
         this.eventManager.addEventListener(TD, 'mouseenter', () => hot.selectCell(row, col, void 0, void 0, false, false));
@@ -596,6 +777,26 @@ class Menu {
     return container;
   }
 
+  /**
+   * @private
+   */
+  blockMainTableCallbacks() {
+    this._afterScrollCallback = function () {};
+    this.hot.addHook('afterScrollVertically', this._afterScrollCallback);
+    this.hot.addHook('afterScrollHorizontally', this._afterScrollCallback);
+  }
+
+  /**
+   * @private
+   */
+  releaseMainTableCallbacks() {
+    if (this._afterScrollCallback) {
+      this.hot.removeHook('afterScrollVertically', this._afterScrollCallback);
+      this.hot.removeHook('afterScrollHorizontally', this._afterScrollCallback);
+      this._afterScrollCallback = null;
+    }
+  }
+
   /**
    * On after init listener.
    *
@@ -615,10 +816,20 @@ class Menu {
     holderStyle.width = `${currentHiderWidth + 3}px`;
     holderStyle.height = `${realHeight + 3}px`;
     hiderStyle.height = holderStyle.height;
+  }
 
-    // Replace the default accessibility tags with the context menu's
-    if (this.hot.getSettings().ariaTags) {
-      (0, _element.setAttribute)(this.hotMenu.rootElement, [(0, _a11y.A11Y_MENU)()]);
+  /**
+   * On after selection listener.
+   *
+   * @param {number} r Selection start row index.
+   * @param {number} c Selection start column index.
+   * @param {number} r2 Selection end row index.
+   * @param {number} c2 Selection end column index.
+   * @param {object} preventScrolling Object with `value` property where its value change will be observed.
+   */
+  onAfterSelection(r, c, r2, c2, preventScrolling) {
+    if (this.keyEvent === false) {
+      preventScrolling.value = true;
     }
   }
 
@@ -658,5 +869,6 @@ class Menu {
     }
   }
 }
-exports.Menu = Menu;
-(0, _object.mixin)(Menu, _localHooks.default);
+(0, _object.mixin)(Menu, _localHooks.default);
+var _default = Menu;
+exports.default = _default;