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

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

@@ -1,17 +1,18 @@
 import "core-js/modules/es.array.push.js";
-import Cursor from "./cursor.mjs";
-import { SEPARATOR, NO_ITEMS, predefinedItems } from "./predefinedItems.mjs";
-import { filterSeparators, hasSubMenu, isDisabled, isItemHidden, isSeparator, isSelectionDisabled, normalizeSelection } from "./utils.mjs";
-import Core from "../../core.mjs";
-import EventManager from "../../eventManager.mjs";
-import { arrayEach, arrayFilter, arrayReduce } from "../../helpers/array.mjs";
-import { isWindowsOS, isMobileBrowser, isIpadOS } from "../../helpers/browser.mjs";
-import { addClass, empty, fastInnerHTML, isChildOf, isInput, removeClass, getParentWindow, hasClass } from "../../helpers/dom/element.mjs";
-import { isRightClick } from "../../helpers/dom/event.mjs";
-import { debounce, isFunction } from "../../helpers/function.mjs";
-import { isUndefined, isDefined } from "../../helpers/mixed.mjs";
-import { mixin, hasOwnProperty } from "../../helpers/object.mjs";
-import localHooks from "../../mixins/localHooks.mjs";
+import { Positioner } from "./positioner.mjs";
+import { Navigator } from "./navigator.mjs";
+import { SEPARATOR, NO_ITEMS, predefinedItems } from "./../predefinedItems/index.mjs";
+import { filterSeparators, hasSubMenu, isItemHidden, normalizeSelection, isItemSubMenu, isItemDisabled, isItemSelectionDisabled, isItemSeparator } from "./utils.mjs";
+import EventManager from "../../../eventManager.mjs";
+import { arrayEach, arrayFilter, arrayReduce } from "../../../helpers/array.mjs";
+import { isWindowsOS, isMobileBrowser, isIpadOS } from "../../../helpers/browser.mjs";
+import { addClass, empty, fastInnerHTML, isChildOf, isInput, removeClass, getParentWindow, hasClass, setAttribute } from "../../../helpers/dom/element.mjs";
+import { isRightClick } from "../../../helpers/dom/event.mjs";
+import { debounce, isFunction } from "../../../helpers/function.mjs";
+import { isUndefined, isDefined } from "../../../helpers/mixed.mjs";
+import { mixin } from "../../../helpers/object.mjs";
+import localHooks from "../../../mixins/localHooks.mjs";
+import { A11Y_DISABLED, A11Y_EXPANDED, A11Y_LABEL, A11Y_MENU, A11Y_MENU_ITEM } from "../../../helpers/a11y.mjs";
 const MIN_WIDTH = 215;
 const SHORTCUTS_CONTEXT = 'menu';
 const SHORTCUTS_GROUP = SHORTCUTS_CONTEXT;
@@ -31,7 +32,7 @@ const SHORTCUTS_GROUP = SHORTCUTS_CONTEXT;
  * @private
  * @class Menu
  */
