handsontable 0.0.0-next-b0a4ea2-20231024 → 0.0.0-next-9059914-20231025

package/plugins/contextMenu/utils.js

@@ -3,15 +3,83 @@
 exports.__esModule = true;
 exports.align = align;
 exports.checkSelectionConsistency = checkSelectionConsistency;
+exports.filterSeparators = filterSeparators;
 exports.getAlignmentClasses = getAlignmentClasses;
-exports.getDocumentOffsetByElement = getDocumentOffsetByElement;
+exports.getValidSelection = getValidSelection;
+exports.hasSubMenu = hasSubMenu;
+exports.isDisabled = isDisabled;
+exports.isItemHidden = isItemHidden;
+exports.isSelectionDisabled = isSelectionDisabled;
+exports.isSeparator = isSeparator;
 exports.markLabelAsSelected = markLabelAsSelected;
+exports.normalizeSelection = normalizeSelection;
 exports.prepareHorizontalAlignClass = prepareHorizontalAlignClass;
 exports.prepareVerticalAlignClass = prepareVerticalAlignClass;
+require("core-js/modules/es.array.push.js");
 var _array = require("../../helpers/array");
+var _element = require("../../helpers/dom/element");
+var _separator = require("./predefinedItems/separator");
+/**
+ * @param {CellRange[]} selRanges An array of the cell ranges.
+ * @returns {object[]}
+ */
+function normalizeSelection(selRanges) {
+  return (0, _array.arrayMap)(selRanges, range => ({
+    start: range.getTopStartCorner(),
+    end: range.getBottomEndCorner()
+  }));
+}
+
+/**
+ * @param {HTMLElement} cell The HTML cell element to check.
+ * @returns {boolean}
+ */
+function isSeparator(cell) {
+  return (0, _element.hasClass)(cell, 'htSeparator');
+}
+
+/**
+ * @param {HTMLElement} cell The HTML cell element to check.
+ * @returns {boolean}
+ */
+function hasSubMenu(cell) {
+  return (0, _element.hasClass)(cell, 'htSubmenu');
+}
+
+/**
+ * @param {HTMLElement} cell The HTML cell element to check.
+ * @returns {boolean}
+ */
+function isDisabled(cell) {
+  return (0, _element.hasClass)(cell, 'htDisabled');
+}
+
+/**
+ * @param {HTMLElement} cell The HTML cell element to check.
+ * @returns {boolean}
+ */
+function isSelectionDisabled(cell) {
+  return (0, _element.hasClass)(cell, 'htSelectionDisabled');
+}
+
+/**
+ * @param {Core} hot The Handsontable instance.
+ * @returns {Array[]|null}
+ */
+function getValidSelection(hot) {
+  const selected = hot.getSelected();
+  if (!selected) {
+    return null;
+  }
+  if (selected[0] < 0) {
+    return null;
+  }
+  return selected;
+}
+
 /**
  * @param {string} className The full element class name to process.
- * @param {string} alignment The alignment class name to compare with.
+ * @param {string} alignment The slignment class name to compare with.
  * @returns {string}
  */
 function prepareVerticalAlignClass(className, alignment) {
@@ -24,7 +92,7 @@ function prepareVerticalAlignClass(className, alignment) {
 
 /**
  * @param {string} className The full element class name to process.
- * @param {string} alignment The alignment class name to compare with.
+ * @param {string} alignment The slignment class name to compare with.
  * @returns {string}
  */
 function prepareHorizontalAlignClass(className, alignment) {
@@ -95,15 +163,6 @@ function applyAlignClassName(row, col, type, alignment, cellDescriptor, property
   propertySetter(row, col, 'className', className);
 }
 
-/**
- * @param {string} label The label text.
- * @returns {string}
- */
-function markLabelAsSelected(label) {
-  // workaround for https://github.com/handsontable/handsontable/issues/1946
-  return `<span class="selected">${String.fromCharCode(10003)}</span>${label}`;
-}
-
 /**
  * @param {CellRange[]} ranges An array of the cell ranges.
  * @param {Function} comparator The comparator function.
@@ -127,28 +186,85 @@ function checkSelectionConsistency(ranges, comparator) {
 }
 
 /**
- * Returns document offset based on the passed element. If the document objects between element and the
- * base document are not the same the offset as top and left properties will be returned.
- *
- * @param {Element} elementToCheck The element to compare with Document object.
- * @param {Document} baseDocument The base Document object.
- * @returns {{ top: number, left: number }}
- */
-function getDocumentOffsetByElement(elementToCheck, baseDocument) {
-  const offset = {
-    top: 0,
-    left: 0
-  };
-  if (baseDocument !== elementToCheck.ownerDocument) {
-    const {
-      frameElement
-    } = baseDocument.defaultView;
-    const {
-      top,
-      left
-    } = frameElement.getBoundingClientRect();
-    offset.top = top;
-    offset.left = left;
+ * @param {string} label The label text.
+ * @returns {string}
+ */
+function markLabelAsSelected(label) {
+  // workaround for https://github.com/handsontable/handsontable/issues/1946
+  return `<span class="selected">${String.fromCharCode(10003)}</span>${label}`;
+}
+
+/**
+ * @param {object} item The object which describes the context menu item properties.
+ * @param {Core} instance The Handsontable instance.
+ * @returns {boolean}
+ */
+function isItemHidden(item, instance) {
+  return !item.hidden || !(typeof item.hidden === 'function' && item.hidden.call(instance));
+}
+
+/**
+ * @param {object[]} items The context menu items collection.
+ * @param {string} separator The string which identifies the context menu separator item.
+ * @returns {object[]}
+ */
+function shiftSeparators(items, separator) {
+  const result = items.slice(0);
+  for (let i = 0; i < result.length;) {
+    if (result[i].name === separator) {
+      result.shift();
+    } else {
+      break;
+    }
   }
-  return offset;
+  return result;
+}
+
+/**
+ * @param {object[]} items The context menu items collection.
+ * @param {string} separator The string which identifies the context menu separator item.
+ * @returns {object[]}
+ */
+function popSeparators(items, separator) {
+  let result = items.slice(0);
+  result.reverse();
+  result = shiftSeparators(result, separator);
+  result.reverse();
+  return result;
+}
+
+/**
+ * Removes duplicated menu separators from the context menu items collection.
+ *
+ * @param {object[]} items The context menu items collection.
+ * @returns {object[]}
+ */
+function removeDuplicatedSeparators(items) {
+  const result = [];
+  (0, _array.arrayEach)(items, (value, index) => {
+    if (index > 0) {
+      if (result[result.length - 1].name !== value.name) {
+        result.push(value);
+      }
+    } else {
+      result.push(value);
+    }
+  });
+  return result;
+}
+
+/**
+ * Removes menu separators from the context menu items collection.
+ *
+ * @param {object[]} items The context menu items collection.
+ * @param {string} separator The string which identifies the context menu separator item.
+ * @returns {object[]}
+ */
+function filterSeparators(items) {
+  let separator = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _separator.KEY;
+  let result = items.slice(0);
+  result = shiftSeparators(result, separator);
+  result = popSeparators(result, separator);
+  result = removeDuplicatedSeparators(result);
+  return result;
 }

package/plugins/contextMenu/utils.mjs

@@ -1,7 +1,68 @@
-import { arrayEach } from "../../helpers/array.mjs";
+import "core-js/modules/es.array.push.js";
+import { arrayEach, arrayMap } from "../../helpers/array.mjs";
+import { hasClass } from "../../helpers/dom/element.mjs";
+import { KEY as SEPARATOR } from "./predefinedItems/separator.mjs";
+/**
+ * @param {CellRange[]} selRanges An array of the cell ranges.
+ * @returns {object[]}
+ */
+export function normalizeSelection(selRanges) {
+  return arrayMap(selRanges, range => ({
+    start: range.getTopStartCorner(),
+    end: range.getBottomEndCorner()
+  }));
+}
+
+/**
+ * @param {HTMLElement} cell The HTML cell element to check.
+ * @returns {boolean}
+ */
+export function isSeparator(cell) {
+  return hasClass(cell, 'htSeparator');
+}
+
+/**
+ * @param {HTMLElement} cell The HTML cell element to check.
+ * @returns {boolean}
+ */
+export function hasSubMenu(cell) {
+  return hasClass(cell, 'htSubmenu');
+}
+
+/**
+ * @param {HTMLElement} cell The HTML cell element to check.
+ * @returns {boolean}
+ */
+export function isDisabled(cell) {
+  return hasClass(cell, 'htDisabled');
+}
+
+/**
+ * @param {HTMLElement} cell The HTML cell element to check.
+ * @returns {boolean}
+ */
+export function isSelectionDisabled(cell) {
+  return hasClass(cell, 'htSelectionDisabled');
+}
+
+/**
+ * @param {Core} hot The Handsontable instance.
+ * @returns {Array[]|null}
+ */
+export function getValidSelection(hot) {
+  const selected = hot.getSelected();
+  if (!selected) {
+    return null;
+  }
+  if (selected[0] < 0) {
+    return null;
+  }
+  return selected;
+}
+
 /**
  * @param {string} className The full element class name to process.
- * @param {string} alignment The alignment class name to compare with.
+ * @param {string} alignment The slignment class name to compare with.
  * @returns {string}
  */
 export function prepareVerticalAlignClass(className, alignment) {
@@ -14,7 +75,7 @@ export function prepareVerticalAlignClass(className, alignment) {
 
 /**
  * @param {string} className The full element class name to process.
- * @param {string} alignment The alignment class name to compare with.
+ * @param {string} alignment The slignment class name to compare with.
  * @returns {string}
  */
 export function prepareHorizontalAlignClass(className, alignment) {
@@ -85,15 +146,6 @@ function applyAlignClassName(row, col, type, alignment, cellDescriptor, property
   propertySetter(row, col, 'className', className);
 }
 
-/**
- * @param {string} label The label text.
- * @returns {string}
- */
-export function markLabelAsSelected(label) {
-  // workaround for https://github.com/handsontable/handsontable/issues/1946
-  return `<span class="selected">${String.fromCharCode(10003)}</span>${label}`;
-}
-
 /**
  * @param {CellRange[]} ranges An array of the cell ranges.
  * @param {Function} comparator The comparator function.
@@ -117,28 +169,85 @@ export function checkSelectionConsistency(ranges, comparator) {
 }
 
 /**
- * Returns document offset based on the passed element. If the document objects between element and the
- * base document are not the same the offset as top and left properties will be returned.
- *
- * @param {Element} elementToCheck The element to compare with Document object.
- * @param {Document} baseDocument The base Document object.
- * @returns {{ top: number, left: number }}
- */
-export function getDocumentOffsetByElement(elementToCheck, baseDocument) {
-  const offset = {
-    top: 0,
-    left: 0
-  };
-  if (baseDocument !== elementToCheck.ownerDocument) {
-    const {
-      frameElement
-    } = baseDocument.defaultView;
-    const {
-      top,
-      left
-    } = frameElement.getBoundingClientRect();
-    offset.top = top;
-    offset.left = left;
+ * @param {string} label The label text.
+ * @returns {string}
+ */
+export function markLabelAsSelected(label) {
+  // workaround for https://github.com/handsontable/handsontable/issues/1946
+  return `<span class="selected">${String.fromCharCode(10003)}</span>${label}`;
+}
+
+/**
+ * @param {object} item The object which describes the context menu item properties.
+ * @param {Core} instance The Handsontable instance.
+ * @returns {boolean}
+ */
+export function isItemHidden(item, instance) {
+  return !item.hidden || !(typeof item.hidden === 'function' && item.hidden.call(instance));
+}
+
+/**
+ * @param {object[]} items The context menu items collection.
+ * @param {string} separator The string which identifies the context menu separator item.
+ * @returns {object[]}
+ */
+function shiftSeparators(items, separator) {
+  const result = items.slice(0);
+  for (let i = 0; i < result.length;) {
+    if (result[i].name === separator) {
+      result.shift();
+    } else {
+      break;
+    }
   }
-  return offset;
+  return result;
+}
+
+/**
+ * @param {object[]} items The context menu items collection.
+ * @param {string} separator The string which identifies the context menu separator item.
+ * @returns {object[]}
+ */
+function popSeparators(items, separator) {
+  let result = items.slice(0);
+  result.reverse();
+  result = shiftSeparators(result, separator);
+  result.reverse();
+  return result;
+}
+
+/**
+ * Removes duplicated menu separators from the context menu items collection.
+ *
+ * @param {object[]} items The context menu items collection.
+ * @returns {object[]}
+ */
+function removeDuplicatedSeparators(items) {
+  const result = [];
+  arrayEach(items, (value, index) => {
+    if (index > 0) {
+      if (result[result.length - 1].name !== value.name) {
+        result.push(value);
+      }
+    } else {
+      result.push(value);
+    }
+  });
+  return result;
+}
+
+/**
+ * Removes menu separators from the context menu items collection.
+ *
+ * @param {object[]} items The context menu items collection.
+ * @param {string} separator The string which identifies the context menu separator item.
+ * @returns {object[]}
+ */
+export function filterSeparators(items) {
+  let separator = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : SEPARATOR;
+  let result = items.slice(0);
+  result = shiftSeparators(result, separator);
+  result = popSeparators(result, separator);
+  result = removeDuplicatedSeparators(result);
+  return result;
 }

package/plugins/copyPaste/contextMenuItem/copy.js

@@ -20,13 +20,6 @@ function copyItem(copyPastePlugin) {
       if (this.countRows() === 0 || this.countCols() === 0) {
         return true;
       }
-      const range = this.getSelectedRangeLast();
-      if (!range) {
-        return true;
-      }
-      if (range.isSingleHeader()) {
-        return true;
-      }
       const selected = this.getSelected();
 
       // Disable for no selection or for non-contiguous selection.

package/plugins/copyPaste/contextMenuItem/copy.mjs

@@ -16,13 +16,6 @@ export default function copyItem(copyPastePlugin) {
       if (this.countRows() === 0 || this.countCols() === 0) {
         return true;
       }
-      const range = this.getSelectedRangeLast();
-      if (!range) {
-        return true;
-      }
-      if (range.isSingleHeader()) {
-        return true;
-      }
       const selected = this.getSelected();
 
       // Disable for no selection or for non-contiguous selection.

package/plugins/copyPaste/contextMenuItem/copyColumnHeadersOnly.js

@@ -3,7 +3,6 @@
 exports.__esModule = true;
 exports.default = copyColumnHeadersOnlyItem;
 var _constants = require("../../../i18n/constants");
-var _number = require("../../../helpers/number");
 /**
  * @param {CopyPaste} copyPastePlugin The plugin instance.
  * @returns {object}
@@ -13,7 +12,7 @@ function copyColumnHeadersOnlyItem(copyPastePlugin) {
     key: 'copy_column_headers_only',
     name() {
       const selectedRange = this.getSelectedRangeLast();
-      const nounForm = selectedRange ? (0, _number.clamp)(selectedRange.getWidth() - 1, 0, 1) : 0;
+      const nounForm = selectedRange ? Math.min(selectedRange.getWidth() - 1, 1) : 0;
       return this.getTranslatedPhrase(_constants.CONTEXTMENU_ITEMS_COPY_COLUMN_HEADERS_ONLY, nounForm);
     },
     callback() {
@@ -23,13 +22,6 @@ function copyColumnHeadersOnlyItem(copyPastePlugin) {
       if (!this.hasColHeaders()) {
         return true;
       }
-      const range = this.getSelectedRangeLast();
-      if (!range) {
-        return true;
-      }
-      if (range.isSingleHeader()) {
-        return true;
-      }
       const selected = this.getSelected();
 
       // Disable for no selection or for non-contiguous selection.

package/plugins/copyPaste/contextMenuItem/copyColumnHeadersOnly.mjs

@@ -1,5 +1,4 @@
 import { CONTEXTMENU_ITEMS_COPY_COLUMN_HEADERS_ONLY } from "../../../i18n/constants.mjs";
-import { clamp } from "../../../helpers/number.mjs";
 /**
  * @param {CopyPaste} copyPastePlugin The plugin instance.
  * @returns {object}
@@ -9,7 +8,7 @@ export default function copyColumnHeadersOnlyItem(copyPastePlugin) {
     key: 'copy_column_headers_only',
     name() {
       const selectedRange = this.getSelectedRangeLast();
-      const nounForm = selectedRange ? clamp(selectedRange.getWidth() - 1, 0, 1) : 0;
+      const nounForm = selectedRange ? Math.min(selectedRange.getWidth() - 1, 1) : 0;
       return this.getTranslatedPhrase(CONTEXTMENU_ITEMS_COPY_COLUMN_HEADERS_ONLY, nounForm);
     },
     callback() {
@@ -19,13 +18,6 @@ export default function copyColumnHeadersOnlyItem(copyPastePlugin) {
       if (!this.hasColHeaders()) {
         return true;
       }
-      const range = this.getSelectedRangeLast();
-      if (!range) {
-        return true;
-      }
-      if (range.isSingleHeader()) {
-        return true;
-      }
       const selected = this.getSelected();
 
       // Disable for no selection or for non-contiguous selection.

package/plugins/copyPaste/contextMenuItem/copyWithColumnGroupHeaders.js

@@ -3,7 +3,6 @@
 exports.__esModule = true;
 exports.default = copyWithColumnGroupHeadersItem;
 var _constants = require("../../../i18n/constants");
-var _number = require("../../../helpers/number");
 /**
  * @param {CopyPaste} copyPastePlugin The plugin instance.
  * @returns {object}
@@ -13,7 +12,7 @@ function copyWithColumnGroupHeadersItem(copyPastePlugin) {
     key: 'copy_with_column_group_headers',
     name() {
       const selectedRange = this.getSelectedRangeLast();
-      const nounForm = selectedRange ? (0, _number.clamp)(selectedRange.getWidth() - 1, 0, 1) : 0;
+      const nounForm = selectedRange ? Math.min(selectedRange.getWidth() - 1, 1) : 0;
       return this.getTranslatedPhrase(_constants.CONTEXTMENU_ITEMS_COPY_WITH_COLUMN_GROUP_HEADERS, nounForm);
     },
     callback() {
@@ -23,13 +22,6 @@ function copyWithColumnGroupHeadersItem(copyPastePlugin) {
       if (!this.hasColHeaders() || !this.getSettings().nestedHeaders) {
         return true;
       }
-      const range = this.getSelectedRangeLast();
-      if (!range) {
-        return true;
-      }
-      if (range.isSingleHeader()) {
-        return true;
-      }
       const selected = this.getSelected();
 
       // Disable for no selection or for non-contiguous selection.

package/plugins/copyPaste/contextMenuItem/copyWithColumnGroupHeaders.mjs

@@ -1,5 +1,4 @@
 import { CONTEXTMENU_ITEMS_COPY_WITH_COLUMN_GROUP_HEADERS } from "../../../i18n/constants.mjs";
-import { clamp } from "../../../helpers/number.mjs";
 /**
  * @param {CopyPaste} copyPastePlugin The plugin instance.
  * @returns {object}
@@ -9,7 +8,7 @@ export default function copyWithColumnGroupHeadersItem(copyPastePlugin) {
     key: 'copy_with_column_group_headers',
     name() {
       const selectedRange = this.getSelectedRangeLast();
-      const nounForm = selectedRange ? clamp(selectedRange.getWidth() - 1, 0, 1) : 0;
+      const nounForm = selectedRange ? Math.min(selectedRange.getWidth() - 1, 1) : 0;
       return this.getTranslatedPhrase(CONTEXTMENU_ITEMS_COPY_WITH_COLUMN_GROUP_HEADERS, nounForm);
     },
     callback() {
@@ -19,13 +18,6 @@ export default function copyWithColumnGroupHeadersItem(copyPastePlugin) {
       if (!this.hasColHeaders() || !this.getSettings().nestedHeaders) {
         return true;
       }
-      const range = this.getSelectedRangeLast();
-      if (!range) {
-        return true;
-      }
-      if (range.isSingleHeader()) {
-        return true;
-      }
       const selected = this.getSelected();
 
       // Disable for no selection or for non-contiguous selection.

package/plugins/copyPaste/contextMenuItem/copyWithColumnHeaders.js

@@ -3,7 +3,6 @@
 exports.__esModule = true;
 exports.default = copyWithColumnHeadersItem;
 var _constants = require("../../../i18n/constants");
-var _number = require("../../../helpers/number");
 /**
  * @param {CopyPaste} copyPastePlugin The plugin instance.
  * @returns {object}
@@ -13,7 +12,7 @@ function copyWithColumnHeadersItem(copyPastePlugin) {
     key: 'copy_with_column_headers',
     name() {
       const selectedRange = this.getSelectedRangeLast();
-      const nounForm = selectedRange ? (0, _number.clamp)(selectedRange.getWidth() - 1, 0, 1) : 0;
+      const nounForm = selectedRange ? Math.min(selectedRange.getWidth() - 1, 1) : 0;
       return this.getTranslatedPhrase(_constants.CONTEXTMENU_ITEMS_COPY_WITH_COLUMN_HEADERS, nounForm);
     },
     callback() {
@@ -23,13 +22,6 @@ function copyWithColumnHeadersItem(copyPastePlugin) {
       if (!this.hasColHeaders()) {
         return true;
       }
-      const range = this.getSelectedRangeLast();
-      if (!range) {
-        return true;
-      }
-      if (range.isSingleHeader()) {
-        return true;
-      }
       const selected = this.getSelected();
 
       // Disable for no selection or for non-contiguous selection.

package/plugins/copyPaste/contextMenuItem/copyWithColumnHeaders.mjs

@@ -1,5 +1,4 @@
 import { CONTEXTMENU_ITEMS_COPY_WITH_COLUMN_HEADERS } from "../../../i18n/constants.mjs";
-import { clamp } from "../../../helpers/number.mjs";
 /**
  * @param {CopyPaste} copyPastePlugin The plugin instance.
  * @returns {object}
@@ -9,7 +8,7 @@ export default function copyWithColumnHeadersItem(copyPastePlugin) {
     key: 'copy_with_column_headers',
     name() {
       const selectedRange = this.getSelectedRangeLast();
-      const nounForm = selectedRange ? clamp(selectedRange.getWidth() - 1, 0, 1) : 0;
+      const nounForm = selectedRange ? Math.min(selectedRange.getWidth() - 1, 1) : 0;
       return this.getTranslatedPhrase(CONTEXTMENU_ITEMS_COPY_WITH_COLUMN_HEADERS, nounForm);
     },
     callback() {
@@ -19,13 +18,6 @@ export default function copyWithColumnHeadersItem(copyPastePlugin) {
       if (!this.hasColHeaders()) {
         return true;
       }
-      const range = this.getSelectedRangeLast();
-      if (!range) {
-        return true;
-      }
-      if (range.isSingleHeader()) {
-        return true;
-      }
       const selected = this.getSelected();
 
       // Disable for no selection or for non-contiguous selection.

package/plugins/copyPaste/contextMenuItem/cut.js

@@ -22,13 +22,6 @@ function cutItem(copyPastePlugin) {
       if (this.countRows() === 0 || this.countCols() === 0) {
         return true;
       }
-      const range = this.getSelectedRangeLast();
-      if (!range) {
-        return true;
-      }
-      if (range.isSingleHeader()) {
-        return true;
-      }
       const selected = this.getSelected();
 
       // Disable for no selection or for non-contiquous selection.

package/plugins/copyPaste/contextMenuItem/cut.mjs

@@ -16,13 +16,6 @@ export default function cutItem(copyPastePlugin) {
       if (this.countRows() === 0 || this.countCols() === 0) {
         return true;
       }
-      const range = this.getSelectedRangeLast();
-      if (!range) {
-        return true;
-      }
-      if (range.isSingleHeader()) {
-        return true;
-      }
       const selected = this.getSelected();
 
       // Disable for no selection or for non-contiquous selection.