@syncfusion/ej2-dropdowns 23.2.5 → 23.2.7-52849

package/src/drop-down-list/drop-down-list-model.d.ts

@@ -1,4 +1,4 @@
-import { EventHandler, Property, Event, compile, EmitType, KeyboardEvents, append, select, ModuleDeclaration } from '@syncfusion/ej2-base';import { attributes, isNullOrUndefined, getUniqueID, formatUnit, isUndefined, getValue } from '@syncfusion/ej2-base';import { Animation, AnimationModel, Browser, KeyboardEventArgs, NotifyPropertyChanges } from '@syncfusion/ej2-base';import { addClass, removeClass, closest, prepend, detach, classList } from '@syncfusion/ej2-base';import { Popup, isCollide, createSpinner, showSpinner, hideSpinner } from '@syncfusion/ej2-popups';import { IInput, Input, InputObject, FloatLabelType } from '@syncfusion/ej2-inputs';import { incrementalSearch, resetIncrementalSearchValues } from '../common/incremental-search';import { DropDownBase, dropDownBaseClasses, SelectEventArgs, FilteringEventArgs, PopupEventArgs } from '../drop-down-base/drop-down-base';import { FocusEventArgs, ResultData, BeforeOpenEventArgs } from '../drop-down-base/drop-down-base';import { FieldSettingsModel } from '../drop-down-base/drop-down-base-model';import { DataManager, Query, Predicate, DataOptions } from '@syncfusion/ej2-data';import {VirtualScroll, Offsets, ScrollDirection, SentinelType, VirtualInfo} from '../common/virtual-scroll';import { Skeleton } from '@syncfusion/ej2-notifications';
+import { EventHandler, Property, Event, compile, EmitType, KeyboardEvents, append, select, ModuleDeclaration } from '@syncfusion/ej2-base';
 import {ChangeEventArgs} from "./drop-down-list";
 import {DropDownBaseModel} from "../drop-down-base/drop-down-base-model";
 
