handsontable 0.0.0-next-9ec04ce-20221121

package/plugins/comments/displaySwitch.js

@@ -0,0 +1,115 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+require("core-js/modules/web.timers.js");
+var _function = require("../../helpers/function");
+var _object = require("../../helpers/object");
+var _localHooks = _interopRequireDefault(require("../../mixins/localHooks"));
+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 _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+var DEFAULT_DISPLAY_DELAY = 250;
+var DEFAULT_HIDE_DELAY = 250;
+
+/**
+ * Display switch for the Comments plugin. Manages the time of delayed displaying / hiding comments.
+ *
+ * @private
+ * @class DisplaySwitch
+ */
+var DisplaySwitch = /*#__PURE__*/function () {
+  function DisplaySwitch(displayDelay) {
+    _classCallCheck(this, DisplaySwitch);
+    /**
+     * Flag to determine if comment can be showed or hidden. State `true` mean that last performed action
+     * was an attempt to show comment element. State `false` mean that it was attempt to hide comment element.
+     *
+     * @type {boolean}
+     */
+    this.wasLastActionShow = true;
+    /**
+     * Show comment after predefined delay. It keeps reference to immutable `debounce` function.
+     *
+     * @type {Function}
+     */
+    this.showDebounced = null;
+    /**
+     * Reference to timer, run by `setTimeout`, which is hiding comment.
+     *
+     * @type {number}
+     */
+    this.hidingTimer = null;
+    this.updateDelay(displayDelay);
+  }
+
+  /**
+   * Responsible for hiding comment after proper delay.
+   */
+  _createClass(DisplaySwitch, [{
+    key: "hide",
+    value: function hide() {
+      var _this = this;
+      this.wasLastActionShow = false;
+      this.hidingTimer = setTimeout(function () {
+        if (_this.wasLastActionShow === false) {
+          _this.runLocalHooks('hide');
+        }
+      }, DEFAULT_HIDE_DELAY);
+    }
+
+    /**
+     * Responsible for showing comment after proper delay.
+     *
+     * @param {object} range Coordinates of selected cell.
+     */
+  }, {
+    key: "show",
+    value: function show(range) {
+      this.wasLastActionShow = true;
+      this.showDebounced(range);
+    }
+
+    /**
+     * Cancel hiding comment.
+     */
+  }, {
+    key: "cancelHiding",
+    value: function cancelHiding() {
+      this.wasLastActionShow = true;
+      clearTimeout(this.hidingTimer);
+      this.hidingTimer = null;
+    }
+
+    /**
+     * Update the switch settings.
+     *
+     * @param {number} displayDelay Delay of showing the comments (in milliseconds).
+     */
+  }, {
+    key: "updateDelay",
+    value: function updateDelay() {
+      var _this2 = this;
+      var displayDelay = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : DEFAULT_DISPLAY_DELAY;
+      this.showDebounced = (0, _function.debounce)(function (range) {
+        if (_this2.wasLastActionShow) {
+          _this2.runLocalHooks('show', range.from.row, range.from.col);
+        }
+      }, displayDelay);
+    }
+
+    /**
+     * Destroy the switcher.
+     */
+  }, {
+    key: "destroy",
+    value: function destroy() {
+      this.clearLocalHooks();
+    }
+  }]);
+  return DisplaySwitch;
+}();
+(0, _object.mixin)(DisplaySwitch, _localHooks.default);
+var _default = DisplaySwitch;
+exports.default = _default;

package/plugins/comments/displaySwitch.mjs

