@syncfusion/ej2-base 19.2.55 → 19.3.47

package/src/animation.js

@@ -55,9 +55,10 @@ var Animation = /** @class */ (function (_super) {
     Animation_1 = Animation;
     /**
      * Applies animation to the current element.
+     *
      * @param {string | HTMLElement} element - Element which needs to be animated.
      * @param {AnimationModel} options - Overriding default animation settings.
-     * @return {void}
+     * @returns {void} ?
      */
     Animation.prototype.animate = function (element, options) {
         options = !options ? {} : options;
@@ -77,6 +78,7 @@ var Animation = /** @class */ (function (_super) {
     };
     /**
      * Stop the animation effect on animated element.
+     *
      * @param {HTMLElement} element - Element which needs to be stop the animation.
      * @param {AnimationOptions} model - Handling the animation model at stop function.
      * @return {void}
@@ -96,7 +98,8 @@ var Animation = /** @class */ (function (_super) {
     };
     /**
      * Set delay to animation element
-     * @param {AnimationModel} model
+     *
+     * @param {AnimationModel} model ?
      * @returns {void}
      */
     Animation.delayAnimation = function (model) {
@@ -109,7 +112,8 @@ var Animation = /** @class */ (function (_super) {
     };
     /**
      * Triggers animation
-     * @param {AnimationModel} model
+     *
+     * @param {AnimationModel} model ?
      * @returns {void}
      */
     Animation.applyAnimation = function (model) {
@@ -117,7 +121,6 @@ var Animation = /** @class */ (function (_super) {
         model.timeStamp = 0;
         var step = 0;
         var timerId = 0;
-        var startTime = 0;
         var prevTimeStamp = 0;
         var duration = model.duration;
         model.element.setAttribute('e-animate', 'true');
@@ -137,12 +140,12 @@ var Animation = /** @class */ (function (_super) {
                     step = step + 1;
                     var avg = model.timeStamp / step;
                     if (model.timeStamp < duration && model.timeStamp + avg < duration && model.element.getAttribute('e-animate')) {
-                        // apply animation effect to the current element                
+                        // apply animation effect to the current element
                         model.element.style.animation = model.name + ' ' + model.duration + 'ms ' + model.timingFunction;
                         if (model.progress) {
                             model.progress.call(_this, model);
                         }
-                        // repeat requestAnimationFrame 
+                        // repeat requestAnimationFrame
                         requestAnimationFrame(startAnimation);
                     }
                     else {
@@ -157,7 +160,7 @@ var Animation = /** @class */ (function (_super) {
                     }
                 }
                 else {
-                    startTime = performance.now();
+                    //startTime = performance.now();
                     // set initial requestAnimationFrame
                     timerId = requestAnimationFrame(startAnimation);
                     model.element.setAttribute('e-animation-id', timerId.toString());
@@ -175,8 +178,9 @@ var Animation = /** @class */ (function (_super) {
     };
     /**
      * Returns Animation Model
-     * @param {AnimationModel} options
-     * @returns {AnimationModel}
+     *
+     * @param {AnimationModel} options ?
+     * @returns {AnimationModel} ?
      */
     Animation.prototype.getModel = function (options) {
         return {
@@ -193,19 +197,27 @@ var Animation = /** @class */ (function (_super) {
     };
     /**
      * @private
+     * @param {AnimationModel} newProp ?
+     * @param {AnimationModel} oldProp ?
+     * @returns {void} ?
      */
+    // eslint-disable-next-line
     Animation.prototype.onPropertyChanged = function (newProp, oldProp) {
         // no code needed
     };
     /**
      * Returns module name as animation
+     *
      * @private
+     * @returns {void} ?
      */
     Animation.prototype.getModuleName = function () {
         return 'animation';
     };
     /**
+     *
      * @private
+     * @returns {void} ?
      */
     Animation.prototype.destroy = function () {
         //Override base destroy;
@@ -249,14 +261,17 @@ export { Animation };
  *   rippleEffect(document.getElementById('ripple'));
  * </script>
  * ```
+ *
  * @private
- * @param HTMLElement element - Target element
- * @param RippleOptions rippleOptions - Ripple options .
+ * @param {HTMLElement} element - Target element
+ * @param {RippleOptions} rippleOptions - Ripple options .
+ * @param {Function} done .
+ * @returns {void} .
  */
 export function rippleEffect(element, rippleOptions, done) {
     var rippleModel = getRippleModel(rippleOptions);
     if (rippleModel.rippleFlag === false || (rippleModel.rippleFlag === undefined && !isRippleEnabled)) {
-        return (function () { });
+        return Function;
     }
     element.setAttribute('data-ripple', 'true');
     EventHandler.add(element, 'mousedown', rippleHandler, { parent: element, rippleOptions: rippleModel });
@@ -273,6 +288,12 @@ export function rippleEffect(element, rippleOptions, done) {
         EventHandler.remove(element, 'transitionend', rippleLeaveHandler);
     });
 }
+/**
+ * Handler for ripple model
+ *
+ * @param {RippleOptions} rippleOptions ?
+ * @returns {RippleOptions} ?
+ */
 function getRippleModel(rippleOptions) {
     var rippleModel = {
         selector: rippleOptions && rippleOptions.selector ? rippleOptions.selector : null,
@@ -285,8 +306,9 @@ function getRippleModel(rippleOptions) {
 }
 /**
  * Handler for ripple event
- * @param {MouseEvent} e
- * @returns {void}
+ *
+ * @param {MouseEvent} e ?
+ * @returns {void} ?
  * @private
  */
 function rippleHandler(e) {
@@ -325,8 +347,9 @@ function rippleHandler(e) {
 }
 /**
  * Handler for ripple element mouse up event
- * @param {MouseEvent} e
- * @returns {void}
+ *
+ * @param {MouseEvent} e ?
+ * @returns {void} ?
  * @private
  */
 function rippleUpHandler(e) {
@@ -334,8 +357,9 @@ function rippleUpHandler(e) {
 }
 /**
  * Handler for ripple element mouse move event
- * @param {MouseEvent} e
- * @returns {void}
+ *
+ * @param {MouseEvent} e ?
+ * @returns {void} ?
  * @private
  */
 function rippleLeaveHandler(e) {
@@ -343,9 +367,10 @@ function rippleLeaveHandler(e) {
 }
 /**
  * Handler for removing ripple element
- * @param {MouseEvent} e
- * @param {rippleArgs} eventArgs
- * @returns {void}
+ *
+ * @param {MouseEvent} e ?
+ * @param {RippleArgs} eventArgs ?
+ * @returns {void} ?
  * @private
  */
 function removeRipple(e, eventArgs) {
@@ -380,8 +405,9 @@ function removeRipple(e, eventArgs) {
 export var isRippleEnabled = false;
 /**
  * Animation Module provides support to enable ripple effect functionality to Essential JS 2 components.
+ *
  * @param {boolean} isRipple Specifies the boolean value to enable or disable ripple effect.
- * @returns {boolean}
+ * @returns {boolean} ?
  */
 export function enableRipple(isRipple) {
     isRippleEnabled = isRipple;

package/src/base.d.ts

@@ -13,6 +13,7 @@ export interface BlazorDotnetObject {
 }
 /**
  * Base library module is common module for Framework modules like touch,keyboard and etc.,
+ *
  * @private
  */
 export declare abstract class Base<ElementType extends HTMLElement> {
@@ -47,21 +48,26 @@ export declare abstract class Base<ElementType extends HTMLElement> {
     /** Property base section */
     /**
      * Function used to set bunch of property at a time.
+     *
      * @private
      * @param  {Object} prop - JSON object which holds components properties.
-     * @param  {boolean} muteOnChange? - Specifies to true when we set properties.
+     * @param  {boolean} muteOnChange ? - Specifies to true when we set properties.
+     * @returns {void} ?
      */
     setProperties(prop: Object, muteOnChange?: boolean): void;
     /**
      * Calls for child element data bind
-     * @param {Object} obj
-     * @param {Object} parent
-     * @returns {void}
+     *
+     * @param {Object} obj ?
+     * @param {Object} parent ?
+     * @returns {void} ?
      */
     private static callChildDataBind;
     protected clearChanges(): void;
     /**
      * Bind property changes immediately to components
+     *
+     * @returns {void} ?
      */
     dataBind(): void;
     serverDataBind(newChanges?: {
@@ -71,50 +77,64 @@ export declare abstract class Base<ElementType extends HTMLElement> {
     /** Event Base Section */
     /**
      * Adds the handler to the given event listener.
+     *
      * @param {string} eventName - A String that specifies the name of the event
-     * @param {Function} listener - Specifies the call to run when the event occurs.
-     * @return {void}
+     * @param {Function} handler - Specifies the call to run when the event occurs.
+     * @returns {void} ?
      */
     addEventListener(eventName: string, handler: Function): void;
     /**
      * Removes the handler from the given event listener.
+     *
      * @param {string} eventName - A String that specifies the name of the event to remove
-     * @param {Function} listener - Specifies the function to remove
-     * @return {void}
+     * @param {Function} handler - Specifies the function to remove
+     * @returns {void} ?
      */
     removeEventListener(eventName: string, handler: Function): void;
     /**
      * Triggers the handlers in the specified event.
+     *
      * @private
      * @param {string} eventName - Specifies the event to trigger for the specified component properties.
      * Can be a custom event, or any of the standard events.
      * @param {Event} eventProp - Additional parameters to pass on to the event properties
      * @param {Function} successHandler - this function will invoke after event successfully triggered
      * @param {Function} errorHandler - this function will invoke after event if it failured to call.
-     * @return {void}
+     * @returns {void} ?
      */
     trigger(eventName: string, eventProp?: Object, successHandler?: Function, errorHandler?: Function): void | object;
     /**
      * Base constructor accept options and element
+     *
+     * @param {Object} options ?
+     * @param {string} element ?
      */
     constructor(options: Object, element: ElementType | string);
     /**
      * To maintain instance in base class
+     *
+     * @returns {void} ?
      */
     protected addInstance(): void;
     /**
      * To remove the instance from the element
+     *
+     * @returns {void} ?
      */
     protected destroy(): void;
 }
 /**
  * Global function to get the component instance from the rendered element.
- * @param elem Specifies the HTMLElement or element id string.
- * @param comp Specifies the component module name or Component.
+ *
+ * @param {HTMLElement} elem Specifies the HTMLElement or element id string.
+ * @param {string} comp Specifies the component module name or Component.
+ * @returns {any} ?
  */
 export declare function getComponent<T>(elem: HTMLElement | string, comp: string | any | T): T;
 /**
  * Function to remove the child instances.
+ *
+ * @param {HTMLElement} element ?
  * @return {void}
  * @private
  */

package/src/base.js

@@ -1,15 +1,19 @@
 import { isUndefined, isNullOrUndefined, merge, setImmediate, setValue, isBlazor, getValue, extend } from './util';
 import { addClass, removeClass } from './dom';
 import { Observer } from './observer';
-var isColEName = new RegExp('\]');
+var isColEName = new RegExp(']');
 /* tslint:enable:no-any */
 /**
  * Base library module is common module for Framework modules like touch,keyboard and etc.,
+ *
  * @private
  */
 var Base = /** @class */ (function () {
     /**
      * Base constructor accept options and element
+     *
+     * @param {Object} options ?
+     * @param {string} element ?
      */
     function Base(options, element) {
         this.isRendered = false;
@@ -23,7 +27,7 @@ var Base = /** @class */ (function () {
         this.bulkChanges = {};
         this.refreshing = false;
         this.ignoreCollectionWatch = false;
-        // tslint:disable-next-line:no-empty
+        // eslint-disable-next-line
         this.finalUpdate = function () { };
         this.childChangedProperties = {};
         this.modelObserver = new Observer(this);
@@ -47,9 +51,11 @@ var Base = /** @class */ (function () {
     /** Property base section */
     /**
      * Function used to set bunch of property at a time.
+     *
      * @private
      * @param  {Object} prop - JSON object which holds components properties.
-     * @param  {boolean} muteOnChange? - Specifies to true when we set properties.
+     * @param  {boolean} muteOnChange ? - Specifies to true when we set properties.
+     * @returns {void} ?
      */
     Base.prototype.setProperties = function (prop, muteOnChange) {
         var prevDetection = this.isProtectedOnChange;
@@ -67,12 +73,12 @@ var Base = /** @class */ (function () {
         this.oldProperties = {};
         this.isProtectedOnChange = prevDetection;
     };
-    ;
     /**
      * Calls for child element data bind
-     * @param {Object} obj
-     * @param {Object} parent
-     * @returns {void}
+     *
+     * @param {Object} obj ?
+     * @param {Object} parent ?
+     * @returns {void} ?
      */
     // tslint:disable-next-line:no-any
     Base.callChildDataBind = function (obj, parent) {
@@ -100,6 +106,8 @@ var Base = /** @class */ (function () {
     };
     /**
      * Bind property changes immediately to components
+     *
+     * @returns {void} ?
      */
     Base.prototype.dataBind = function () {
         Base.callChildDataBind(this.childChangedProperties, this);
@@ -113,7 +121,6 @@ var Base = /** @class */ (function () {
             this.isProtectedOnChange = prevDetection;
         }
     };
-    ;
     /* tslint:disable:no-any */
     Base.prototype.serverDataBind = function (newChanges) {
         if (!isBlazor()) {
@@ -143,35 +150,37 @@ var Base = /** @class */ (function () {
         this.finalUpdate();
         this.finalUpdate = setImmediate(this.dataBind.bind(this));
     };
-    ;
     /** Event Base Section */
     /**
      * Adds the handler to the given event listener.
+     *
      * @param {string} eventName - A String that specifies the name of the event
-     * @param {Function} listener - Specifies the call to run when the event occurs.
-     * @return {void}
+     * @param {Function} handler - Specifies the call to run when the event occurs.
+     * @returns {void} ?
      */
     Base.prototype.addEventListener = function (eventName, handler) {
         this.modelObserver.on(eventName, handler);
     };
     /**
      * Removes the handler from the given event listener.
+     *
      * @param {string} eventName - A String that specifies the name of the event to remove
-     * @param {Function} listener - Specifies the function to remove
-     * @return {void}
+     * @param {Function} handler - Specifies the function to remove
+     * @returns {void} ?
      */
     Base.prototype.removeEventListener = function (eventName, handler) {
         this.modelObserver.off(eventName, handler);
     };
     /**
      * Triggers the handlers in the specified event.
+     *
      * @private
      * @param {string} eventName - Specifies the event to trigger for the specified component properties.
      * Can be a custom event, or any of the standard events.
      * @param {Event} eventProp - Additional parameters to pass on to the event properties
      * @param {Function} successHandler - this function will invoke after event successfully triggered
      * @param {Function} errorHandler - this function will invoke after event if it failured to call.
-     * @return {void}
+     * @returns {void} ?
      */
     Base.prototype.trigger = function (eventName, eventProp, successHandler, errorHandler) {
         var _this = this;
@@ -225,6 +234,8 @@ var Base = /** @class */ (function () {
     };
     /**
      * To maintain instance in base class
+     *
+     * @returns {void} ?
      */
     Base.prototype.addInstance = function () {
         // Add module class to the root element
@@ -239,9 +250,12 @@ var Base = /** @class */ (function () {
     };
     /**
      * To remove the instance from the element
+     *
+     * @returns {void} ?
      */
     Base.prototype.destroy = function () {
         var _this = this;
+        // eslint-disable-next-line
         this.element.ej2_instances =
             this.element.ej2_instances.filter(function (i) { return i !== _this; });
         removeClass([this.element], ['e-' + this.getModuleName()]);
@@ -258,8 +272,10 @@ var Base = /** @class */ (function () {
 export { Base };
 /**
  * Global function to get the component instance from the rendered element.
- * @param elem Specifies the HTMLElement or element id string.
- * @param comp Specifies the component module name or Component.
+ *
+ * @param {HTMLElement} elem Specifies the HTMLElement or element id string.
+ * @param {string} comp Specifies the component module name or Component.
+ * @returns {any} ?
  */
 // tslint:disable-next-line:no-any
 export function getComponent(elem, comp) {
@@ -285,6 +301,8 @@ export function getComponent(elem, comp) {
 }
 /**
  * Function to remove the child instances.
+ *
+ * @param {HTMLElement} element ?
  * @return {void}
  * @private
  */

package/src/browser.d.ts

@@ -1,5 +1,6 @@
 /**
  * Get configuration details for Browser
+ *
  * @private
  */
 export declare class Browser {
@@ -7,115 +8,152 @@ export declare class Browser {
     private static extractBrowserDetail;
     /**
      * To get events from the browser
+     *
      * @param {string} event - type of event triggered.
-     * @returns {Boolean}
+     * @returns {boolean}
      */
     private static getEvent;
     /**
      * To get the Touch start event from browser
+     *
      * @returns {string}
      */
     private static getTouchStartEvent;
     /**
      * To get the Touch end event from browser
+     *
      * @returns {string}
      */
     private static getTouchEndEvent;
     /**
      * To get the Touch move event from browser
+     *
      * @returns {string}
      */
     private static getTouchMoveEvent;
     /**
      * To cancel the touch event from browser
+     *
      * @returns {string}
      */
     private static getTouchCancelEvent;
     /**
      * To get the value based on provided key and regX
-     * @param {string} key
-     * @param {RegExp} regX
-     * @returns {Object}
+     *
+     * @param {string} key ?
+     * @param {RegExp} regX ?
+     * @returns {Object} ?
      */
     private static getValue;
     /**
      * Property specifies the userAgent of the browser. Default userAgent value is based on the browser.
      * Also we can set our own userAgent.
+     *
+     * @param {string} uA ?
      */
     static userAgent: string;
     /**
      * Property is to get the browser information like Name, Version and Language
-     * @returns BrowserInfo
+     *
+     * @returns {BrowserInfo} ?
      */
     static readonly info: BrowserInfo;
     /**
      * Property is to get whether the userAgent is based IE.
+     *
+     * @returns {boolean} ?
      */
-    static readonly isIE: Boolean;
+    static readonly isIE: boolean;
     /**
      * Property is to get whether the browser has touch support.
+     *
+     * @returns {boolean} ?
      */
-    static readonly isTouch: Boolean;
+    static readonly isTouch: boolean;
     /**
      * Property is to get whether the browser has Pointer support.
+     *
+     * @returns {boolean} ?
      */
-    static readonly isPointer: Boolean;
+    static readonly isPointer: boolean;
     /**
      * Property is to get whether the browser has MSPointer support.
+     *
+     * @returns {boolean} ?
      */
-    static readonly isMSPointer: Boolean;
+    static readonly isMSPointer: boolean;
     /**
      * Property is to get whether the userAgent is device based.
+     *
+     * @returns {boolean} ?
      */
-    static readonly isDevice: Boolean;
+    static readonly isDevice: boolean;
     /**
      * Property is to get whether the userAgent is IOS.
+     *
+     * @returns {boolean} ?
      */
-    static readonly isIos: Boolean;
+    static readonly isIos: boolean;
     /**
      * Property is to get whether the userAgent is Ios7.
+     *
+     * @returns {boolean} ?
      */
-    static readonly isIos7: Boolean;
+    static readonly isIos7: boolean;
     /**
      * Property is to get whether the userAgent is Android.
+     *
+     * @returns {boolean} ?
      */
-    static readonly isAndroid: Boolean;
+    static readonly isAndroid: boolean;
     /**
      * Property is to identify whether application ran in web view.
+     *
+     * @returns {boolean} ?
      */
-    static readonly isWebView: Boolean;
+    static readonly isWebView: boolean;
     /**
      * Property is to get whether the userAgent is Windows.
+     *
+     * @returns {boolean} ?
      */
-    static readonly isWindows: Boolean;
+    static readonly isWindows: boolean;
     /**
      * Property is to get the touch start event. It returns event name based on browser.
+     *
+     * @returns {string} ?
      */
     static readonly touchStartEvent: string;
     /**
      * Property is to get the touch move event. It returns event name based on browser.
+     *
+     * @returns {string} ?
      */
     static readonly touchMoveEvent: string;
     /**
      * Property is to get the touch end event. It returns event name based on browser.
+     *
+     * @returns {string} ?
      */
     static readonly touchEndEvent: string;
     /**
      * Property is to cancel the touch end event.
+     *
+     * @returns {string} ?
      */
     static readonly touchCancelEvent: string;
 }
 export interface BrowserDetails {
-    isAndroid?: Boolean;
-    isDevice?: Boolean;
-    isIE?: Boolean;
-    isIos?: Boolean;
-    isIos7?: Boolean;
-    isMSPointer?: Boolean;
-    isPointer?: Boolean;
-    isTouch?: Boolean;
-    isWebView?: Boolean;
-    isWindows?: Boolean;
+    isAndroid?: boolean;
+    isDevice?: boolean;
+    isIE?: boolean;
+    isIos?: boolean;
+    isIos7?: boolean;
+    isMSPointer?: boolean;
+    isPointer?: boolean;
+    isTouch?: boolean;
+    isWebView?: boolean;
+    isWindows?: boolean;
     info?: BrowserInfo;
     touchStartEvent?: string;
     touchMoveEvent?: string;