handsontable 12.1.2 → 12.2.0

package/plugins/trimRows/trimRows.js

@@ -1,79 +1,45 @@
 "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.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.js");
-
 require("core-js/modules/es.symbol.description.js");
-
 require("core-js/modules/es.symbol.iterator.js");
-
 exports.__esModule = true;
 exports.TrimRows = exports.PLUGIN_PRIORITY = exports.PLUGIN_KEY = void 0;
-
 require("core-js/modules/es.array.from.js");
-
 require("core-js/modules/es.string.iterator.js");
-
 require("core-js/modules/es.array.iterator.js");
-
 require("core-js/modules/es.object.to-string.js");
-
 require("core-js/modules/es.set.js");
-
 require("core-js/modules/web.dom-collections.iterator.js");
-
 require("core-js/modules/es.array.concat.js");
-
 require("core-js/modules/es.array.slice.js");
-
 require("core-js/modules/es.number.is-integer.js");
-
 require("core-js/modules/es.number.constructor.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 _translations = require("../../translations");
-
 var _array = require("../../helpers/array");
-
 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); }
-
 var PLUGIN_KEY = 'trimRows';
 exports.PLUGIN_KEY = PLUGIN_KEY;
 var PLUGIN_PRIORITY = 330;
+
 /* eslint-disable jsdoc/require-description-complete-sentence */
 
 /**
@@ -86,6 +52,7 @@ var PLUGIN_PRIORITY = 330;
  * data is not visible to other plugins.
  *
  * @example
+ * ::: only-for javascript
  * ```js
  * const container = document.getElementById('example');
  * const hot = new Handsontable(container, {
@@ -118,20 +85,55 @@ var PLUGIN_PRIORITY = 330;
  * // rerender table to see the changes
  * hot.render();
  * ```
+ * :::
+ *
+ * ::: only-for react
+ * ```jsx
+ * const hotRef = useRef(null);
+ *
+ * ...
+ *
+ * <HotTable
+ *   ref={hotRef}
+ *   data={getData()}
+ *   // hide selected rows on table initialization
+ *   trimRows={[1, 2, 5]}
+ * />
+ *
+ * const hot = hotRef.current.hotInstance;
+ * // access the trimRows plugin instance
+ * const trimRowsPlugin = hot.getPlugin('trimRows');
+ *
+ * // hide single row
+ * trimRowsPlugin.trimRow(1);
+ *
+ * // hide multiple rows
+ * trimRowsPlugin.trimRow(1, 2, 9);
+ *
+ * // or as an array
+ * trimRowsPlugin.trimRows([1, 2, 9]);
+ *
+ * // show single row
+ * trimRowsPlugin.untrimRow(1);
+ *
+ * // show multiple rows
+ * trimRowsPlugin.untrimRow(1, 2, 9);
+ *
+ * // or as an array
+ * trimRowsPlugin.untrimRows([1, 2, 9]);
+ *
+ * // rerender table to see the changes
+ * hot.render();
+ * ```
+ * :::
  */
-
 exports.PLUGIN_PRIORITY = PLUGIN_PRIORITY;