-class Menu {
+export class Menu {
   /**
    * @param {Core} hotInstance Handsontable instance.
    * @param {MenuOptions} [options] Menu options.
@@ -49,18 +50,13 @@ class Menu {
     };
     this.eventManager = new EventManager(this);
     this.container = this.createContainer(this.options.name);
+    this.positioner = new Positioner(this.options.keepInViewport);
+    this.navigator = new 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,17 +102,6 @@ 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.
    *
@@ -133,7 +118,6 @@ class Menu {
    * @fires Hooks#afterContextMenuShow
    */
   open() {
-    var _this = this;
     this.runLocalHooks('beforeOpen');
     this.container.removeAttribute('style');
     this.container.style.display = 'block';
@@ -178,6 +162,7 @@ class Menu {
       outsideClickDeselects: false,
       disableVisualSelection: 'area',
       layoutDirection: this.hot.isRtl() ? 'rtl' : 'ltr',
+      ariaTags: false,
       afterOnCellMouseOver: (event, coords) => {
         if (this.isAllSubMenusClosed()) {
           delayedOpenSubMenu(coords.row);
@@ -195,6 +180,12 @@ 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());
@@ -212,7 +203,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 (isMobileBrowser() || isIpadOS()) {
-            setTimeout(() => this.close(true), 325);
+            this.hot._registerTimeout(() => this.close(true), 325);
           } else {
             this.close(true);
           }
@@ -228,13 +219,11 @@ class Menu {
     };
     this.origOutsideClickDeselects = this.hot.getSettings().outsideClickDeselects;
     this.hot.getSettings().outsideClickDeselects = false;
-    this.hotMenu = new Core(this.container, settings);
+    this.hotMenu = new this.hot.constructor(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 = {
@@ -242,105 +231,84 @@ class Menu {
     };
     const menuContextConfig = {
       ...config,
-      runOnlyIf: event => isInput(event.target) === false || this.container.contains(event.target) === false
+      runOnlyIf: event => !isInput(event.target) || !this.container.contains(event.target)
     };
 
     // 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.keyEvent = true;
-        this.close();
-        this.keyEvent = false;
-      }
+      callback: () => this.close(true)
     }, {
       keys: [['ArrowDown']],
-      callback: () => {
-        const selection = this.hotMenu.getSelectedLast();
-        this.keyEvent = true;
-        if (selection) {
-          this.selectNextCell(selection[0], selection[1]);
-        } else {
-          this.selectFirstCell();
-        }
-        this.keyEvent = false;
-      }
+      callback: () => this.navigator.selectNext()
     }, {
       keys: [['ArrowUp']],
-      callback: () => {
-        const selection = this.hotMenu.getSelectedLast();
-        this.keyEvent = true;
-        if (selection) {
-          this.selectPrevCell(selection[0], selection[1]);
-        } else {
-          this.selectLastCell();
-        }
-        this.keyEvent = false;
-      }
+      callback: () => this.navigator.selectPrev()
     }, {
       keys: [['ArrowRight']],
       callback: () => {
         const selection = this.hotMenu.getSelectedLast();
-        this.keyEvent = true;
         if (selection) {
-          const menu = this.openSubMenu(selection[0]);
-          if (menu) {
-            menu.selectFirstCell();
+          const subMenu = this.openSubMenu(selection[0]);
+          if (subMenu) {
+            subMenu.navigator.selectFirst();
           }
         }
-        this.keyEvent = false;
       }
     }, {
       keys: [['ArrowLeft']],
       callback: () => {
         const selection = this.hotMenu.getSelectedLast();
-        this.keyEvent = true;
         if (selection && this.isSubMenu()) {
           this.close();
-          if (this.parentMenu) {
+          if (this.isSubMenu()) {
             this.parentMenu.hotMenu.listen();
           }
         }
-        this.keyEvent = false;
       }
     }, {
-      keys: [['Enter']],
+      keys: [['Control/Meta', 'ArrowUp'], ['Home']],
+      callback: () => this.navigator.selectFirst()
+    }, {
+      keys: [['Control/Meta', 'ArrowDown'], ['End']],
+      callback: () => this.navigator.selectLast()
+    }, {
+      keys: [['Enter'], ['Space']],
       callback: event => {
         const selection = this.hotMenu.getSelectedLast();
-        this.keyEvent = true;
-        if (!this.hotMenu.getSourceDataAtRow(selection[0]).submenu) {
+        if (this.hotMenu.getSourceDataAtRow(selection[0]).submenu) {
+          this.openSubMenu(selection[0]).navigator.selectFirst();
+        } else {
           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.selectFirstCell();
+          this.navigator.selectFirst();
         }
-        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.selectLastCell();
+          this.navigator.selectLast();
         }
-        this.keyEvent = false;
       }
     }], menuContextConfig);
-    this.blockMainTableCallbacks();
     this.runLocalHooks('afterOpen');
   }
 
@@ -354,17 +322,24 @@ class Menu {
     if (!this.isOpened()) {
       return;
     }
-    if (closeParent && this.parentMenu) {
+    if (closeParent && this.isSubMenu()) {
       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.parentMenu) {
+      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);
+            setAttribute(cell, [A11Y_EXPANDED(false)]);
+          }
+        }
         this.parentMenu.hotMenu.listen();
       }
     }
@@ -397,6 +372,11 @@ 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) {
+      setAttribute(cell, [A11Y_EXPANDED(true)]);
+    }
     return subMenu;
   }
 
@@ -411,6 +391,12 @@ 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) {
+        setAttribute(cell, [A11Y_EXPANDED(false)]);
+      }
     }
   }
 