@@ -0,0 +1,109 @@
+import "core-js/modules/web.timers.js";
+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 _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+import { debounce } from "../../helpers/function.mjs";
+import { mixin } from "../../helpers/object.mjs";
+import localHooks from "../../mixins/localHooks.mjs";
+var DEFAULT_DISPLAY_DELAY = 250;
+var DEFAULT_HIDE_DELAY = 250;
+
+/**
+ * Display switch for the Comments plugin. Manages the time of delayed displaying / hiding comments.
+ *
+ * @private
+ * @class DisplaySwitch
+ */
+var DisplaySwitch = /*#__PURE__*/function () {
+  function DisplaySwitch(displayDelay) {
+    _classCallCheck(this, DisplaySwitch);
+    /**
+     * Flag to determine if comment can be showed or hidden. State `true` mean that last performed action
+     * was an attempt to show comment element. State `false` mean that it was attempt to hide comment element.
+     *
+     * @type {boolean}
+     */
+    this.wasLastActionShow = true;
+    /**
+     * Show comment after predefined delay. It keeps reference to immutable `debounce` function.
+     *
+     * @type {Function}
+     */
+    this.showDebounced = null;
+    /**
+     * Reference to timer, run by `setTimeout`, which is hiding comment.
+     *
+     * @type {number}
+     */
+    this.hidingTimer = null;
+    this.updateDelay(displayDelay);
+  }
+
+  /**
+   * Responsible for hiding comment after proper delay.
+   */
+  _createClass(DisplaySwitch, [{
+    key: "hide",
+    value: function hide() {
+      var _this = this;
+      this.wasLastActionShow = false;
+      this.hidingTimer = setTimeout(function () {
+        if (_this.wasLastActionShow === false) {
+          _this.runLocalHooks('hide');
+        }
+      }, DEFAULT_HIDE_DELAY);
+    }
+
+    /**
+     * Responsible for showing comment after proper delay.
+     *
+     * @param {object} range Coordinates of selected cell.
+     */
+  }, {
+    key: "show",
+    value: function show(range) {
+      this.wasLastActionShow = true;
+      this.showDebounced(range);
+    }
+
+    /**
+     * Cancel hiding comment.
+     */
+  }, {
+    key: "cancelHiding",
+    value: function cancelHiding() {
+      this.wasLastActionShow = true;
+      clearTimeout(this.hidingTimer);
+      this.hidingTimer = null;
+    }
+
+    /**
+     * Update the switch settings.
+     *
+     * @param {number} displayDelay Delay of showing the comments (in milliseconds).
+     */
+  }, {
+    key: "updateDelay",
+    value: function updateDelay() {
+      var _this2 = this;
+      var displayDelay = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : DEFAULT_DISPLAY_DELAY;
+      this.showDebounced = debounce(function (range) {
+        if (_this2.wasLastActionShow) {
+          _this2.runLocalHooks('show', range.from.row, range.from.col);
+        }
+      }, displayDelay);
+    }
+
+    /**
+     * Destroy the switcher.
+     */
+  }, {
+    key: "destroy",
+    value: function destroy() {
+      this.clearLocalHooks();
+    }
+  }]);
+  return DisplaySwitch;
+}();
+mixin(DisplaySwitch, localHooks);
+export default DisplaySwitch;

package/plugins/comments/index.d.ts

@@ -0,0 +1 @@
+export * from './comments';

package/plugins/comments/index.js

@@ -0,0 +1,8 @@
+"use strict";
+
+exports.__esModule = true;
+exports.PLUGIN_PRIORITY = exports.PLUGIN_KEY = exports.Comments = void 0;
+var _comments = require("./comments");
+exports.PLUGIN_KEY = _comments.PLUGIN_KEY;
+exports.PLUGIN_PRIORITY = _comments.PLUGIN_PRIORITY;
+exports.Comments = _comments.Comments;

package/plugins/comments/index.mjs

@@ -0,0 +1 @@
+export { PLUGIN_KEY, PLUGIN_PRIORITY, Comments } from "./comments.mjs";

package/plugins/contextMenu/commandExecutor.js

