handsontable 12.1.3 → 12.3.0-next-bb1a7c2-20221208

package/plugins/contextMenu/contextMenu.js

@@ -1,96 +1,59 @@
 "use strict";
 
 function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
-
 require("core-js/modules/es.object.to-string.js");
-
 require("core-js/modules/es.reflect.construct.js");
-
 require("core-js/modules/es.reflect.get.js");
-
 require("core-js/modules/es.object.get-own-property-descriptor.js");
-
+require("core-js/modules/es.symbol.to-primitive.js");
+require("core-js/modules/es.date.to-primitive.js");
 require("core-js/modules/es.symbol.js");
-
 require("core-js/modules/es.symbol.description.js");
-
+require("core-js/modules/es.number.constructor.js");
 require("core-js/modules/es.symbol.iterator.js");
-
 require("core-js/modules/es.array.iterator.js");
-
 require("core-js/modules/es.string.iterator.js");
-
 require("core-js/modules/web.dom-collections.iterator.js");
-
 exports.__esModule = true;
 exports.PLUGIN_PRIORITY = exports.PLUGIN_KEY = exports.ContextMenu = void 0;
-
 require("core-js/modules/es.array.concat.js");
-
 require("core-js/modules/es.object.set-prototype-of.js");
-
 require("core-js/modules/es.object.get-prototype-of.js");
-
 var _base = require("../base");
-
 var _pluginHooks = _interopRequireDefault(require("../../pluginHooks"));
-
 var _array = require("../../helpers/array");
-
 var _commandExecutor = _interopRequireDefault(require("./commandExecutor"));
-
 var _eventManager = _interopRequireDefault(require("../../eventManager"));
-
 var _itemsFactory = _interopRequireDefault(require("./itemsFactory"));
-
 var _menu = _interopRequireDefault(require("./menu"));
-
 var _element = require("../../helpers/dom/element");
-
 var _predefinedItems = require("./predefinedItems");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
 function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
-
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 function _get() { if (typeof Reflect !== "undefined" && Reflect.get) { _get = Reflect.get.bind(); } else { _get = function _get(target, property, receiver) { var base = _superPropBase(target, property); if (!base) return; var desc = Object.getOwnPropertyDescriptor(base, property); if (desc.get) { return desc.get.call(arguments.length < 3 ? target : receiver); } return desc.value; }; } return _get.apply(this, arguments); }
-
 function _superPropBase(object, property) { while (!Object.prototype.hasOwnProperty.call(object, property)) { object = _getPrototypeOf(object); if (object === null) break; } return object; }
-
 function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); Object.defineProperty(subClass, "prototype", { writable: false }); if (superClass) _setPrototypeOf(subClass, superClass); }
-
 function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
-
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
-
 function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } else if (call !== void 0) { throw new TypeError("Derived constructors may only return object or undefined"); } return _assertThisInitialized(self); }
-
 function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
-
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
-
 function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
-
 var PLUGIN_KEY = 'contextMenu';
 exports.PLUGIN_KEY = PLUGIN_KEY;
 var PLUGIN_PRIORITY = 70;
 exports.PLUGIN_PRIORITY = PLUGIN_PRIORITY;
-
 _pluginHooks.default.getSingleton().register('afterContextMenuDefaultOptions');
-
 _pluginHooks.default.getSingleton().register('beforeContextMenuShow');
-
 _pluginHooks.default.getSingleton().register('afterContextMenuShow');
-
 _pluginHooks.default.getSingleton().register('afterContextMenuHide');
-
 _pluginHooks.default.getSingleton().register('afterContextMenuExecute');
-/* eslint-disable jsdoc/require-description-complete-sentence */
 
