@syncfusion/ej2-base 19.2.55 → 19.3.47

package/src/component.js

@@ -25,18 +25,16 @@ import { ChildProperty } from './child-property';
 import { Property, NotifyPropertyChanges } from './notify-property-change';
 import { onIntlChange, rightToLeft, defaultCulture } from './internationalization';
 import { createElement, addClass, removeClass, select } from './dom';
-import { VirtualDOM } from './virtual-dom';
-import { getRandomId } from './template-engine';
 var componentCount = 0;
 var lastPageID;
 var lastHistoryLen = 0;
 export var versionBasedStatePersistence = false;
 /**
  * To enable or disable version based statePersistence functionality for all components globally.
+ *
  * @param {boolean} status - Optional argument Specifies the status value to enable or disable versionBasedStatePersistence option.
  * @returns {void}
  */
-/* istanbul ignore next */
 export function enableVersionBasedPersistence(status) {
     versionBasedStatePersistence = status;
 }
@@ -47,12 +45,16 @@ var Component = /** @class */ (function (_super) {
     __extends(Component, _super);
     /**
      * Initialize the constructor for component base
+     *
+     * @param {Object} options ?
+     * @param {string} selector ?
      */
     function Component(options, selector) {
         var _this = _super.call(this, options, selector) || this;
         _this.randomId = uniqueID();
         /**
          * string template option for Blazor template rendering
+         *
          * @private
          */
         _this.isStringTemplate = false;
@@ -76,9 +78,10 @@ var Component = /** @class */ (function (_super) {
     Component.prototype.requiredModules = function () {
         return [];
     };
-    ;
     /**
      * Destroys the sub modules while destroying the widget
+     *
+     * @returns {void} ?
      */
     Component.prototype.destroy = function () {
         if (this.isDestroyed) {
@@ -99,6 +102,8 @@ var Component = /** @class */ (function (_super) {
     };
     /**
      * Applies all the pending property changes and render the component again.
+     *
+     * @returns {void} ?
      */
     Component.prototype.refresh = function () {
         this.refreshing = true;
@@ -111,7 +116,6 @@ var Component = /** @class */ (function (_super) {
         this.render();
         this.refreshing = false;
     };
-    /* istanbul ignore next */
     Component.prototype.accessMount = function () {
         if (this.mount && !this.isReactHybrid) {
             this.mount();
@@ -119,10 +123,12 @@ var Component = /** @class */ (function (_super) {
     };
     /**
      * Returns the route element of the component
+     *
+     * @returns {HTMLElement} ?
      */
-    /* istanbul ignore next */
     Component.prototype.getRootElement = function () {
         if (this.isReactHybrid) {
+            // eslint-disable-next-line
             return this.actualElement;
         }
         else {
@@ -131,9 +137,10 @@ var Component = /** @class */ (function (_super) {
     };
     /**
      * Returns the persistence data for component
+     *
+     * @returns {any} ?
      */
-    /* istanbul ignore next */
-    //tslint:disable:no-any
+    // eslint-disable-next-line
     Component.prototype.getLocalData = function () {
         var eleId = this.getModuleName() + this.element.id;
         if (versionBasedStatePersistence) {
@@ -145,7 +152,9 @@ var Component = /** @class */ (function (_super) {
     };
     /**
      * Appends the control within the given HTML element
+     *
      * @param {string | HTMLElement} selector - Target element where control needs to be appended
+     * @returns {void} ?
      */
     Component.prototype.appendTo = function (selector) {
         if (!isNullOrUndefined(selector) && typeof (selector) === 'string') {
@@ -182,30 +191,35 @@ var Component = /** @class */ (function (_super) {
     };
     /**
      * It is used to process the post rendering functionalities to a component.
+     *
+     * @param {Node} wrapperElement ?
+     * @returns {void} ?
      */
     Component.prototype.renderComplete = function (wrapperElement) {
         if (isBlazor()) {
             var sfBlazor = 'sfBlazor';
-            // tslint:disable-next-line:no-any
+            // eslint-disable-next-line
             window[sfBlazor].renderComplete(this.element, wrapperElement);
         }
         this.isRendered = true;
     };
     /**
      * When invoked, applies the pending property changes immediately to the component.
+     *
+     * @returns {void} ?
      */
     Component.prototype.dataBind = function () {
         this.injectModules();
         _super.prototype.dataBind.call(this);
     };
-    ;
     /**
      * Attach one or more  event handler to the current component context.
      * It is used for internal handling event internally within the component only.
+     *
      * @param {BoundOptions[]| string} event - It is  optional type either to  Set the collection of event list or the eventName.
      * @param {Function} handler - optional parameter Specifies the handler to run when the event occurs
      * @param {Object} context - optional parameter Specifies the context to be bind in the handler.
-     * @return {void}
+     * @returns {void} ?
      * @private
      */
     Component.prototype.on = function (event, handler, context) {
@@ -221,9 +235,10 @@ var Component = /** @class */ (function (_super) {
     };
     /**
      * To remove one or more event handler that has been attached with the on() method.
+     *
      * @param {BoundOptions[]| string} event - It is  optional type either to  Set the collection of event list or the eventName.
      * @param {Function} handler - optional parameter Specifies the function to run when the event occurs
-     * @return {void}
+     * @returns {void} ?
      * @private
      */
     Component.prototype.off = function (event, handler) {
@@ -239,9 +254,10 @@ var Component = /** @class */ (function (_super) {
     };
     /**
      * To notify the handlers in the specified event.
+     *
      * @param {string} property - Specifies the event to be notify.
      * @param {Object} argument - Additional parameters to pass while calling the handler.
-     * @return {void}
+     * @returns {void} ?
      * @private
      */
     Component.prototype.notify = function (property, argument) {
@@ -251,14 +267,18 @@ var Component = /** @class */ (function (_super) {
     };
     /**
      * Get injected modules
+     *
+     * @returns {Function} ?
      * @private
      */
     Component.prototype.getInjectedModules = function () {
         return this.injectedModules;
     };
-    ;
     /**
      * Dynamically injects the required modules to the component.
+     *
+     * @param {Function} moduleList ?
+     * @returns {void} ?
      */
     Component.Inject = function () {
         var moduleList = [];
@@ -276,33 +296,28 @@ var Component = /** @class */ (function (_super) {
     };
     /**
      * This is a instance method to create an element.
+     *
+     * @param {string} tagName ?
+     * @param {ElementProperties} prop ?
+     * @param {boolean} isVDOM ?
+     * @returns {any} ?
      * @private
      */
-    /* istanbul ignore next */
-    //tslint:disable:no-any
+    // eslint-disable-next-line
     Component.prototype.createElement = function (tagName, prop, isVDOM) {
-        if (isVDOM && this.isReactHybrid) {
-            if (prop) {
-                prop = {};
-            }
-            prop['data-id'] = getRandomId();
-            return VirtualDOM.createElement(tagName, prop);
-        }
-        else {
-            return createElement(tagName, prop);
-        }
+        return createElement(tagName, prop);
     };
     /**
      *
-     * @param handler - handler to be triggered after state Updated.
-     * @param argument - Arguments to be passed to caller.
+     * @param {Function} handler - handler to be triggered after state Updated.
+     * @param {any} argument - Arguments to be passed to caller.
+     * @returns {void} .
      * @private
      */
-    /* istanbul ignore next */
-    //tslint:disable:no-any
+    // eslint-disable-next-line
     Component.prototype.triggerStateChange = function (handler, argument) {
         if (this.isReactHybrid) {
-            //tslint:disable:no-any
+            // eslint-disable-next-line
             this.setState();
             this.currentContext = { calls: handler, args: argument };
         }
@@ -334,7 +349,8 @@ var Component = /** @class */ (function (_super) {
     Component.prototype.setPersistData = function () {
         if (!this.isDestroyed) {
             if (versionBasedStatePersistence) {
-                window.localStorage.setItem(this.getModuleName() + this.element.id + this.ej2StatePersistenceVersion, this.getPersistData());
+                window.localStorage.setItem(this.getModuleName() +
+                    this.element.id + this.ej2StatePersistenceVersion, this.getPersistData());
             }
             else {
                 window.localStorage.setItem(this.getModuleName() + this.element.id, this.getPersistData());
@@ -345,7 +361,7 @@ var Component = /** @class */ (function (_super) {
     Component.prototype.renderReactTemplates = function () {
         //No Code
     };
-    //tslint:disable-next-line
+    // eslint-disable-next-line
     Component.prototype.clearTemplate = function (templateName, index) {
         //No Code
     };
@@ -378,6 +394,7 @@ var Component = /** @class */ (function (_super) {
         for (var _i = 0, options_1 = options; _i < options_1.length; _i++) {
             var key = options_1[_i];
             var objValue = void 0;
+            // eslint-disable-next-line
             objValue = getValue(key, this);
             if (!isUndefined(objValue)) {
                 setValue(key, this.getActualProperties(objValue), persistObj);
@@ -402,7 +419,7 @@ var Component = /** @class */ (function (_super) {
         var newObj = {};
         var _loop_1 = function (key) {
             if (ignoreList.indexOf(key) === -1) {
-                // tslint:disable-next-line:no-any
+                // eslint-disable-next-line
                 var value = obj[key];
                 if (typeof value === 'object' && !(value instanceof Array)) {
                     var newList = ignoreList.filter(function (str) {
@@ -439,7 +456,7 @@ var Component = /** @class */ (function (_super) {
     return Component;
 }(Base));
 export { Component };
-//Function handling for page navigation detection 
+//Function handling for page navigation detection
 /* istanbul ignore next */
 (function () {
     if (typeof window !== 'undefined') {

package/src/dom.d.ts

@@ -1,4 +1,3 @@
-import { VirtualObject } from './virtual-dom';
 export interface ElementProperties {
     id?: string;
     className?: string;
@@ -10,66 +9,86 @@ export interface ElementProperties {
 }
 /**
  * Function to create Html element.
- * @param tagName - Name of the tag, id and class names.
- * @param properties - Object to set properties in the element.
- * @param properties.id - To set the id to the created element.
- * @param properties.className - To add classes to the element.
- * @param properties.innerHTML - To set the innerHTML to element.
- * @param properties.styles - To set the some custom styles to element.
- * @param properties.attrs - To set the attributes to element.
+ *
+ * @param {string} tagName - Name of the tag, id and class names.
+ * @param {ElementProperties} properties - Object to set properties in the element.
+ * @param {ElementProperties} properties.id - To set the id to the created element.
+ * @param {ElementProperties} properties.className - To add classes to the element.
+ * @param {ElementProperties} properties.innerHTML - To set the innerHTML to element.
+ * @param {ElementProperties} properties.styles - To set the some custom styles to element.
+ * @param {ElementProperties} properties.attrs - To set the attributes to element.
+ * @returns {any} ?
  * @private
  */
 export declare function createElement(tagName: string, properties?: ElementProperties): HTMLElement;
 /**
  * The function used to add the classes to array of elements
+ *
  * @param  {Element[]|NodeList} elements - An array of elements that need to add a list of classes
  * @param  {string|string[]} classes - String or array of string that need to add an individual element as a class
+ * @returns {any} .
  * @private
  */
 export declare function addClass(elements: Element[] | NodeList, classes: string | string[]): Element[] | NodeList;
 /**
  * The function used to add the classes to array of elements
+ *
  * @param  {Element[]|NodeList} elements - An array of elements that need to remove a list of classes
  * @param  {string|string[]} classes - String or array of string that need to add an individual element as a class
+ * @returns {any} .
  * @private
  */
 export declare function removeClass(elements: Element[] | NodeList, classes: string | string[]): Element[] | NodeList;
 /**
  * The function used to check element is visible or not.
+ *
  * @param  {Element|Node} element - An element the need to check visibility
+ * @returns {boolean} ?
  * @private
  */
-export declare function isVisible(element: Element | Node): Boolean;
+export declare function isVisible(element: Element | Node): boolean;
 /**
  * The function used to insert an array of elements into a first of the element.
+ *
  * @param  {Element[]|NodeList} fromElements - An array of elements that need to prepend.
  * @param  {Element} toElement - An element that is going to prepend.
+ * @param {boolean} isEval - ?
+ * @returns {Element[] | NodeList} ?
  * @private
  */
-export declare function prepend(fromElements: Element[] | NodeList, toElement: Element, isEval?: Boolean): Element[] | NodeList;
+export declare function prepend(fromElements: Element[] | NodeList, toElement: Element, isEval?: boolean): Element[] | NodeList;
 /**
  * The function used to insert an array of elements into last of the element.
+ *
  * @param  {Element[]|NodeList} fromElements - An array of elements that need to append.
  * @param  {Element} toElement - An element that is going to prepend.
+ * @param {boolean} isEval - ?
+ * @returns {Element[] | NodeList} ?
  * @private
  */
-export declare function append(fromElements: Element[] | NodeList, toElement: Element, isEval?: Boolean): Element[] | NodeList;
+export declare function append(fromElements: Element[] | NodeList, toElement: Element, isEval?: boolean): Element[] | NodeList;
 /**
- * The function used to remove the element from the
+ * The function used to remove the element from parentnode
+ *
  * @param  {Element|Node|HTMLElement} element - An element that is going to detach from the Dom
+ * @returns {any} ?
  * @private
  */
 export declare function detach(element: Element | Node | HTMLElement): any;
 /**
  * The function used to remove the element from Dom also clear the bounded events
+ *
  * @param  {Element|Node|HTMLElement} element - An element remove from the Dom
+ * @returns {void} ?
  * @private
  */
 export declare function remove(element: Element | Node | HTMLElement): void;
 /**
  * The function helps to set multiple attributes to an element
+ *
  * @param  {Element|Node} element - An element that need to set attributes.
- * @param  {{[key:string]:string}} attributes - JSON Object that is going to as attributes.
+ * @param  {string} attributes - JSON Object that is going to as attributes.
+ * @returns {Element} ?
  * @private
  */
 export declare function attributes(element: Element | Node | any, attributes: {
@@ -77,44 +96,57 @@ export declare function attributes(element: Element | Node | any, attributes: {
 }): Element;
 /**
  * The function selects the element from giving context.
- * @param  {string} selector - Selector string need fetch element from the
- * @param  {Document|Element=document} context - It is an optional type, That specifies a Dom context.
+ *
+ * @param  {string} selector - Selector string need fetch element
+ * @param  {Document|Element} context - It is an optional type, That specifies a Dom context.
+ * @param {boolean} needsVDOM ?
+ * @returns {any} ?
  * @private
  */
 export declare function select(selector: string, context?: Document | Element, needsVDOM?: boolean): any;
 /**
  * The function selects an array of element from the given context.
- * @param  {string} selector - Selector string need fetch element from the
- * @param  {Document|Element=document} context - It is an optional type, That specifies a Dom context.
+ *
+ * @param  {string} selector - Selector string need fetch element
+ * @param  {Document|Element} context - It is an optional type, That specifies a Dom context.
+ * @param {boolean} needsVDOM ?
+ * @returns {HTMLElement[]} ?
  * @private
  */
 export declare function selectAll(selector: string, context?: Document | Element, needsVDOM?: boolean): HTMLElement[];
 /**
  * Returns single closest parent element based on class selector.
+ *
  * @param  {Element} element - An element that need to find the closest element.
  * @param  {string} selector - A classSelector of closest element.
+ * @returns {Element} ?
  * @private
  */
 export declare function closest(element: Element | Node, selector: string): Element;
 /**
  * Returns all sibling elements of the given element.
+ *
  * @param  {Element|Node} element - An element that need to get siblings.
+ * @returns {Element[]} ?
  * @private
  */
 export declare function siblings(element: Element | Node): Element[];
 /**
  * set the value if not exist. Otherwise set the existing value
+ *
  * @param  {HTMLElement} element - An element to which we need to set value.
  * @param  {string} property - Property need to get or set.
  * @param  {string} value - value need to set.
+ * @returns {string} ?
  * @private
  */
 export declare function getAttributeOrDefault(element: HTMLElement, property: string, value: string): string;
 /**
  * Set the style attributes to Html element.
+ *
  * @param {HTMLElement} element - Element which we want to set attributes
  * @param {any} attrs - Set the given attributes to element
- * @return {void}
+ * @returns {void} ?
  * @private
  */
 export declare function setStyleAttribute(element: HTMLElement, attrs: {
@@ -122,28 +154,47 @@ export declare function setStyleAttribute(element: HTMLElement, attrs: {
 }): void;
 /**
  * Method for add and remove classes to a dom element.
+ *
  * @param {Element} element - Element for add and remove classes
  * @param {string[]} addClasses - List of classes need to be add to the element
  * @param {string[]} removeClasses - List of classes need to be remove from the element
- * @return {void}
+ * @returns {void} ?
  * @private
  */
 export declare function classList(element: Element, addClasses: string[], removeClasses: string[]): void;
 /**
  * Method to check whether the element matches the given selector.
+ *
  * @param {Element} element - Element to compare with the selector.
  * @param {string} selector - String selector which element will satisfy.
- * @return {void}
+ * @returns {void} ?
  * @private
  */
 export declare function matches(element: Element, selector: string): boolean;
-export declare function includeInnerHTML(ele: HTMLElement & VirtualObject, innerHTML: string): void;
-export declare function containsClass(ele: HTMLElement & VirtualObject, className: string): any;
+/**
+ * Method to get the html text from DOM.
+ *
+ * @param {HTMLElement} ele - Element to compare with the selector.
+ * @param {string} innerHTML - String selector which element will satisfy.
+ * @returns {void} ?
+ * @private
+ */
+export declare function includeInnerHTML(ele: HTMLElement, innerHTML: string): void;
+/**
+ * Method to get the containsclass.
+ *
+ * @param {HTMLElement} ele - Element to compare with the selector.
+ * @param {string} className - String selector which element will satisfy.
+ * @returns {any} ?
+ * @private
+ */
+export declare function containsClass(ele: HTMLElement, className: string): any;
 /**
  * Method to check whether the element matches the given selector.
- * @param {} element - Element to compare with the selector.
- * @param {string} selector - String selector which element will satisfy.
- * @return {Element | VirtualObject}
+ *
+ * @param {Object} element - Element to compare with the selector.
+ * @param {boolean} deep ?
+ * @returns {any} ?
  * @private
  */
 export declare function cloneNode(element: Object, deep?: boolean): any;