@@ -489,196 +475,30 @@ class Menu {
    * @returns {boolean}
    */
   isCommandPassive(commandDescriptor) {
-    const {
-      isCommand,
-      name: commandName,
-      disabled,
-      submenu
-    } = commandDescriptor;
-    const isItemDisabled = disabled === true || typeof disabled === 'function' && disabled.call(this.hot) === true;
-    return isCommand === false || commandName === SEPARATOR || isItemDisabled === true || submenu;
-  }
-
-  /**
-   * Set menu position based on dom event or based on literal object.
-   *
-   * @param {Event|object} coords Event or literal Object with coordinates.
-   */
-  setPosition(coords) {
-    const cursor = new Cursor(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 horizontal position for RTL mode.
-   *
-   * @param {Cursor} cursor `Cursor` object.
-   */
-  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`;
+    return commandDescriptor.isCommand === false || isItemSeparator(commandDescriptor) || isItemDisabled(commandDescriptor, this.hot) || isItemSubMenu(commandDescriptor);
   }
 
   /**
-   * Set menu position on the right of cursor object.
+   * Set offset menu position for specified area (`above`, `below`, `left` or `right`).
    *
-   * @param {Cursor} cursor `Cursor` object.
+   * @param {string} area Specified area name (`above`, `below`, `left` or `right`).
+   * @param {number} offset Offset value.
    */
-  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`;
+  setOffset(area) {
+    let offset = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
+    this.positioner.setOffset(area, offset);
   }
 
   /**
-   * Set menu position on the left of cursor object.
+   * Set menu position based on dom event or based on literal object.
    *
-   * @param {Cursor} cursor `Cursor` object.
+   * @param {Event|object} coords Event or literal Object with coordinates.
    */
-  setPositionOnLeftOfCursor(cursor) {
-    let left = this.offset.left + cursor.left - this.container.offsetWidth;
+  setPosition(coords) {
     if (this.isSubMenu()) {
-      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 (isSeparator(cell) || isDisabled(cell) || 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 (isSeparator(cell) || isDisabled(cell) || 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 (isSeparator(cell) || isDisabled(cell) || 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 (isSeparator(cell) || isDisabled(cell) || isSelectionDisabled(cell)) {
-      this.selectPrevCell(prevRow, col);
-    } else {
-      this.hotMenu.selectCell(prevRow, col);
+      this.positioner.setParentElement(this.parentMenu.container);
     }
+    this.positioner.setElement(this.container).updatePosition(coords);
   }
 
   /**
@@ -695,18 +515,17 @@ class Menu {
   menuItemRenderer(hot, TD, row, col, prop, value) {
     const item = hot.getSourceDataAtRow(row);
     const wrapper = this.hot.rootDocument.createElement('div');
-    const isSubMenu = itemToTest => hasOwnProperty(itemToTest, 'submenu');
-    const itemIsSeparator = itemToTest => new RegExp(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);
     }
     empty(TD);
     addClass(wrapper, 'htItemWrapper');
+    if (this.hot.getSettings().ariaTags) {
+      setAttribute(TD, [A11Y_MENU_ITEM(), A11Y_LABEL(itemValue), ...(isItemDisabled(item, this.hot) ? [A11Y_DISABLED()] : []), ...(isItemSubMenu(item) ? [A11Y_EXPANDED(false)] : [])]);
+    }
     TD.appendChild(wrapper);
-    if (itemIsSeparator(item)) {
+    if (isItemSeparator(item)) {
       addClass(TD, 'htSeparator');
     } else if (typeof item.renderer === 'function') {
       addClass(TD, 'htCustomMenuRenderer');
@@ -714,22 +533,22 @@ class Menu {
     } else {
       fastInnerHTML(wrapper, itemValue);
     }
-    if (itemIsDisabled(item)) {
+    if (isItemDisabled(item, this.hot)) {
       addClass(TD, 'htDisabled');
       this.eventManager.addEventListener(TD, 'mouseenter', () => hot.deselectCell());
-    } else if (itemIsSelectionDisabled(item)) {
+    } else if (isItemSelectionDisabled(item)) {
       addClass(TD, 'htSelectionDisabled');
       this.eventManager.addEventListener(TD, 'mouseenter', () => hot.deselectCell());
-    } else if (isSubMenu(item)) {
+    } else if (isItemSubMenu(item)) {
       addClass(TD, 'htSubmenu');
-      if (itemIsSelectionDisabled(item)) {
+      if (isItemSelectionDisabled(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 {
       removeClass(TD, ['htSubmenu', 'htDisabled']);
-      if (itemIsSelectionDisabled(item)) {
+      if (isItemSelectionDisabled(item)) {
         this.eventManager.addEventListener(TD, 'mouseenter', () => hot.deselectCell());
       } else {
         this.eventManager.addEventListener(TD, 'mouseenter', () => hot.selectCell(row, col, void 0, void 0, false, false));
@@ -773,26 +592,6 @@ 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.
    *
@@ -812,20 +611,10 @@ class Menu {
     holderStyle.width = `${currentHiderWidth + 3}px`;
     holderStyle.height = `${realHeight + 3}px`;
     hiderStyle.height = holderStyle.height;
-  }
 
-  /**
-   * 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;
+    // Replace the default accessibility tags with the context menu's
+    if (this.hot.getSettings().ariaTags) {
+      setAttribute(this.hotMenu.rootElement, [A11Y_MENU()]);
     }
   }
 
@@ -865,5 +654,4 @@ class Menu {
     }
   }
 }
-mixin(Menu, localHooks);
-export default Menu;
+mixin(Menu, localHooks);