+/* eslint-disable jsdoc/require-description-complete-sentence */
 /**
  * @class ContextMenu
  * @description
@@ -100,22 +63,7 @@ _pluginHooks.default.getSingleton().register('afterContextMenuExecute');
  * * `true` (to enable default options),
  * * `false` (to disable completely)
  * * `{ uiContainer: containerDomElement }` (to declare a container for all of the Context Menu's dom elements to be placed in).
- *
- * or array of any available strings:
- * * `'row_above'`
- * * `'row_below'`
- * * `'col_left'`
- * * `'col_right'`
- * * `'remove_row'`
- * * `'remove_col'`
- * * `'undo'`
- * * `'redo'`
- * * `'make_read_only'`
- * * `'alignment'`
- * * `'---------'` (menu item separator)
- * * `'borders'` (with {@link Options#customBorders} turned on)
- * * `'commentsAddEdit'` (with {@link Options#comments} turned on)
- * * `'commentsRemove'` (with {@link Options#comments} turned on).
+ * * An array of [the available strings](@/guides/accessories-and-menus/context-menu.md#context-menu-with-specific-options)
  *
  * See [the context menu demo](@/guides/accessories-and-menus/context-menu.md) for examples.
  *
@@ -129,21 +77,15 @@ _pluginHooks.default.getSingleton().register('afterContextMenuExecute');
  *
  * @plugin ContextMenu
  */