@@ -0,0 +1,113 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+require("core-js/modules/es.array.join.js");
+var _array = require("../../helpers/array");
+var _object = require("../../helpers/object");
+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 _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+/**
+ * Command executor for ContextMenu.
+ *
+ * @private
+ * @class CommandExecutor
+ */
+var CommandExecutor = /*#__PURE__*/function () {
+  function CommandExecutor(hotInstance) {
+    _classCallCheck(this, CommandExecutor);
+    this.hot = hotInstance;
+    this.commands = {};
+    this.commonCallback = null;
+  }
+
+  /**
+   * Register command.
+   *
+   * @param {string} name Command name.
+   * @param {object} commandDescriptor Command descriptor object with properties like `key` (command id),
+   *                                   `callback` (task to execute), `name` (command name), `disabled` (command availability).
+   */
+  _createClass(CommandExecutor, [{
+    key: "registerCommand",
+    value: function registerCommand(name, commandDescriptor) {
+      this.commands[name] = commandDescriptor;
+    }
+
+    /**
+     * Set common callback which will be trigger on every executed command.
+     *
+     * @param {Function} callback Function which will be fired on every command execute.
+     */
+  }, {
+    key: "setCommonCallback",
+    value: function setCommonCallback(callback) {
+      this.commonCallback = callback;
+    }
+
+    /**
+     * Execute command by its name.
+     *
+     * @param {string} commandName Command id.
+     * @param {*} params Arguments passed to command task.
+     */
+  }, {
+    key: "execute",
+    value: function execute(commandName) {
+      var _this = this;
+      for (var _len = arguments.length, params = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
+        params[_key - 1] = arguments[_key];
+      }
+      var commandSplit = commandName.split(':');
+      var commandNamePrimary = commandSplit[0];
+      var subCommandName = commandSplit.length === 2 ? commandSplit[1] : null;
+      var command = this.commands[commandNamePrimary];
+      if (!command) {
+        throw new Error("Menu command '".concat(commandNamePrimary, "' not exists."));
+      }
+      if (subCommandName && command.submenu) {
+        command = findSubCommand(subCommandName, command.submenu.items);
+      }
+      if (command.disabled === true) {
+        return;
+      }
+      if (typeof command.disabled === 'function' && command.disabled.call(this.hot) === true) {
+        return;
+      }
+      if ((0, _object.hasOwnProperty)(command, 'submenu')) {
+        return;
+      }
+      var callbacks = [];
+      if (typeof command.callback === 'function') {
+        callbacks.push(command.callback);
+      }
+      if (typeof this.commonCallback === 'function') {
+        callbacks.push(this.commonCallback);
+      }
+      params.unshift(commandSplit.join(':'));
+      (0, _array.arrayEach)(callbacks, function (callback) {
+        return callback.apply(_this.hot, params);
+      });
+    }
+  }]);
+  return CommandExecutor;
+}();
+/**
+ * @param {string} subCommandName The subcommand name.
+ * @param {string[]} subCommands The collection of the commands.
+ * @returns {boolean}
+ */
+function findSubCommand(subCommandName, subCommands) {
+  var command;
+  (0, _array.arrayEach)(subCommands, function (cmd) {
+    var cmds = cmd.key ? cmd.key.split(':') : null;
+    if (Array.isArray(cmds) && cmds[1] === subCommandName) {
+      command = cmd;
+      return false;
+    }
+  });
+  return command;
+}
+var _default = CommandExecutor;
+exports.default = _default;

package/plugins/contextMenu/commandExecutor.mjs

@@ -0,0 +1,108 @@
+import "core-js/modules/es.array.join.js";
+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 _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+import { arrayEach } from "../../helpers/array.mjs";
+import { hasOwnProperty } from "../../helpers/object.mjs";
+/**
+ * Command executor for ContextMenu.
+ *
+ * @private
+ * @class CommandExecutor
+ */
+var CommandExecutor = /*#__PURE__*/function () {
+  function CommandExecutor(hotInstance) {
+    _classCallCheck(this, CommandExecutor);
+    this.hot = hotInstance;
+    this.commands = {};
+    this.commonCallback = null;
+  }
+
+  /**
+   * Register command.
+   *
+   * @param {string} name Command name.
+   * @param {object} commandDescriptor Command descriptor object with properties like `key` (command id),
+   *                                   `callback` (task to execute), `name` (command name), `disabled` (command availability).
+   */
+  _createClass(CommandExecutor, [{
+    key: "registerCommand",
+    value: function registerCommand(name, commandDescriptor) {
+      this.commands[name] = commandDescriptor;
+    }
+
+    /**
+     * Set common callback which will be trigger on every executed command.
+     *
+     * @param {Function} callback Function which will be fired on every command execute.
+     */
+  }, {
+    key: "setCommonCallback",
+    value: function setCommonCallback(callback) {
+      this.commonCallback = callback;
+    }
+
+    /**
+     * Execute command by its name.
+     *
+     * @param {string} commandName Command id.
+     * @param {*} params Arguments passed to command task.
+     */
+  }, {
+    key: "execute",
+    value: function execute(commandName) {
+      var _this = this;
+      for (var _len = arguments.length, params = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
+        params[_key - 1] = arguments[_key];
+      }
+      var commandSplit = commandName.split(':');
+      var commandNamePrimary = commandSplit[0];
+      var subCommandName = commandSplit.length === 2 ? commandSplit[1] : null;
+      var command = this.commands[commandNamePrimary];
+      if (!command) {
+        throw new Error("Menu command '".concat(commandNamePrimary, "' not exists."));
+      }
+      if (subCommandName && command.submenu) {
+        command = findSubCommand(subCommandName, command.submenu.items);
+      }
+      if (command.disabled === true) {
+        return;
+      }
+      if (typeof command.disabled === 'function' && command.disabled.call(this.hot) === true) {
+        return;
+      }
+      if (hasOwnProperty(command, 'submenu')) {
+        return;
+      }
+      var callbacks = [];
+      if (typeof command.callback === 'function') {
+        callbacks.push(command.callback);
+      }
+      if (typeof this.commonCallback === 'function') {
+        callbacks.push(this.commonCallback);
+      }
+      params.unshift(commandSplit.join(':'));
+      arrayEach(callbacks, function (callback) {
+        return callback.apply(_this.hot, params);
+      });
+    }
+  }]);
+  return CommandExecutor;
+}();
+/**
+ * @param {string} subCommandName The subcommand name.
+ * @param {string[]} subCommands The collection of the commands.
+ * @returns {boolean}
+ */
+function findSubCommand(subCommandName, subCommands) {
+  var command;
+  arrayEach(subCommands, function (cmd) {
+    var cmds = cmd.key ? cmd.key.split(':') : null;
+    if (Array.isArray(cmds) && cmds[1] === subCommandName) {
+      command = cmd;
+      return false;
+    }
+  });
+  return command;
+}
+export default CommandExecutor;

