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

package/plugins/copyPaste/copyPaste.js

@@ -9,15 +9,16 @@ var _SheetClip = require("../../3rdparty/SheetClip");
 var _array = require("../../helpers/array");
 var _string = require("../../helpers/string");
 var _element = require("../../helpers/dom/element");
+var _browser = require("../../helpers/browser");
 var _copy = _interopRequireDefault(require("./contextMenuItem/copy"));
 var _copyColumnHeadersOnly = _interopRequireDefault(require("./contextMenuItem/copyColumnHeadersOnly"));
 var _copyWithColumnGroupHeaders = _interopRequireDefault(require("./contextMenuItem/copyWithColumnGroupHeaders"));
 var _copyWithColumnHeaders = _interopRequireDefault(require("./contextMenuItem/copyWithColumnHeaders"));
 var _cut = _interopRequireDefault(require("./contextMenuItem/cut"));
 var _pasteEvent = _interopRequireDefault(require("./pasteEvent"));
-var _focusableElement = require("./focusableElement");
 var _copyableRanges = require("./copyableRanges");
 var _parseTable = require("../../utils/parseTable");
+var _eventManager = _interopRequireDefault(require("../../eventManager"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function _classPrivateMethodInitSpec(obj, privateSet) { _checkPrivateRedeclaration(obj, privateSet); privateSet.add(obj); }
 function _classPrivateFieldInitSpec(obj, privateMap, value) { _checkPrivateRedeclaration(obj, privateMap); privateMap.set(obj, value); }
@@ -25,9 +26,9 @@ function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollect
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 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 _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 _classPrivateMethodGet(receiver, privateSet, fn) { if (!privateSet.has(receiver)) { throw new TypeError("attempted to get private field on non-instance"); } return fn; }
 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; } }
@@ -88,10 +89,21 @@ var _copyMode = /*#__PURE__*/new WeakMap();
 var _isTriggeredByCopy = /*#__PURE__*/new WeakMap();
 var _isTriggeredByCut = /*#__PURE__*/new WeakMap();
 var _copyableRangesFactory = /*#__PURE__*/new WeakMap();
+var _ensureClipboardEventsGetTriggered = /*#__PURE__*/new WeakSet();
 var _countCopiedHeaders = /*#__PURE__*/new WeakSet();