-
-
 var ContextMenu = /*#__PURE__*/function (_BasePlugin) {
   _inherits(ContextMenu, _BasePlugin);
-
   var _super = _createSuper(ContextMenu);
-
   /**
    * @param {Core} hotInstance Handsontable instance.
    */
   function ContextMenu(hotInstance) {
     var _this;
-
     _classCallCheck(this, ContextMenu);
-
     _this = _super.call(this, hotInstance);
     /**
      * Instance of {@link EventManager}.
@@ -151,7 +93,6 @@ var ContextMenu = /*#__PURE__*/function (_BasePlugin) {
      * @private
      * @type {EventManager}
      */
-
     _this.eventManager = new _eventManager.default(_assertThisInitialized(_this));
     /**
      * Instance of {@link CommandExecutor}.
@@ -159,7 +100,6 @@ var ContextMenu = /*#__PURE__*/function (_BasePlugin) {
      * @private
      * @type {CommandExecutor}
      */
-
     _this.commandExecutor = new _commandExecutor.default(_this.hot);
     /**
      * Instance of {@link ItemsFactory}.
@@ -167,7 +107,6 @@ var ContextMenu = /*#__PURE__*/function (_BasePlugin) {
      * @private
      * @type {ItemsFactory}
      */
-
     _this.itemsFactory = null;
     /**
      * Instance of {@link Menu}.
@@ -175,42 +114,36 @@ var ContextMenu = /*#__PURE__*/function (_BasePlugin) {
      * @private
      * @type {Menu}
      */
-
     _this.menu = null;
     return _this;
   }
+
   /**
    * Checks if the plugin is enabled in the handsontable settings. This method is executed in {@link Hooks#beforeInit}
-   * hook and if it returns `true` than the {@link ContextMenu#enablePlugin} method is called.
+   * hook and if it returns `true` then the {@link ContextMenu#enablePlugin} method is called.
    *
    * @returns {boolean}
    */
-
-
   _createClass(ContextMenu, [{
     key: "isEnabled",
     value: function isEnabled() {
       return !!this.hot.getSettings()[PLUGIN_KEY];
     }
+
     /**
      * Enables the plugin functionality for this Handsontable instance.
      */
-
   }, {
     key: "enablePlugin",
     value: function enablePlugin() {
       var _this2 = this;
-
       if (this.enabled) {
         return;
       }
-
       var settings = this.hot.getSettings()[PLUGIN_KEY];
-
       if (typeof settings.callback === 'function') {
         this.commandExecutor.setCommonCallback(settings.callback);
       }
-
       this.menu = new _menu.default(this.hot, {
         className: 'htContextMenu',
         keepInViewport: true,
@@ -227,106 +160,93 @@ var ContextMenu = /*#__PURE__*/function (_BasePlugin) {
       });
       this.menu.addLocalHook('executeCommand', function () {
         var _this2$executeCommand;
-
         for (var _len = arguments.length, params = new Array(_len), _key = 0; _key < _len; _key++) {
           params[_key] = arguments[_key];
         }
-
         return (_this2$executeCommand = _this2.executeCommand).call.apply(_this2$executeCommand, [_this2].concat(params));
       });
       this.addHook('afterOnCellContextMenu', function (event) {
         return _this2.onAfterOnCellContextMenu(event);
       });
-
       _get(_getPrototypeOf(ContextMenu.prototype), "enablePlugin", this).call(this);
     }
+
     /**
      * Updates the plugin's state.
      *
      * This method is executed when [`updateSettings()`](@/api/core.md#updatesettings) is invoked with any of the following configuration options:
      *  - [`contextMenu`](@/api/options.md#contextmenu)
      */
-
   }, {
     key: "updatePlugin",
     value: function updatePlugin() {
       this.disablePlugin();
       this.enablePlugin();
-
       _get(_getPrototypeOf(ContextMenu.prototype), "updatePlugin", this).call(this);
     }
+
     /**
      * Disables the plugin functionality for this Handsontable instance.
      */
-
   }, {
     key: "disablePlugin",
     value: function disablePlugin() {
       this.close();
-
       if (this.menu) {
         this.menu.destroy();
         this.menu = null;
       }
-
       _get(_getPrototypeOf(ContextMenu.prototype), "disablePlugin", this).call(this);
     }
+
     /**
      * Opens menu and re-position it based on the passed coordinates.
      *
      * @param {Event} event The mouse event object.
      */
-
   }, {
     key: "open",
     value: function open(event) {
       if (!this.menu) {
         return;
       }
-
       this.prepareMenuItems();
       this.menu.open();
-
       if (!this.menu.isOpened()) {
         return;
       }
-
       var offsetTop = 0;
       var offsetLeft = 0;
-
       if (this.hot.rootDocument !== this.menu.container.ownerDocument) {
         var frameElement = this.hot.rootWindow.frameElement;
-
         var _frameElement$getBoun = frameElement.getBoundingClientRect(),
-            top = _frameElement$getBoun.top,
-            left = _frameElement$getBoun.left;
-
+          top = _frameElement$getBoun.top,
+          left = _frameElement$getBoun.left;
         offsetTop = top - (0, _element.getWindowScrollTop)(event.view);
         offsetLeft = left - (0, _element.getWindowScrollLeft)(event.view);
       } else {
         offsetTop = -1 * (0, _element.getWindowScrollTop)(this.menu.hotMenu.rootWindow);
         offsetLeft = -1 * (0, _element.getWindowScrollLeft)(this.menu.hotMenu.rootWindow);
       }
-
       this.menu.setPosition({
         top: parseInt(event.pageY, 10) + offsetTop,
         left: parseInt(event.pageX, 10) + offsetLeft
       });
     }
+
     /**
      * Closes the menu.
      */
-
   }, {
     key: "close",
     value: function close() {
       if (!this.menu) {
         return;
       }
-
       this.menu.close();
       this.itemsFactory = null;
     }
+
     /**
      * Execute context menu command.
      *
@@ -357,22 +277,19 @@ var ContextMenu = /*#__PURE__*/function (_BasePlugin) {
      * @param {string} commandName The command name to be executed.
      * @param {*} params Additional parameters passed to command executor module.
      */
-
   }, {
     key: "executeCommand",
     value: function executeCommand(commandName) {
       var _this$commandExecutor;
-
       if (this.itemsFactory === null) {
         this.prepareMenuItems();
       }
-
       for (var _len2 = arguments.length, params = new Array(_len2 > 1 ? _len2 - 1 : 0), _key2 = 1; _key2 < _len2; _key2++) {
         params[_key2 - 1] = arguments[_key2];
       }
-
       (_this$commandExecutor = this.commandExecutor).execute.apply(_this$commandExecutor, [commandName].concat(params));
     }
+
     /**
      * Prepares available contextMenu's items list and registers them in commandExecutor.
      *
@@ -380,12 +297,10 @@ var ContextMenu = /*#__PURE__*/function (_BasePlugin) {
      * @fires Hooks#afterContextMenuDefaultOptions
      * @fires Hooks#beforeContextMenuSetItems
      */
-
   }, {
     key: "prepareMenuItems",
     value: function prepareMenuItems() {
       var _this3 = this;
-
       this.itemsFactory = new _itemsFactory.default(this.hot, ContextMenu.DEFAULT_ITEMS);
       var settings = this.hot.getSettings()[PLUGIN_KEY];
       var predefinedItems = {
@@ -395,100 +310,94 @@ var ContextMenu = /*#__PURE__*/function (_BasePlugin) {
       this.itemsFactory.setPredefinedItems(predefinedItems.items);
       var menuItems = this.itemsFactory.getItems(settings);
       this.hot.runHooks('beforeContextMenuSetItems', menuItems);
-      this.menu.setMenuItems(menuItems); // Register all commands. Predefined and added by user or by plugins
+      this.menu.setMenuItems(menuItems);
 
+      // Register all commands. Predefined and added by user or by plugins
       (0, _array.arrayEach)(menuItems, function (command) {
         return _this3.commandExecutor.registerCommand(command.key, command);
       });
     }
+
     /**
      * On contextmenu listener.
      *
      * @private
      * @param {Event} event The mouse event object.
      */
-
   }, {
     key: "onAfterOnCellContextMenu",
     value: function onAfterOnCellContextMenu(event) {
       var settings = this.hot.getSettings();
       var showRowHeaders = settings.rowHeaders;
       var showColHeaders = settings.colHeaders;
+
       /**
        * @private
        * @param {HTMLElement} element The element to validate.
        * @returns {boolean}
        */
-
       function isValidElement(element) {
         return element.nodeName === 'TD' || element.parentNode.nodeName === 'TD';
       }
-
       var element = event.target;
       this.close();
-
       if ((0, _element.hasClass)(element, 'handsontableInput')) {
         return;
       }
-
       event.preventDefault();
       event.stopPropagation();
-
       if (!(showRowHeaders || showColHeaders)) {
         if (!isValidElement(element) && !((0, _element.hasClass)(element, 'current') && (0, _element.hasClass)(element, 'wtBorder'))) {
           return;
         }
       }
-
       this.open(event);
     }
+
     /**
      * On menu before open listener.
      *
      * @private
      */
-
   }, {
     key: "onMenuBeforeOpen",
     value: function onMenuBeforeOpen() {
       this.hot.runHooks('beforeContextMenuShow', this);
     }
+
     /**
      * On menu after open listener.
      *
      * @private
      */
-
   }, {
     key: "onMenuAfterOpen",
     value: function onMenuAfterOpen() {
       this.hot.runHooks('afterContextMenuShow', this);
     }
+
     /**
      * On menu after close listener.
      *
      * @private
      */
-
   }, {
     key: "onMenuAfterClose",
     value: function onMenuAfterClose() {
       this.hot.listen();
       this.hot.runHooks('afterContextMenuHide', this);
     }
+
     /**
      * Destroys the plugin instance.
      */
-
   }, {
     key: "destroy",
     value: function destroy() {
       this.close();
-
       if (this.menu) {
         this.menu.destroy();
       }
-
       _get(_getPrototypeOf(ContextMenu.prototype), "destroy", this).call(this);
     }
   }], [{
@@ -506,22 +415,20 @@ var ContextMenu = /*#__PURE__*/function (_BasePlugin) {
     get: function get() {
       return ['plugin:AutoColumnSize'];
     }
+
     /**
      * Context menu default items order when `contextMenu` options is set as `true`.
      *
      * @returns {string[]}
      */
-
   }, {
     key: "DEFAULT_ITEMS",
     get: function get() {
       return [_predefinedItems.ROW_ABOVE, _predefinedItems.ROW_BELOW, _predefinedItems.SEPARATOR, _predefinedItems.COLUMN_LEFT, _predefinedItems.COLUMN_RIGHT, _predefinedItems.SEPARATOR, _predefinedItems.REMOVE_ROW, _predefinedItems.REMOVE_COLUMN, _predefinedItems.SEPARATOR, _predefinedItems.UNDO, _predefinedItems.REDO, _predefinedItems.SEPARATOR, _predefinedItems.READ_ONLY, _predefinedItems.SEPARATOR, _predefinedItems.ALIGNMENT];
     }
   }]);
-
   return ContextMenu;
 }(_base.BasePlugin);
-
 exports.ContextMenu = ContextMenu;
 ContextMenu.SEPARATOR = {
   name: _predefinedItems.SEPARATOR