@@ -8,260 +8,260 @@ import {DropDownBaseModel} from "../drop-down-base/drop-down-base-model";
 export interface DropDownListModel extends DropDownBaseModel{
 
     /**
-     * Sets CSS classes to the root element of the component that allows customization of appearance.
-     *
-     * @default null
-     */
-    cssClass?: string;
+     * Sets CSS classes to the root element of the component that allows customization of appearance.
+     *
+     * @default null
+     */
+    cssClass?: string;
 
     /**
-     * Specifies the width of the component. By default, the component width sets based on the width of
-     * its parent container. You can also set the width in pixel values.
-     *
-     * @default '100%'
-     * @aspType string
-     */
-    width?: string | number;
+     * Specifies the width of the component. By default, the component width sets based on the width of
+     * its parent container. You can also set the width in pixel values.
+     *
+     * @default '100%'
+     * @aspType string
+     */
+    width?: string | number;
 
     /**
-     * Specifies a value that indicates whether the component is enabled or not.
-     *
-     * @default true
-
-     */
-    enabled?: boolean;
+     * Specifies a value that indicates whether the component is enabled or not.
+     *
+     * @default true
+     * @deprecated
+     */
+    enabled?: boolean;
 
     /**
-     * Enable or disable persisting component's state between page reloads.
-     * If enabled, following list of states will be persisted.
-     * 1. value
-     *
-     * @default false
-
-     */
-    enablePersistence?: boolean;
+     * Enable or disable persisting component's state between page reloads.
+     * If enabled, following list of states will be persisted.
+     * 1. value
+     *
+     * @default false
+     * @deprecated
+     */
+    enablePersistence?: boolean;
 
     /**
-     * Specifies the height of the popup list.
-     * > For more details about the popup configuration refer to
-     * [`Popup Configuration`](../../drop-down-list/getting-started#configure-the-popup-list) documentation.
-     *
-     * @default '300px'
-     * @aspType string
-     */
-    popupHeight?: string | number;
+     * Specifies the height of the popup list.
+     * > For more details about the popup configuration refer to
+     * [`Popup Configuration`](../../drop-down-list/getting-started#configure-the-popup-list) documentation.
+     *
+     * @default '300px'
+     * @aspType string
+     */
+    popupHeight?: string | number;
 
     /**
-     * Specifies the width of the popup list. By default, the popup width sets based on the width of
-     * the component.
-     * > For more details about the popup configuration refer to
-     * [`Popup Configuration`](../../drop-down-list/getting-started#configure-the-popup-list) documentation.
-     *
-     * @default '100%'
-     * @aspType string
-     */
-    popupWidth?: string | number;
+     * Specifies the width of the popup list. By default, the popup width sets based on the width of
+     * the component.
+     * > For more details about the popup configuration refer to
+     * [`Popup Configuration`](../../drop-down-list/getting-started#configure-the-popup-list) documentation.
+     *
+     * @default '100%'
+     * @aspType string
+     */
+    popupWidth?: string | number;
 
     /**
-     * Specifies a short hint that describes the expected value of the DropDownList component.
-     *
-     * @default null
-     */
-    placeholder?: string;
+     * Specifies a short hint that describes the expected value of the DropDownList component.
+     *
+     * @default null
+     */
+    placeholder?: string;
 
     /**
-     * Accepts the value to be displayed as a watermark text on the filter bar.
-     *
-     * @default null
-     */
-    filterBarPlaceholder?: string;
+     * Accepts the value to be displayed as a watermark text on the filter bar.
+     *
+     * @default null
+     */
+    filterBarPlaceholder?: string;
 
     /**
-     * Allows additional HTML attributes such as title, name, etc., and
-     * accepts n number of attributes in a key-value pair format.
-     *
-     * {% codeBlock src='dropdownlist/htmlAttributes/index.md' %}{% endcodeBlock %}
-     *
-     * @default {}
-     */
-    htmlAttributes?: { [key: string]: string };
+     * Allows additional HTML attributes such as title, name, etc., and
+     * accepts n number of attributes in a key-value pair format.
+     *
+     * {% codeBlock src='dropdownlist/htmlAttributes/index.md' %}{% endcodeBlock %}
+     *
+     * @default {}
+     */
+    htmlAttributes?: { [key: string]: string };
 
     /**
-     * Accepts the external `Query`
-     * that execute along with data processing.
-     *
-     * {% codeBlock src='dropdownlist/query/index.md' %}{% endcodeBlock %}
-     *
-     * @default null
-
-     */
-    query?: Query;
+     * Accepts the external `Query`
+     * that execute along with data processing.
+     *
+     * {% codeBlock src='dropdownlist/query/index.md' %}{% endcodeBlock %}
+     *
+     * @default null
+     * @deprecated
+     */
+    query?: Query;
 
     /**
-     * Accepts the template design and assigns it to the selected list item in the input element of the component.
-     * For more details about the available template options refer to
-     * [`Template`](../../drop-down-list/templates) documentation.
-     *
-     * We have built-in `template engine`
-     * which provides options to compile template string into a executable function.
-     * For EX: We have expression evolution as like ES6 expression string literals.
-     *
-     * @default null
-     * @aspType string
-     */
-    valueTemplate?: string | Function;
+     * Accepts the template design and assigns it to the selected list item in the input element of the component.
+     * For more details about the available template options refer to
+     * [`Template`](../../drop-down-list/templates) documentation.
+     *
+     * We have built-in `template engine`
+     * which provides options to compile template string into a executable function.
+     * For EX: We have expression evolution as like ES6 expression string literals.
+     *
+     * @default null
+     * @aspType string
+     */
+    valueTemplate?: string | Function;
 
     /**
-     * Accepts the template design and assigns it to the header container of the popup list.
-     * > For more details about the available template options refer to [`Template`](../../drop-down-list/templates) documentation.
-     *
-     * @default null
-     * @aspType string
-     */
-    headerTemplate?: string | Function;
+     * Accepts the template design and assigns it to the header container of the popup list.
+     * > For more details about the available template options refer to [`Template`](../../drop-down-list/templates) documentation.
+     *
+     * @default null
+     * @aspType string
+     */
+    headerTemplate?: string | Function;
 
     /**
-     * Accepts the template design and assigns it to the footer container of the popup list.
-     * > For more details about the available template options refer to [`Template`](../../drop-down-list/templates) documentation.
-     *
-     * @default null
-     * @aspType string
-     */
-    footerTemplate?: string | Function;
+     * Accepts the template design and assigns it to the footer container of the popup list.
+     * > For more details about the available template options refer to [`Template`](../../drop-down-list/templates) documentation.
+     *
+     * @default null
+     * @aspType string
+     */
+    footerTemplate?: string | Function;
 
     /**
-     * When allowFiltering is set to true, show the filter bar (search box) of the component.
-     * The filter action retrieves matched items through the `filtering` event based on
-     * the characters typed in the search TextBox.
-     *
-     * If no match is found, the value of the `noRecordsTemplate` property will be displayed.
-     * > For more details about the filtering refer to [`Filtering`](../../drop-down-list/filtering) documentation.
-     *
-     * {% codeBlock src="dropdownlist/allow-filtering-api/index.ts" %}{% endcodeBlock %}
-     *
-     * {% codeBlock src="dropdownlist/allow-filtering-api/index.html" %}{% endcodeBlock %}
-     *
-     * @default false
-     */
-    allowFiltering?: boolean;
+     * When allowFiltering is set to true, show the filter bar (search box) of the component.
+     * The filter action retrieves matched items through the `filtering` event based on
+     * the characters typed in the search TextBox.
+     *
+     * If no match is found, the value of the `noRecordsTemplate` property will be displayed.
+     * > For more details about the filtering refer to [`Filtering`](../../drop-down-list/filtering) documentation.
+     *
+     * {% codeBlock src="dropdownlist/allow-filtering-api/index.ts" %}{% endcodeBlock %}
+     *
+     * {% codeBlock src="dropdownlist/allow-filtering-api/index.html" %}{% endcodeBlock %}
+     *
+     * @default false
+     */
+    allowFiltering?: boolean;
 
     /**
-     * When set to true, the user interactions on the component are disabled.
-     *
-     * @default false
-     */
-    readonly?: boolean;
+     * When set to true, the user interactions on the component are disabled.
+     *
+     * @default false
+     */
+    readonly?: boolean;
 
     /**
-     * Defines whether to enable virtual scrolling in the component. 
-     *
-     * @default false
-     */
-    enableVirtualization?: boolean;
+     * Defines whether to enable virtual scrolling in the component. 
+     *
+     * @default false
+     */
+    enableVirtualization?: boolean;
 
     /**
-     * Gets or sets the display text of the selected item in the component.
-     *
-     * @default null
-     */
-    text?: string;
+     * Gets or sets the display text of the selected item in the component.
+     *
+     * @default null
+     */
+    text?: string;
 
     /**
-     * Gets or sets the value of the selected item in the component.
-     *
-     * @default null
-     * @isGenericType true
-     */
-    value?: number | string | boolean;
+     * Gets or sets the value of the selected item in the component.
+     *
+     * @default null
+     * @isGenericType true
+     */
+    value?: number | string | boolean;
 
     /**
-     * Gets or sets the index of the selected item in the component.
-     *
-     * {% codeBlock src="dropdownlist/index-api/index.ts" %}{% endcodeBlock %}
-     *
-     * {% codeBlock src="dropdownlist/index-api/index.html" %}{% endcodeBlock %}
-     *
-     * @default null
-     */
-    index?: number;
+     * Gets or sets the index of the selected item in the component.
+     *
+     * {% codeBlock src="dropdownlist/index-api/index.ts" %}{% endcodeBlock %}
+     *
+     * {% codeBlock src="dropdownlist/index-api/index.html" %}{% endcodeBlock %}
+     *
+     * @default null
+     */
+    index?: number;
 
     /**
-     * Specifies whether to display the floating label above the input element.
-     * Possible values are:
-     * * Never: The label will never float in the input when the placeholder is available.
-     * * Always: The floating label will always float above the input.
-     * * Auto: The floating label will float above the input after focusing or entering a value in the input.
-     *
-     * {% codeBlock src="dropdownlist/float-label-type-api/index.ts" %}{% endcodeBlock %}
-     *
-     * {% codeBlock src="dropdownlist/float-label-type-api/index.html" %}{% endcodeBlock %}
-     *
-     * @default Syncfusion.EJ2.Inputs.FloatLabelType.Never
-     * @aspType Syncfusion.EJ2.Inputs.FloatLabelType
-     * @isEnumeration true
-     */
-    floatLabelType?: FloatLabelType;
+     * Specifies whether to display the floating label above the input element.
+     * Possible values are:
+     * * Never: The label will never float in the input when the placeholder is available.
+     * * Always: The floating label will always float above the input.
+     * * Auto: The floating label will float above the input after focusing or entering a value in the input.
+     *
+     * {% codeBlock src="dropdownlist/float-label-type-api/index.ts" %}{% endcodeBlock %}
+     *
+     * {% codeBlock src="dropdownlist/float-label-type-api/index.html" %}{% endcodeBlock %}
+     *
+     * @default Syncfusion.EJ2.Inputs.FloatLabelType.Never
+     * @aspType Syncfusion.EJ2.Inputs.FloatLabelType
+     * @isEnumeration true
+     */
+    floatLabelType?: FloatLabelType;
 
     /**
-     * Specifies whether to show or hide the clear button.
-     * When the clear button is clicked, `value`, `text`, and `index` properties are reset to null.
-     *
-     * @default false
-     */
-    showClearButton?: boolean;
+     * Specifies whether to show or hide the clear button.
+     * When the clear button is clicked, `value`, `text`, and `index` properties are reset to null.
+     *
+     * @default false
+     */
+    showClearButton?: boolean;
 
     /**
-     * Triggers on typing a character in the filter bar when the
-     * [`allowFiltering`](./#allowfiltering)
-     * is enabled.
-     * > For more details about the filtering refer to [`Filtering`](../../drop-down-list/filtering) documentation.
-     *
-     * @event filtering
-     */
-    filtering?: EmitType<FilteringEventArgs>;
+     * Triggers on typing a character in the filter bar when the
+     * [`allowFiltering`](./#allowfiltering)
+     * is enabled.
+     * > For more details about the filtering refer to [`Filtering`](../../drop-down-list/filtering) documentation.
+     *
+     * @event filtering
+     */
+    filtering?: EmitType<FilteringEventArgs>;
 
     /**
-     * Triggers when an item in a popup is selected or when the model value is changed by user.
-     * Use change event to
-     * [`Configure the Cascading DropDownList`](../../drop-down-list/how-to/cascading)
-     *
-     * @event change
-     */
-    change?: EmitType<ChangeEventArgs>;
+     * Triggers when an item in a popup is selected or when the model value is changed by user.
+     * Use change event to
+     * [`Configure the Cascading DropDownList`](../../drop-down-list/how-to/cascading)
+     *
+     * @event change
+     */
+    change?: EmitType<ChangeEventArgs>;
 
     /**
-     * Triggers when the popup before opens.
-     *
-     * @event beforeOpen
-     */
-    beforeOpen?: EmitType<Object>;
+     * Triggers when the popup before opens.
+     *
+     * @event beforeOpen
+     */
+    beforeOpen?: EmitType<Object>;
 
     /**
-     * Triggers when the popup opens.
-     *
-     * @event open
-     */
-    open?: EmitType<PopupEventArgs>;
+     * Triggers when the popup opens.
+     *
+     * @event open
+     */
+    open?: EmitType<PopupEventArgs>;
 
     /**
-     * Triggers when the popup is closed.
-     *
-     * @event close
-     */
-    close?: EmitType<PopupEventArgs>;
+     * Triggers when the popup is closed.
+     *
+     * @event close
+     */
+    close?: EmitType<PopupEventArgs>;
 
     /**
-     * Triggers when focus moves out from the component.
-     *
-     * @event blur
-     */
-    blur?: EmitType<Object>;
+     * Triggers when focus moves out from the component.
+     *
+     * @event blur
+     */
+    blur?: EmitType<Object>;
 
     /**
-     * Triggers when the component is focused.
-     *
-     * @event focus
-     */
-    focus?: EmitType<Object>;
+     * Triggers when the component is focused.
+     *
+     * @event focus
+     */
+    focus?: EmitType<Object>;
 
 }

package/src/drop-down-list/drop-down-list.d.ts

@@ -158,7 +158,7 @@ export declare class DropDownList extends DropDownBase implements IInput {
      * Specifies a value that indicates whether the component is enabled or not.
      *
      * @default true
-
+     * @deprecated
      */
     enabled: boolean;
     /**
@@ -167,7 +167,7 @@ export declare class DropDownList extends DropDownBase implements IInput {
      * 1. value
      *
      * @default false
-
+     * @deprecated
      */
     enablePersistence: boolean;
     /**
@@ -219,7 +219,7 @@ export declare class DropDownList extends DropDownBase implements IInput {
      * {% codeBlock src='dropdownlist/query/index.md' %}{% endcodeBlock %}
      *
      * @default null
-
+     * @deprecated
      */
     query: Query;
     /**
@@ -523,7 +523,7 @@ export declare class DropDownList extends DropDownBase implements IInput {
      * @param {Query} query - Specify the query to filter the data.
      * @param {FieldSettingsModel} fields - Specify the fields to map the column in the data table.
      * @returns {void}
-
+     * @deprecated
      */
     filter(dataSource: {
         [key: string]: Object;

package/src/drop-down-list/drop-down-list.js

@@ -1,22 +1,22 @@
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
 // eslint-disable-next-line @typescript-eslint/triple-slash-reference
 /// <reference path='../drop-down-base/drop-down-base-model.d.ts'/>
 import { EventHandler, Property, Event, compile, KeyboardEvents, append, select } from '@syncfusion/ej2-base';
@@ -1039,6 +1039,7 @@ var DropDownList = /** @class */ (function (_super) {
                 this.isDocumentClick = true;
                 var isActive = this.isRequested;
                 this.hidePopup(e);
+                this.isInteracted = false;
                 if (!isActive) {
                     this.onFocusOut();
                     this.inputWrapper.container.classList.remove(dropDownListClasses.inputFocus);
@@ -1226,6 +1227,7 @@ var DropDownList = /** @class */ (function (_super) {
         }
     };
     DropDownList.prototype.setSelection = function (li, e) {
+        var _this = this;
         if (this.isValidLI(li) && (!li.classList.contains(dropDownBaseClasses.selected) || (this.isPopupOpen && this.isSelected
             && li.classList.contains(dropDownBaseClasses.selected)))) {
             this.updateSelectedItem(li, e, false, true);
@@ -1234,10 +1236,21 @@ var DropDownList = /** @class */ (function (_super) {
             this.setSelectOptions(li, e);
             if (this.enableVirtualization) {
                 var fields = (this.fields.value) ? this.fields.value : '';
-                var getItem = new DataManager(this.dataSource).executeLocal(new Query().where(new Predicate(fields, 'equal', this.value)));
-                if (getItem && getItem.length > 0) {
-                    this.itemData = getItem[0];
-                    this.setProperties({ 'text': getItem[0].text, 'value': getItem[0].value }, true);
+                if (this.dataSource instanceof DataManager) {
+                    this.dataSource.executeQuery(new Query().where(new Predicate(fields, 'equal', this.value)))
+                        .then(function (e) {
+                        if (e.result.length > 0) {
+                            _this.itemData = e.result[0];
+                            _this.setProperties({ 'text': e.result[0].text, 'value': e.result[0].value }, true);
+                        }
+                    });
+                }
+                else {
+                    var getItem = new DataManager(this.dataSource).executeLocal(new Query().where(new Predicate(fields, 'equal', this.value)));
+                    if (getItem && getItem.length > 0) {
+                        this.itemData = getItem[0];
+                        this.setProperties({ 'text': getItem[0].text, 'value': getItem[0].value }, true);
+                    }
                 }
             }
         }
@@ -1631,7 +1644,7 @@ var DropDownList = /** @class */ (function (_super) {
      * @param {Query} query - Specify the query to filter the data.
      * @param {FieldSettingsModel} fields - Specify the fields to map the column in the data table.
      * @returns {void}
-
+     * @deprecated
      */
     DropDownList.prototype.filter = function (dataSource, query, fields) {
         this.isCustomFilter = true;
@@ -2985,7 +2998,7 @@ var DropDownList = /** @class */ (function (_super) {
             EventHandler.add(this.list, 'scroll', this.setFloatingHeader, this);
         }
         if (!(!isNullOrUndefined(props) && (isNullOrUndefined(props.dataSource)
-            || (!(props.dataSource instanceof DataManager) && props.dataSource.length === 0))) || !(props.dataSource === [])) {
+            || (!(props.dataSource instanceof DataManager) && props.dataSource.length === 0))) || !(Array.isArray(props.dataSource) && props.dataSource.length === 0)) {
             this.typedString = '';
             this.resetList(this.dataSource);
         }
@@ -3334,7 +3347,9 @@ var DropDownList = /** @class */ (function (_super) {
                 });
             }
         }
-        this.invokeRenderPopup(e);
+        if (this.beforePopupOpen) {
+            this.invokeRenderPopup(e);
+        }
         if (this.enableVirtualization && !this.allowFiltering && this.selectedValueInfo != null && this.selectedValueInfo.startIndex > 0 && this.value != null) {
             this.notify("dataProcessAsync", {
                 module: "VirtualScroll",
@@ -3394,7 +3409,6 @@ var DropDownList = /** @class */ (function (_super) {
             this.isSelectCustom = false;
             this.clearAll(e);
         }
-        this.isInteracted = false;
     };
     /* eslint-disable valid-jsdoc, jsdoc/require-param */
     /**