+var _addContentEditableToHighlightedCell = /*#__PURE__*/new WeakSet();
+var _removeContentEditableFromHighlightedCell = /*#__PURE__*/new WeakSet();
 class CopyPaste extends _base.BasePlugin {
   constructor() {
     super(...arguments);
+    /**
+     * Remove the `contenteditable` attribute from the highlighted cell and deselect its content.
+     */
+    _classPrivateMethodInitSpec(this, _removeContentEditableFromHighlightedCell);
+    /**
+     * Add the `contenteditable` attribute to the highlighted cell and select its content.
+     */
+    _classPrivateMethodInitSpec(this, _addContentEditableToHighlightedCell);
     /**
      * Counts how many column headers will be copied based on the passed range.
      *
@@ -101,6 +113,12 @@ class CopyPaste extends _base.BasePlugin {
      *                                           information with the number of copied headers.
      */
     _classPrivateMethodInitSpec(this, _countCopiedHeaders);
+    /**
+     * Ensure that the `copy`/`cut` events get triggered properly in Safari.
+     *
+     * @param {string} eventName Name of the event to get triggered.
+     */
+    _classPrivateMethodInitSpec(this, _ensureClipboardEventsGetTriggered);
     /**
      * The maximum number of columns than can be copied to the clipboard.
      *
@@ -218,13 +236,6 @@ class CopyPaste extends _base.BasePlugin {
      * @type {Array<{startRow: number, startCol: number, endRow: number, endCol: number}>}
      */
     _defineProperty(this, "copyableRanges", []);
-    /**
-     * Provides focusable element to support IME and copy/paste/cut actions.
-     *
-     * @private
-     * @type {FocusableWrapper}
-     */
-    _defineProperty(this, "focusableElement", void 0);
   }
   static get PLUGIN_KEY() {
     return PLUGIN_KEY;
@@ -251,6 +262,7 @@ class CopyPaste extends _base.BasePlugin {
    * Enables the [`CopyPaste`](#copypaste) plugin for your Handsontable instance.
    */
   enablePlugin() {
+    var _this = this;
     if (this.enabled) {
       return;
     }
@@ -268,11 +280,28 @@ class CopyPaste extends _base.BasePlugin {
       this.uiContainer = (_settings$uiContainer = settings.uiContainer) !== null && _settings$uiContainer !== void 0 ? _settings$uiContainer : this.uiContainer;
     }
     this.addHook('afterContextMenuDefaultOptions', options => this.onAfterContextMenuDefaultOptions(options));
-    this.addHook('afterOnCellMouseUp', () => this.onAfterOnCellMouseUp());
     this.addHook('afterSelectionEnd', () => this.onAfterSelectionEnd());
-    this.addHook('beforeKeyDown', () => this.onBeforeKeyDown());
-    this.focusableElement = (0, _focusableElement.createElement)(this.uiContainer);
-    this.focusableElement.addLocalHook('copy', event => this.onCopy(event)).addLocalHook('cut', event => this.onCut(event)).addLocalHook('paste', event => this.onPaste(event));
+    this.eventManager = new _eventManager.default(this);
+    this.eventManager.addEventListener(this.hot.rootDocument, 'copy', function () {
+      return _this.onCopy(...arguments);
+    });
+    this.eventManager.addEventListener(this.hot.rootDocument, 'cut', function () {
+      return _this.onCut(...arguments);
+    });
+    this.eventManager.addEventListener(this.hot.rootDocument, 'paste', function () {
+      return _this.onPaste(...arguments);
+    });
+
+    // Without this workaround Safari (tested on Safari@16.5.2) does allow copying/cutting from the browser menu.
+    if ((0, _browser.isSafari)()) {
+      this.eventManager.addEventListener(this.hot.rootDocument.body, 'mouseenter', function () {
+        return _this.onSafariMouseEnter(...arguments);
+      });
+      this.eventManager.addEventListener(this.hot.rootDocument.body, 'mouseleave', function () {
+        return _this.onSafariMouseLeave(...arguments);
+      });
+      this.addHook('afterSelection', () => this.onSafariAfterSelection());
+    }
     super.enablePlugin();
   }
 
@@ -287,7 +316,6 @@ class CopyPaste extends _base.BasePlugin {
   updatePlugin() {
     this.disablePlugin();
     this.enablePlugin();
-    this.getOrCreateFocusableElement();
     super.updatePlugin();
   }
 
@@ -295,9 +323,6 @@ class CopyPaste extends _base.BasePlugin {
    * Disables the [`CopyPaste`](#copypaste) plugin for your Handsontable instance.
    */
   disablePlugin() {
-    if (this.focusableElement) {
-      (0, _focusableElement.destroyElement)(this.focusableElement);
-    }
     super.disablePlugin();
   }
 
@@ -319,9 +344,7 @@ class CopyPaste extends _base.BasePlugin {
     let copyMode = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'cells-only';
     _classPrivateFieldSet(this, _copyMode, copyMode);
     _classPrivateFieldSet(this, _isTriggeredByCopy, true);
-    this.getOrCreateFocusableElement();
-    this.focusableElement.focus();
-    this.hot.rootDocument.execCommand('copy');
+    _classPrivateMethodGet(this, _ensureClipboardEventsGetTriggered, _ensureClipboardEventsGetTriggered2).call(this, 'copy');
   }
 
   /**
@@ -354,9 +377,7 @@ class CopyPaste extends _base.BasePlugin {
    */
   cut() {
     _classPrivateFieldSet(this, _isTriggeredByCut, true);
-    this.getOrCreateFocusableElement();
-    this.focusableElement.focus();
-    this.hot.rootDocument.execCommand('cut');
+    _classPrivateMethodGet(this, _ensureClipboardEventsGetTriggered, _ensureClipboardEventsGetTriggered2).call(this, 'cut');
   }
 
   /**
@@ -419,7 +440,6 @@ class CopyPaste extends _base.BasePlugin {
     if (pastableHtml) {
       pasteData.clipboardData.setData('text/html', pastableHtml);
     }
-    this.getOrCreateFocusableElement();
     this.onPaste(pasteData);
   }
 
@@ -431,6 +451,10 @@ class CopyPaste extends _base.BasePlugin {
     if (!selectionRange) {
       return;
     }
+    if (selectionRange.isSingleHeader()) {
+      this.copyableRanges = [];
+      return;
+    }
     _classPrivateFieldGet(this, _copyableRangesFactory).setSelectedRange(selectionRange);
     const groupedRanges = new Map([['headers', null], ['cells', null]]);
     if (_classPrivateFieldGet(this, _copyMode) === 'column-headers-only') {
@@ -470,21 +494,6 @@ class CopyPaste extends _base.BasePlugin {
     }
   }
 
-  /**
-   * Force focus on editable element.
-   *
-   * @private
-   */
-  getOrCreateFocusableElement() {
-    var _this$hot$getActiveEd;
-    const editableElement = (_this$hot$getActiveEd = this.hot.getActiveEditor()) === null || _this$hot$getActiveEd === void 0 ? void 0 : _this$hot$getActiveEd.TEXTAREA;
-    if (editableElement) {
-      this.focusableElement.setFocusableElement(editableElement);
-    } else {
-      this.focusableElement.useSecondaryElement();
-    }
-  }
-
   /**
    * Verifies if editor exists and is open.
    *
@@ -492,8 +501,8 @@ class CopyPaste extends _base.BasePlugin {
    * @returns {boolean}
    */
   isEditorOpened() {
-    var _this$hot$getActiveEd2;
-    return (_this$hot$getActiveEd2 = this.hot.getActiveEditor()) === null || _this$hot$getActiveEd2 === void 0 ? void 0 : _this$hot$getActiveEd2.isOpened();
+    var _this$hot$getActiveEd;
+    return (_this$hot$getActiveEd = this.hot.getActiveEditor()) === null || _this$hot$getActiveEd === void 0 ? void 0 : _this$hot$getActiveEd.isOpened();
   }
   /**
    * Prepares new values to populate them into datasource.
@@ -560,7 +569,6 @@ class CopyPaste extends _base.BasePlugin {
     this.hot.populateFromArray(startRow, startColumn, newRows, void 0, void 0, 'CopyPaste.paste', this.pasteMode);
     return [startRow, startColumn, lastVisualRow, lastVisualColumn];
   }
-
   /**
    * `copy` event callback on textarea element.
    *
@@ -627,7 +635,7 @@ class CopyPaste extends _base.BasePlugin {
    * @private
    */
   onPaste(event) {
-    if (!this.hot.isListening() || this.isEditorOpened()) {
+    if (!this.hot.isListening() || this.isEditorOpened() || !this.hot.getSelected()) {
       return;
     }
     if (event && event.preventDefault) {
@@ -652,7 +660,7 @@ class CopyPaste extends _base.BasePlugin {
     if (typeof pastedData === 'string') {
       pastedData = (0, _SheetClip.parse)(pastedData);
     }
-    if (pastedData && pastedData.length === 0) {
+    if (pastedData === void 0 || pastedData && pastedData.length === 0) {
       return;
     }
     if (this.hot.runHooks('beforePaste', pastedData, this.copyableRanges) === false) {
@@ -685,21 +693,6 @@ class CopyPaste extends _base.BasePlugin {
     options.items.push((0, _cut.default)(this));
   }
 
-  /**
-   * Force focus on focusableElement.
-   *
-   * @private
-   */
-  onAfterOnCellMouseUp() {
-    // Changing focused element will remove current selection. It's unnecessary in case when we give possibility
-    // for fragment selection
-    if (!this.hot.isListening() || this.isEditorOpened() || this.hot.getSettings().fragmentSelection) {
-      return;
-    }
-    this.getOrCreateFocusableElement();
-    this.focusableElement.focus();
-  }
-
   /**
    * Force focus on focusableElement after end of the selection.
    *
@@ -709,44 +702,69 @@ class CopyPaste extends _base.BasePlugin {
     if (this.isEditorOpened()) {
       return;
     }
-    this.getOrCreateFocusableElement();
-    if (this.hot.getSettings().fragmentSelection && this.focusableElement.getFocusableElement() !== this.hot.rootDocument.activeElement && (0, _element.getSelectionText)()) {
+    if (this.hot.getSettings().fragmentSelection) {
       return;
     }
     this.setCopyableText();
-    this.focusableElement.focus();
   }
 
   /**
-   * `beforeKeyDown` listener to force focus of focusableElement.
+   * `document.body` `mouseenter` callback used to work around a Safari's problem with copying/cutting from the
+   * browser's menu.
    *
    * @private
    */
-  onBeforeKeyDown() {
-    if (!this.hot.isListening() || this.isEditorOpened()) {
-      return;
-    }
-    const activeElement = this.hot.rootDocument.activeElement;
-    const activeEditor = this.hot.getActiveEditor();
-    if (!activeEditor || activeElement !== this.focusableElement.getFocusableElement() && activeElement !== activeEditor.select) {
-      return;
-    }
-    this.getOrCreateFocusableElement();
-    this.focusableElement.focus();
+  onSafariMouseEnter() {
+    _classPrivateMethodGet(this, _removeContentEditableFromHighlightedCell, _removeContentEditableFromHighlightedCell2).call(this);
+  }
+
+  /**
+   * `document.body` `mouseleave` callback used to work around a Safari's problem with copying/cutting from the
+   * browser's menu.
+   *
+   * @private
+   */
+  onSafariMouseLeave() {
+    _classPrivateMethodGet(this, _addContentEditableToHighlightedCell, _addContentEditableToHighlightedCell2).call(this);
+  }
+
+  /**
+   * `afterSelection` hook callback triggered only on Safari.
+   *
+   * @private
+   */
+  onSafariAfterSelection() {
+    _classPrivateMethodGet(this, _removeContentEditableFromHighlightedCell, _removeContentEditableFromHighlightedCell2).call(this);
   }
 
   /**
    * Destroys the `CopyPaste` plugin instance.
    */
   destroy() {
-    if (this.focusableElement) {
-      (0, _focusableElement.destroyElement)(this.focusableElement);
-      this.focusableElement = null;
-    }
     super.destroy();
   }
 }
 exports.CopyPaste = CopyPaste;
+function _ensureClipboardEventsGetTriggered2(eventName) {
+  // Without this workaround Safari (tested on Safari@16.5.2) does not trigger the 'copy' event.
+  if ((0, _browser.isSafari)()) {
+    const lastSelectedRange = this.hot.getSelectedRangeLast();
+    if (lastSelectedRange) {
+      const {
+        row: highlightRow,
+        col: highlightColumn
+      } = lastSelectedRange.highlight;
+      const currentlySelectedCell = this.hot.getCell(highlightRow, highlightColumn, true);
+      if (currentlySelectedCell) {
+        (0, _element.runWithSelectedContendEditableElement)(currentlySelectedCell, () => {
+          this.hot.rootDocument.execCommand(eventName);
+        });
+      }
+    }
+  } else {
+    this.hot.rootDocument.execCommand(eventName);
+  }
+}
 function _countCopiedHeaders2(ranges) {
   const {
     rows
@@ -761,4 +779,35 @@ function _countCopiedHeaders2(ranges) {
   return {
     columnHeadersCount
   };
+}
+function _addContentEditableToHighlightedCell2() {
+  if (this.hot.isListening()) {
+    const lastSelectedRange = this.hot.getSelectedRangeLast();
+    if (lastSelectedRange) {
+      const {
+        row: highlightRow,
+        col: highlightColumn
+      } = lastSelectedRange.highlight;
+      const currentlySelectedCell = this.hot.getCell(highlightRow, highlightColumn, true);
+      if (currentlySelectedCell) {
+        (0, _element.makeElementContentEditableAndSelectItsContent)(currentlySelectedCell);
+      }
+    }
+  }
+}
+function _removeContentEditableFromHighlightedCell2() {
+  // If the instance is not listening, the workaround is not needed.
+  if (this.hot.isListening()) {
+    const lastSelectedRange = this.hot.getSelectedRangeLast();
+    if (lastSelectedRange) {
+      const {
+        row: highlightRow,
+        col: highlightColumn
+      } = lastSelectedRange.highlight;
+      const currentlySelectedCell = this.hot.getCell(highlightRow, highlightColumn, true);
+      if (currentlySelectedCell !== null && currentlySelectedCell !== void 0 && currentlySelectedCell.hasAttribute('contenteditable')) {
+        (0, _element.removeContentEditableFromElementAndDeselect)(currentlySelectedCell);
+      }
+    }
+  }
 }