handsontable
Version:
Handsontable is a JavaScript Spreadsheet Component available for React, Angular and Vue.
381 lines (324 loc) • 13.5 kB
JavaScript
function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
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 _classPrivateMethodInitSpec(obj, privateSet) { _checkPrivateRedeclaration(obj, privateSet); privateSet.add(obj); }
function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
function _classPrivateMethodGet(receiver, privateSet, fn) { if (!privateSet.has(receiver)) { throw new TypeError("attempted to get private field on non-instance"); } return fn; }
import "core-js/modules/es.array.iterator.js";
import "core-js/modules/es.map.js";
import "core-js/modules/es.object.to-string.js";
import "core-js/modules/es.string.iterator.js";
import "core-js/modules/web.dom-collections.iterator.js";
import "core-js/modules/es.weak-map.js";
import "core-js/modules/web.dom-collections.for-each.js";
import "core-js/modules/es.regexp.exec.js";
import "core-js/modules/es.string.split.js";
import "core-js/modules/es.array.concat.js";
import "core-js/modules/es.array.join.js";
import "core-js/modules/es.array.index-of.js";
import "core-js/modules/es.array.splice.js";
import "core-js/modules/es.weak-set.js";
import "core-js/modules/es.symbol.js";
import "core-js/modules/es.symbol.description.js";
import "core-js/modules/es.symbol.iterator.js";
import "core-js/modules/es.array.slice.js";
import "core-js/modules/es.function.name.js";
import "core-js/modules/es.array.from.js";
import { defineGetter, objectEach } from "../../helpers/object.mjs";
import { arrayEach } from "../../helpers/array.mjs";
import { getPluginsNames, hasPlugin } from "../registry.mjs";
import { hasCellType } from "../../cellTypes/registry.mjs";
import { hasEditor } from "../../editors/registry.mjs";
import { hasRenderer } from "../../renderers/registry.mjs";
import { hasValidator } from "../../validators/registry.mjs";
var DEPS_TYPE_CHECKERS = new Map([['plugin', hasPlugin], ['cell-type', hasCellType], ['editor', hasEditor], ['renderer', hasRenderer], ['validator', hasValidator]]);
export var PLUGIN_KEY = 'base';
var privatePool = new WeakMap();
var missingDependeciesMsgs = [];
var initializedPlugins = null;
/**
* @util
* @property {Core} hot Handsontable instance.
*/
var _isRelevantToSettings = /*#__PURE__*/new WeakSet();
export var BasePlugin = /*#__PURE__*/function () {
/**
* @param {object} hotInstance Handsontable instance.
*/
function BasePlugin(hotInstance) {
var _this = this;
_classCallCheck(this, BasePlugin);
_classPrivateMethodInitSpec(this, _isRelevantToSettings);
/**
* Handsontable instance.
*
* @type {Core}
*/
defineGetter(this, 'hot', hotInstance, {
writable: false
});
privatePool.set(this, {
hooks: {}
});
initializedPlugins = null;
this.pluginName = null;
this.pluginsInitializedCallbacks = [];
this.isPluginsReady = false;
this.enabled = false;
this.initialized = false;
this.hot.addHook('afterPluginsInitialized', function () {
return _this.onAfterPluginsInitialized();
});
this.hot.addHook('afterUpdateSettings', function (newSettings) {
return _this.onUpdateSettings(newSettings);
});
this.hot.addHook('beforeInit', function () {
return _this.init();
});
}
_createClass(BasePlugin, [{
key: "init",
value: function init() {
var _this2 = this;
this.pluginName = this.hot.getPluginName(this);
var pluginDeps = this.constructor.PLUGIN_DEPS;
var dependecies = Array.isArray(pluginDeps) ? pluginDeps : [];
if (dependecies.length > 0) {
var missingDependencies = [];
dependecies.forEach(function (dependency) {
var _dependency$split = dependency.split(':'),
_dependency$split2 = _slicedToArray(_dependency$split, 2),
type = _dependency$split2[0],
moduleName = _dependency$split2[1];
if (!DEPS_TYPE_CHECKERS.has(type)) {
throw new Error("Unknown plugin dependency type \"".concat(type, "\" was found."));
}
if (!DEPS_TYPE_CHECKERS.get(type)(moduleName)) {
missingDependencies.push(" - ".concat(moduleName, " (").concat(type, ")"));
}
});
if (missingDependencies.length > 0) {
var errorMsg = ["The ".concat(this.pluginName, " plugin requires the following modules:\n"), "".concat(missingDependencies.join('\n'), "\n")].join('');
missingDependeciesMsgs.push(errorMsg);
}
}
if (!initializedPlugins) {
initializedPlugins = getPluginsNames();
} // Workaround for the UndoRedo plugin which, currently doesn't follow the plugin architecture.
// Without this line the `callOnPluginsReady` callback won't be triggered after all plugin
// initialization.
if (initializedPlugins.indexOf('UndoRedo') >= 0) {
initializedPlugins.splice(initializedPlugins.indexOf('UndoRedo'), 1);
}
if (initializedPlugins.indexOf(this.pluginName) >= 0) {
initializedPlugins.splice(initializedPlugins.indexOf(this.pluginName), 1);
}
this.hot.addHookOnce('afterPluginsInitialized', function () {
if (_this2.isEnabled && _this2.isEnabled()) {
_this2.enablePlugin();
}
});
var isAllPluginsAreInitialized = initializedPlugins.length === 0;
if (isAllPluginsAreInitialized) {
if (missingDependeciesMsgs.length > 0) {
var _errorMsg = ["".concat(missingDependeciesMsgs.join('\n'), "\n"), 'You have to import and register them manually.'].join('');
throw new Error(_errorMsg);
}
this.hot.runHooks('afterPluginsInitialized');
}
this.initialized = true;
}
/**
* Enable plugin for this Handsontable instance.
*/
}, {
key: "enablePlugin",
value: function enablePlugin() {
this.enabled = true;
}
/**
* Disable plugin for this Handsontable instance.
*/
}, {
key: "disablePlugin",
value: function disablePlugin() {
if (this.eventManager) {
this.eventManager.clear();
}
this.clearHooks();
this.enabled = false;
}
/**
* Add listener to plugin hooks system.
*
* @param {string} name The hook name.
* @param {Function} callback The listener function to add.
*/
}, {
key: "addHook",
value: function addHook(name, callback) {
privatePool.get(this).hooks[name] = privatePool.get(this).hooks[name] || [];
var hooks = privatePool.get(this).hooks[name];
this.hot.addHook(name, callback);
hooks.push(callback);
privatePool.get(this).hooks[name] = hooks;
}
/**
* Remove all hooks listeners by hook name.
*
* @param {string} name The hook name.
*/
}, {
key: "removeHooks",
value: function removeHooks(name) {
var _this3 = this;
arrayEach(privatePool.get(this).hooks[name] || [], function (callback) {
_this3.hot.removeHook(name, callback);
});
}
/**
* Clear all hooks.
*/
}, {
key: "clearHooks",
value: function clearHooks() {
var _this4 = this;
var hooks = privatePool.get(this).hooks;
objectEach(hooks, function (callbacks, name) {
return _this4.removeHooks(name);
});
hooks.length = 0;
}
/**
* Register function which will be immediately called after all plugins initialized.
*
* @param {Function} callback The listener function to call.
*/
}, {
key: "callOnPluginsReady",
value: function callOnPluginsReady(callback) {
if (this.isPluginsReady) {
callback();
} else {
this.pluginsInitializedCallbacks.push(callback);
}
}
/**
* Check if any of the keys defined in `SETTING_KEYS` configuration of the plugin is present in the provided
* config object, or if the `SETTING_KEYS` configuration states that the plugin is relevant to the config object
* regardless of its contents.
*
* @private
* @param {Handsontable.DefaultSettings} settings The config object passed to `updateSettings`.
* @returns {boolean}
*/
}, {
key: "onAfterPluginsInitialized",
value:
/**
* On after plugins initialized listener.
*
* @private
*/
function onAfterPluginsInitialized() {
arrayEach(this.pluginsInitializedCallbacks, function (callback) {
return callback();
});
this.pluginsInitializedCallbacks.length = 0;
this.isPluginsReady = true;
}
/**
* On update settings listener.
*
* @private
* @param {object} newSettings New set of settings passed to the `updateSettings` method.
*/
}, {
key: "onUpdateSettings",
value: function onUpdateSettings(newSettings) {
var relevantToSettings = _classPrivateMethodGet(this, _isRelevantToSettings, _isRelevantToSettings2).call(this, newSettings);
if (this.isEnabled) {
if (this.enabled && !this.isEnabled()) {
this.disablePlugin();
}
if (!this.enabled && this.isEnabled()) {
this.enablePlugin();
}
if (this.enabled && this.isEnabled() && relevantToSettings) {
this.updatePlugin(newSettings);
}
}
}
/**
* Updates the plugin to use the latest options you have specified.
*
* @private
*/
}, {
key: "updatePlugin",
value: function updatePlugin() {}
/**
* Destroy plugin.
*/
}, {
key: "destroy",
value: function destroy() {
var _this5 = this;
if (this.eventManager) {
this.eventManager.destroy();
}
this.clearHooks();
objectEach(this, function (value, property) {
if (property !== 'hot') {
_this5[property] = null;
}
});
delete this.t;
delete this.hot;
}
}], [{
key: "PLUGIN_KEY",
get: function get() {
return PLUGIN_KEY;
}
/**
* The `SETTING_KEYS` getter defines the keys that, when present in the config object, trigger the plugin update
* after the `updateSettings` calls.
* - When it returns `true`, the plugin updates after all `updateSettings` calls, regardless of the contents of the
* config object.
* - When it returns `false`, the plugin never updates on `updateSettings` calls.
*
* @returns {string[] | boolean}
*/
}, {
key: "SETTING_KEYS",
get: function get() {
return [this.PLUGIN_KEY];
}
}]);
return BasePlugin;
}();
function _isRelevantToSettings2(settings) {
if (!settings) {
return false;
}
var settingKeys = this.constructor.SETTING_KEYS; // If SETTING_KEYS is declared as `true` -> update the plugin regardless of the settings declared in
// `updateSettings`.
// If SETTING_KEYS is declared as `false` -> DON'T update the plugin regardless of the settings declared in
// `updateSettings`.
if (typeof settingKeys === 'boolean') {
return settingKeys;
}
for (var i = 0; i < settingKeys.length; i++) {
if (settings[settingKeys[i]] !== void 0) {
return true;
}
}
return false;
}