handsontable 12.1.3 → 12.2.0

package/plugins/hiddenColumns/hiddenColumns.mjs

@@ -1,5 +1,4 @@
 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); }
-
 import "core-js/modules/es.array.concat.js";
 import "core-js/modules/es.array.slice.js";
 import "core-js/modules/es.array.map.js";
@@ -23,45 +22,25 @@ import "core-js/modules/es.object.get-own-property-descriptor.js";
 import "core-js/modules/es.symbol.js";
 import "core-js/modules/es.symbol.description.js";
 import "core-js/modules/es.symbol.iterator.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; }
-
 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); }
-
 function _classPrivateFieldInitSpec(obj, privateMap, value) { _checkPrivateRedeclaration(obj, privateMap); privateMap.set(obj, value); }
-
 function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
-
 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 _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; } }
-
 import { BasePlugin } from "../base/index.mjs";
 import { addClass } from "../../helpers/dom/element.mjs";
 import { rangeEach } from "../../helpers/number.mjs";
@@ -79,6 +58,7 @@ Hooks.getSingleton().register('beforeUnhideColumns');
 Hooks.getSingleton().register('afterUnhideColumns');
 export var PLUGIN_KEY = 'hiddenColumns';
 export var PLUGIN_PRIORITY = 310;
+
 /* eslint-disable jsdoc/require-description-complete-sentence */
 
 /**
@@ -104,6 +84,7 @@ export var PLUGIN_PRIORITY = 310;
  *
  * @example
  *
+ * ::: only-for javascript
  * ```js
  * const container = document.getElementById('example');
  * const hot = new Handsontable(container, {
@@ -139,82 +120,107 @@ export var PLUGIN_PRIORITY = 310;
  * // to see your changes, re-render your Handsontable instance
  * hot.render();
  * ```
+ * :::
+ *
+ * ::: only-for react
+ * ```jsx
+ * const hotRef = useRef(null);
+ *
+ * ...
+ *
+ * <HotTable
+ *   ref={hotRef}
+ *   data={getData()}
+ *   hiddenColumns={{
+ *     copyPasteEnabled: true,
+ *     indicators: true,
+ *     columns: [1, 2, 5]
+ *   }}
+ * />
+ *
+ * // access the `HiddenColumns` plugin's instance
+ * const hot = hotRef.current.hotInstance;
+ * const hiddenColumnsPlugin = hot.getPlugin('hiddenColumns');
+ *
+ * // hide a single column
+ * hiddenColumnsPlugin.hideColumn(1);
+ *
+ * // hide multiple columns
+ * hiddenColumnsPlugin.hideColumn(1, 2, 9);
+ *
+ * // hide multiple columns as an array
+ * hiddenColumnsPlugin.hideColumns([1, 2, 9]);
+ *
+ * // unhide a single column
+ * hiddenColumnsPlugin.showColumn(1);
+ *
+ * // unhide multiple columns
+ * hiddenColumnsPlugin.showColumn(1, 2, 9);
+ *
+ * // unhide multiple columns as an array
+ * hiddenColumnsPlugin.showColumns([1, 2, 9]);
+ *
+ * // to see your changes, re-render your Handsontable instance
+ * hot.render();
+ * ```
+ * :::
  */
-
 var _settings = /*#__PURE__*/new WeakMap();
-
 var _hiddenColumnsMap = /*#__PURE__*/new WeakMap();
-
 export var HiddenColumns = /*#__PURE__*/function (_BasePlugin) {
   _inherits(HiddenColumns, _BasePlugin);
-
   var _super = _createSuper(HiddenColumns);
-
   function HiddenColumns() {
     var _this;
-
     _classCallCheck(this, HiddenColumns);
-
     for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
       args[_key] = arguments[_key];
     }
-
     _this = _super.call.apply(_super, [this].concat(args));
-
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _settings, {
       writable: true,
       value: {}
     });
-
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _hiddenColumnsMap, {
       writable: true,
       value: null
     });
-
     return _this;
   }