-
 var TrimRows = /*#__PURE__*/function (_BasePlugin) {
   _inherits(TrimRows, _BasePlugin);
-
   var _super = _createSuper(TrimRows);
-
   function TrimRows(hotInstance) {
     var _this;
-
     _classCallCheck(this, TrimRows);
-
     _this = _super.call(this, hotInstance);
     /**
      * Map of skipped rows by the plugin.
@@ -139,91 +141,81 @@ var TrimRows = /*#__PURE__*/function (_BasePlugin) {
      * @private
      * @type {null|TrimmingMap}
      */
-
     _this.trimmedRowsMap = 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 AutoRowSize#enablePlugin} method is called.
+   * hook and if it returns `true` then the {@link AutoRowSize#enablePlugin} method is called.
    *
    * @returns {boolean}
    */
-
-
   _createClass(TrimRows, [{
     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;
       }
-
       this.trimmedRowsMap = this.hot.rowIndexMapper.registerMap('trimRows', new _translations.TrimmingMap());
       this.trimmedRowsMap.addLocalHook('init', function () {
         return _this2.onMapInit();
       });
-
       _get(_getPrototypeOf(TrimRows.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:
      *  - [`trimRows`](@/api/options.md#trimrows)
      */
-
   }, {
     key: "updatePlugin",
     value: function updatePlugin() {
       var _this3 = this;
-
       var trimmedRows = this.hot.getSettings()[PLUGIN_KEY];
-
       if (Array.isArray(trimmedRows)) {
         this.hot.batchExecution(function () {
           _this3.trimmedRowsMap.clear();
-
           (0, _array.arrayEach)(trimmedRows, function (physicalRow) {
             _this3.trimmedRowsMap.setValueAtIndex(physicalRow, true);
           });
         }, true);
       }
-
       _get(_getPrototypeOf(TrimRows.prototype), "updatePlugin", this).call(this);
     }
+
     /**
      * Disables the plugin functionality for this Handsontable instance.
      */
-
   }, {
     key: "disablePlugin",
     value: function disablePlugin() {
       this.hot.rowIndexMapper.unregisterMap('trimRows');
-
       _get(_getPrototypeOf(TrimRows.prototype), "disablePlugin", this).call(this);
     }
+
     /**
      * Get list of trimmed rows.
      *
      * @returns {Array} Physical rows.
      */
-
   }, {
     key: "getTrimmedRows",
     value: function getTrimmedRows() {
       return this.trimmedRowsMap.getTrimmedIndexes();
     }
+
     /**
      * Trims the rows provided in the array.
      *
@@ -231,26 +223,20 @@ var TrimRows = /*#__PURE__*/function (_BasePlugin) {
      * @fires Hooks#beforeTrimRow
      * @fires Hooks#afterTrimRow
      */
-
   }, {
     key: "trimRows",
     value: function trimRows(rows) {
       var _this4 = this;
-
       var currentTrimConfig = this.getTrimmedRows();
       var isValidConfig = this.isValidConfig(rows);
       var destinationTrimConfig = currentTrimConfig;
-
       if (isValidConfig) {
         destinationTrimConfig = Array.from(new Set(currentTrimConfig.concat(rows)));
       }
-
       var allowTrimRow = this.hot.runHooks('beforeTrimRow', currentTrimConfig, destinationTrimConfig, isValidConfig);
-
       if (allowTrimRow === false) {
         return;
       }
-
       if (isValidConfig) {
         this.hot.batchExecution(function () {
           (0, _array.arrayEach)(rows, function (physicalRow) {
@@ -258,24 +244,23 @@ var TrimRows = /*#__PURE__*/function (_BasePlugin) {
           });
         }, true);
       }
-
       this.hot.runHooks('afterTrimRow', currentTrimConfig, destinationTrimConfig, isValidConfig, isValidConfig && destinationTrimConfig.length > currentTrimConfig.length);
     }
+
     /**
-     * Trims the row provided as physical row index (counting from 0).
+     * Trims the row provided as a physical row index (counting from 0).
      *
      * @param {...number} row Physical row index.
      */
-
   }, {
     key: "trimRow",
     value: function trimRow() {
       for (var _len = arguments.length, row = new Array(_len), _key = 0; _key < _len; _key++) {
         row[_key] = arguments[_key];
       }
-
       this.trimRows(row);
     }
+
     /**
      * Untrims the rows provided in the array.
      *
@@ -283,7 +268,6 @@ var TrimRows = /*#__PURE__*/function (_BasePlugin) {
      * @fires Hooks#beforeUntrimRow
      * @fires Hooks#afterUntrimRow
      */
-
   }, {
     key: "untrimRows",
     value: function untrimRows(rows) {
@@ -292,77 +276,71 @@ var TrimRows = /*#__PURE__*/function (_BasePlugin) {
       var destinationTrimConfig = currentTrimConfig;
       var trimmingMapValues = this.trimmedRowsMap.getValues().slice();
       var isAnyRowUntrimmed = rows.length > 0;
-
       if (isValidConfig && isAnyRowUntrimmed) {
         // Preparing new values for trimming map.
         (0, _array.arrayEach)(rows, function (physicalRow) {
           trimmingMapValues[physicalRow] = false;
-        }); // Preparing new trimming config.
+        });
 
+        // Preparing new trimming config.
         destinationTrimConfig = (0, _array.arrayReduce)(trimmingMapValues, function (trimmedIndexes, isTrimmed, physicalIndex) {
           if (isTrimmed) {
             trimmedIndexes.push(physicalIndex);
           }
-
           return trimmedIndexes;
         }, []);
       }
-
       var allowUntrimRow = this.hot.runHooks('beforeUntrimRow', currentTrimConfig, destinationTrimConfig, isValidConfig && isAnyRowUntrimmed);
-
       if (allowUntrimRow === false) {
         return;
       }
-
       if (isValidConfig && isAnyRowUntrimmed) {
         this.trimmedRowsMap.setValues(trimmingMapValues);
       }
-
       this.hot.runHooks('afterUntrimRow', currentTrimConfig, destinationTrimConfig, isValidConfig && isAnyRowUntrimmed, isValidConfig && destinationTrimConfig.length < currentTrimConfig.length);
     }
+
     /**
-     * Untrims the row provided as row index (counting from 0).
+     * Untrims the row provided as a physical row index (counting from 0).
      *
      * @param {...number} row Physical row index.
      */
-
   }, {
     key: "untrimRow",
     value: function untrimRow() {
       for (var _len2 = arguments.length, row = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
         row[_key2] = arguments[_key2];
       }
-
       this.untrimRows(row);
     }
+
     /**
      * Checks if given row is hidden.
      *
      * @param {number} physicalRow Physical row index.
      * @returns {boolean}
      */
-
   }, {
     key: "isTrimmed",
     value: function isTrimmed(physicalRow) {
       return this.trimmedRowsMap.getValueAtIndex(physicalRow) || false;
     }
+
     /**
      * Untrims all trimmed rows.
      */
-
   }, {
     key: "untrimAll",
     value: function untrimAll() {
       this.untrimRows(this.getTrimmedRows());
     }
+
     /**
-     * Get if trim config is valid. Check whether all of the provided row indexes are within source data.
+     * Get if trim config is valid. Check whether all of the provided physical row indexes are within source data.
      *
      * @param {Array} trimmedRows List of physical row indexes.
      * @returns {boolean}
      */
-
   }, {
     key: "isValidConfig",
     value: function isValidConfig(trimmedRows) {
@@ -371,19 +349,17 @@ var TrimRows = /*#__PURE__*/function (_BasePlugin) {
         return Number.isInteger(trimmedRow) && trimmedRow >= 0 && trimmedRow < sourceRows;
       });
     }
+
     /**
      * On map initialized hook callback.
      *
      * @private
      */
-
   }, {
     key: "onMapInit",
     value: function onMapInit() {
       var _this5 = this;
-
       var trimmedRows = this.hot.getSettings()[PLUGIN_KEY];
-
       if (Array.isArray(trimmedRows)) {
         this.hot.batchExecution(function () {
           (0, _array.arrayEach)(trimmedRows, function (physicalRow) {
@@ -392,10 +368,10 @@ var TrimRows = /*#__PURE__*/function (_BasePlugin) {
         }, true);
       }
     }
+
     /**
      * Destroys the plugin instance.
      */
-
   }, {
     key: "destroy",
     value: function destroy() {
@@ -412,8 +388,6 @@ var TrimRows = /*#__PURE__*/function (_BasePlugin) {
       return PLUGIN_PRIORITY;
     }
   }]);
-
   return TrimRows;
 }(_base.BasePlugin);
-
 exports.TrimRows = TrimRows;