package/plugins/contextMenu/contextMenu.d.ts

@@ -0,0 +1,65 @@
+import CellCoords from '../../3rdparty/walkontable/src/cell/coords';
+import Core from '../../core';
+import { BasePlugin } from '../base';
+
+export type PredefinedMenuItemKey = 'row_above' | 'row_below' | 'col_left' | 'col_right' |
+  '---------' | 'remove_row' | 'remove_col' | 'clear_column' | 'undo' | 'redo' |
+  'make_read_only' | 'alignment' | 'cut' | 'copy' | 'freeze_column' | 'unfreeze_column' |
+  'borders' | 'commentsAddEdit' | 'commentsRemove' | 'commentsReadOnly' | 'mergeCells' |
+  'add_child' | 'detach_from_parent' | 'hidden_columns_hide' | 'hidden_columns_show' |
+  'hidden_rows_hide' | 'hidden_rows_show' | 'filter_by_condition' | 'filter_operators' |
+  'filter_by_condition2' | 'filter_by_value' | 'filter_action_bar';
+
+export interface SeparatorObject {
+  name: string;
+}
+
+export interface Selection {
+  start: CellCoords;
+  end: CellCoords;
+}
+
+export interface MenuConfig {
+  [key: string]: MenuItemConfig;
+}
+
+export interface MenuItemConfig {
+  name?: string | ((this: Core) => string);
+  key?: string;
+  hidden?: boolean | ((this: Core) => boolean | void);
+  disabled?: boolean | ((this: Core) => boolean | void);
+  disableSelection?: boolean;
+  isCommand?: boolean;
+  callback?(this: Core, key: string, selection: Selection[], clickEvent: MouseEvent): void;
+  renderer?(this: MenuItemConfig, hot: Core, wrapper: HTMLElement, row: number, col: number, prop: number | string, itemValue: string): HTMLElement;
+  submenu?: SubmenuConfig;
+}
+
+export interface SubmenuConfig {
+  items: SubmenuItemConfig[];
+}
+
+export interface SubmenuItemConfig extends Omit<MenuItemConfig, "key"> {
+  /**
+   * Submenu item `key` must be defined as "parent_key:sub_key" where "parent_key" is the parent MenuItemConfig key.
+   */
+  key: string;
+}
+
+export interface DetailedSettings {
+  callback?: (key: string, selection: Selection[], clickEvent: MouseEvent) => void;
+  items: PredefinedMenuItemKey[] | MenuConfig;
+}
+
+export type Settings = boolean | PredefinedMenuItemKey[] | DetailedSettings;
+
+export class ContextMenu extends BasePlugin {
+  static DEFAULT_ITEMS: PredefinedMenuItemKey[];
+  static SEPARATOR: SeparatorObject;
+
+  constructor(hotInstance: Core);
+  isEnabled(): boolean;
+  open(event: Event): void;
+  close(): void;
+  executeCommand(commandName: string, ...params: any): void;
+}