-
   _createClass(HiddenColumns, [{
     key: "isEnabled",
     value:
     /**
      * 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 HiddenColumns#enablePlugin} method is called.
+     * hook and if it returns `true` then the {@link HiddenColumns#enablePlugin} method is called.
      *
      * @returns {boolean}
      */
     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 pluginSettings = this.hot.getSettings()[PLUGIN_KEY];
-
       if (isObject(pluginSettings)) {
         _classPrivateFieldSet(this, _settings, pluginSettings);
-
         if (isUndefined(pluginSettings.copyPasteEnabled)) {
           pluginSettings.copyPasteEnabled = true;
         }
       }
-
       _classPrivateFieldSet(this, _hiddenColumnsMap, new HidingMap());
-
       _classPrivateFieldGet(this, _hiddenColumnsMap).addLocalHook('init', function () {
         return _this2.onMapInit();
       });
-
       this.hot.columnIndexMapper.registerMap(this.pluginName, _classPrivateFieldGet(this, _hiddenColumnsMap));
       this.addHook('afterContextMenuDefaultOptions', function () {
         return _this2.onAfterContextMenuDefaultOptions.apply(_this2, arguments);
@@ -231,130 +237,113 @@ export var HiddenColumns = /*#__PURE__*/function (_BasePlugin) {
       this.addHook('modifyCopyableRange', function (ranges) {
         return _this2.onModifyCopyableRange(ranges);
       });
-
       _get(_getPrototypeOf(HiddenColumns.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:
      *  - [`hiddenColumns`](@/api/options.md#hiddencolumns)
      */
-
   }, {
     key: "updatePlugin",
     value: function updatePlugin() {
       this.disablePlugin();
       this.enablePlugin();
-
       _get(_getPrototypeOf(HiddenColumns.prototype), "updatePlugin", this).call(this);
     }
+
     /**
      * Disables the plugin functionality for this Handsontable instance.
      */
-
   }, {
     key: "disablePlugin",
     value: function disablePlugin() {
       this.hot.columnIndexMapper.unregisterMap(this.pluginName);
-
       _classPrivateFieldSet(this, _settings, {});
-
       _get(_getPrototypeOf(HiddenColumns.prototype), "disablePlugin", this).call(this);
-
       this.resetCellsMeta();
     }
+
     /**
      * Shows the provided columns.
      *
      * @param {number[]} columns Array of visual column indexes.
      */
-
   }, {
     key: "showColumns",
     value: function showColumns(columns) {
       var _this3 = this;
-
       var currentHideConfig = this.getHiddenColumns();
       var isValidConfig = this.isValidConfig(columns);
       var destinationHideConfig = currentHideConfig;
-
       var hidingMapValues = _classPrivateFieldGet(this, _hiddenColumnsMap).getValues().slice();
-
       var isAnyColumnShowed = columns.length > 0;
-
       if (isValidConfig && isAnyColumnShowed) {
         var physicalColumns = columns.map(function (visualColumn) {
           return _this3.hot.toPhysicalColumn(visualColumn);
-        }); // Preparing new values for hiding map.
+        });
 
+        // Preparing new values for hiding map.
         arrayEach(physicalColumns, function (physicalColumn) {
           hidingMapValues[physicalColumn] = false;
-        }); // Preparing new hiding config.
+        });
 
+        // Preparing new hiding config.
         destinationHideConfig = arrayReduce(hidingMapValues, function (hiddenIndexes, isHidden, physicalIndex) {
           if (isHidden) {
             hiddenIndexes.push(_this3.hot.toVisualColumn(physicalIndex));
           }
-
           return hiddenIndexes;
         }, []);
       }
-
       var continueHiding = this.hot.runHooks('beforeUnhideColumns', currentHideConfig, destinationHideConfig, isValidConfig && isAnyColumnShowed);
-
       if (continueHiding === false) {
         return;
       }
-
       if (isValidConfig && isAnyColumnShowed) {
         _classPrivateFieldGet(this, _hiddenColumnsMap).setValues(hidingMapValues);
-      } // @TODO Should call once per render cycle, currently fired separately in different plugins
-
+      }
 
+      // @TODO Should call once per render cycle, currently fired separately in different plugins
       this.hot.view.adjustElementsSize();
       this.hot.runHooks('afterUnhideColumns', currentHideConfig, destinationHideConfig, isValidConfig && isAnyColumnShowed, isValidConfig && destinationHideConfig.length < currentHideConfig.length);
     }
+
     /**
      * Shows a single column.
      *
      * @param {...number} column Visual column index.
      */
-
   }, {
     key: "showColumn",
     value: function showColumn() {
       for (var _len2 = arguments.length, column = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
         column[_key2] = arguments[_key2];
       }
-
       this.showColumns(column);
     }
+
     /**
      * Hides the columns provided in the array.
      *
      * @param {number[]} columns Array of visual column indexes.
      */
-
   }, {
     key: "hideColumns",
     value: function hideColumns(columns) {
       var _this4 = this;
-
       var currentHideConfig = this.getHiddenColumns();
       var isConfigValid = this.isValidConfig(columns);
       var destinationHideConfig = currentHideConfig;
-
       if (isConfigValid) {
         destinationHideConfig = Array.from(new Set(currentHideConfig.concat(columns)));
       }
-
       var continueHiding = this.hot.runHooks('beforeHideColumns', currentHideConfig, destinationHideConfig, isConfigValid);
-
       if (continueHiding === false) {
         return;
       }
-
       if (isConfigValid) {
         this.hot.batchExecution(function () {
           arrayEach(columns, function (visualColumn) {
@@ -362,77 +351,72 @@ export var HiddenColumns = /*#__PURE__*/function (_BasePlugin) {
           });
         }, true);
       }
-
       this.hot.runHooks('afterHideColumns', currentHideConfig, destinationHideConfig, isConfigValid, isConfigValid && destinationHideConfig.length > currentHideConfig.length);
     }
+
     /**
      * Hides a single column.
      *
      * @param {...number} column Visual column index.
      */
-
   }, {
     key: "hideColumn",
     value: function hideColumn() {
       for (var _len3 = arguments.length, column = new Array(_len3), _key3 = 0; _key3 < _len3; _key3++) {
         column[_key3] = arguments[_key3];
       }
-
       this.hideColumns(column);
     }
+
     /**
      * Returns an array of visual indexes of hidden columns.
      *
      * @returns {number[]}
      */
-
   }, {
     key: "getHiddenColumns",
     value: function getHiddenColumns() {
       var _this5 = this;
-
       return arrayMap(_classPrivateFieldGet(this, _hiddenColumnsMap).getHiddenIndexes(), function (physicalColumnIndex) {
         return _this5.hot.toVisualColumn(physicalColumnIndex);
       });
     }
+
     /**
      * Checks if the provided column is hidden.
      *
      * @param {number} column Visual column index.
      * @returns {boolean}
      */
-
   }, {
     key: "isHidden",
     value: function isHidden(column) {
       return _classPrivateFieldGet(this, _hiddenColumnsMap).getValueAtIndex(this.hot.toPhysicalColumn(column)) || false;
     }
+
     /**
      * Get if trim config is valid. Check whether all of the provided column indexes are within the bounds of the table.
      *
      * @param {Array} hiddenColumns List of hidden column indexes.
      * @returns {boolean}
      */
-
   }, {
     key: "isValidConfig",
     value: function isValidConfig(hiddenColumns) {
       var nrOfColumns = this.hot.countCols();
-
       if (Array.isArray(hiddenColumns) && hiddenColumns.length > 0) {
         return hiddenColumns.every(function (visualColumn) {
           return Number.isInteger(visualColumn) && visualColumn >= 0 && visualColumn < nrOfColumns;
         });
       }
-
       return false;
     }
+
     /**
      * Reset all rendered cells meta.
      *
      * @private
      */
-
   }, {
     key: "resetCellsMeta",
     value: function resetCellsMeta() {
@@ -442,6 +426,7 @@ export var HiddenColumns = /*#__PURE__*/function (_BasePlugin) {
         }
       });
     }
+
     /**
      * Adds the additional column width for the hidden column indicators.
      *
@@ -450,7 +435,6 @@ export var HiddenColumns = /*#__PURE__*/function (_BasePlugin) {
      * @param {number} column Visual column index.
      * @returns {number}
      */
-
   }, {
     key: "onModifyColWidth",
     value: function onModifyColWidth(width, column) {
@@ -459,7 +443,6 @@ export var HiddenColumns = /*#__PURE__*/function (_BasePlugin) {
       if (this.isHidden(column)) {
         return 0;
       }
-
       if (_classPrivateFieldGet(this, _settings).indicators && (this.isHidden(column + 1) || this.isHidden(column - 1))) {
         // Add additional space for hidden column indicator.
         if (typeof width === 'number' && this.hot.hasColHeaders()) {
@@ -467,6 +450,7 @@ export var HiddenColumns = /*#__PURE__*/function (_BasePlugin) {
         }
       }
     }
+
     /**
      * Sets the copy-related cell meta.
      *
@@ -475,7 +459,6 @@ export var HiddenColumns = /*#__PURE__*/function (_BasePlugin) {
      * @param {number} column Visual column index.
      * @param {object} cellProperties Object containing the cell properties.
      */
-
   }, {
     key: "onAfterGetCellMeta",
     value: function onAfterGetCellMeta(row, column, cellProperties) {
@@ -483,27 +466,23 @@ export var HiddenColumns = /*#__PURE__*/function (_BasePlugin) {
         // Cell property handled by the `Autofill` and the `CopyPaste` plugins.
         cellProperties.skipColumnOnPaste = true;
       }
-
       if (this.isHidden(column - 1)) {
         cellProperties.className = cellProperties.className || '';
-
         if (cellProperties.className.indexOf('afterHiddenColumn') === -1) {
           cellProperties.className += ' afterHiddenColumn';
         }
       } else if (cellProperties.className) {
         var classArr = cellProperties.className.split(' ');
-
         if (classArr.length > 0) {
           var containAfterHiddenColumn = classArr.indexOf('afterHiddenColumn');
-
           if (containAfterHiddenColumn > -1) {
             classArr.splice(containAfterHiddenColumn, 1);
           }
-
           cellProperties.className = classArr.join(' ');
         }
       }
     }
+
     /**
      * Modifies the copyable range, accordingly to the provided config.
      *
@@ -511,19 +490,15 @@ export var HiddenColumns = /*#__PURE__*/function (_BasePlugin) {
      * @param {Array} ranges An array of objects defining copyable cells.
      * @returns {Array}
      */
-
   }, {
     key: "onModifyCopyableRange",
     value: function onModifyCopyableRange(ranges) {
       var _this6 = this;
-
       // Ranges shouldn't be modified when `copyPasteEnabled` option is set to `true` (by default).
       if (_classPrivateFieldGet(this, _settings).copyPasteEnabled) {
         return ranges;
       }
-
       var newRanges = [];
-
       var pushRange = function pushRange(startRow, endRow, startCol, endCol) {
         newRanges.push({
           startRow: startRow,
@@ -532,7 +507,6 @@ export var HiddenColumns = /*#__PURE__*/function (_BasePlugin) {
           endCol: endCol
         });
       };
-
       arrayEach(ranges, function (range) {
         var isHidden = true;
         var rangeStart = 0;
@@ -541,23 +515,21 @@ export var HiddenColumns = /*#__PURE__*/function (_BasePlugin) {
             if (!isHidden) {
               pushRange(range.startRow, range.endRow, rangeStart, visualColumn - 1);
             }
-
             isHidden = true;
           } else {
             if (isHidden) {
               rangeStart = visualColumn;
             }
-
             if (visualColumn === range.endCol) {
               pushRange(range.startRow, range.endRow, rangeStart, visualColumn);
             }
-
             isHidden = false;
           }
         });
       });
       return newRanges;
     }
+
     /**
      * Adds the needed classes to the headers.
      *
@@ -565,33 +537,28 @@ export var HiddenColumns = /*#__PURE__*/function (_BasePlugin) {
      * @param {number} column Visual column index.
      * @param {HTMLElement} TH Header's TH element.
      */
-
   }, {
     key: "onAfterGetColHeader",
     value: function onAfterGetColHeader(column, TH) {
       if (!_classPrivateFieldGet(this, _settings).indicators || column < 0) {
         return;
       }
-
       var classList = [];
-
       if (column >= 1 && this.isHidden(column - 1)) {
         classList.push('afterHiddenColumn');
       }
-
       if (column < this.hot.countCols() - 1 && this.isHidden(column + 1)) {
         classList.push('beforeHiddenColumn');
       }
-
       addClass(TH, classList);
     }
+
     /**
      * Add Show-hide columns to context menu.
      *
      * @private
      * @param {object} options An array of objects containing information about the pre-defined Context Menu items.
      */
-
   }, {
     key: "onAfterContextMenuDefaultOptions",
     value: function onAfterContextMenuDefaultOptions(options) {
@@ -599,12 +566,12 @@ export var HiddenColumns = /*#__PURE__*/function (_BasePlugin) {
         name: SEPARATOR
       }, hideColumnItem(this), showColumnItem(this));
     }
+
     /**
      * On map initialized hook callback.
      *
      * @private
      */
-
   }, {
     key: "onMapInit",
     value: function onMapInit() {
@@ -612,17 +579,15 @@ export var HiddenColumns = /*#__PURE__*/function (_BasePlugin) {
         this.hideColumns(_classPrivateFieldGet(this, _settings).columns);
       }
     }
+
     /**
      * Destroys the plugin instance.
      */
-
   }, {
     key: "destroy",
     value: function destroy() {
       _classPrivateFieldSet(this, _settings, null);
-
       _classPrivateFieldSet(this, _hiddenColumnsMap, null);
-
       _get(_getPrototypeOf(HiddenColumns.prototype), "destroy", this).call(this);
     }
   }], [{
@@ -635,14 +600,13 @@ export var HiddenColumns = /*#__PURE__*/function (_BasePlugin) {
     get: function get() {
       return PLUGIN_PRIORITY;
     }
+
     /**
      * Cached plugin settings.
      *
      * @private
      * @type {object}
      */
-
   }]);
-
   return HiddenColumns;
 }(BasePlugin);

package/plugins/hiddenColumns/index.js

@@ -2,9 +2,7 @@
 
 exports.__esModule = true;
 exports.PLUGIN_PRIORITY = exports.PLUGIN_KEY = exports.HiddenColumns = void 0;
-
 var _hiddenColumns = require("./hiddenColumns");
-
 exports.PLUGIN_KEY = _hiddenColumns.PLUGIN_KEY;
 exports.PLUGIN_PRIORITY = _hiddenColumns.PLUGIN_PRIORITY;
 exports.HiddenColumns = _hiddenColumns.HiddenColumns;