@syncfusion/ej2-dropdowns 21.2.8 → 22.1.34

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

@@ -5,19 +5,15 @@ import { KeyboardEventArgs } from '@syncfusion/ej2-base';
 import { DataManager, Query } from '@syncfusion/ej2-data';
 import { Popup } from '@syncfusion/ej2-popups';
 import { DropDownTreeModel, FieldsModel, TreeSettingsModel } from './drop-down-tree-model';
-export declare type TreeFilterType = 
 /**
-* Checks whether a value begins with the specified value.
-*/
-'StartsWith' | 
-/**
-* Checks whether a value ends with the specified value.
-*/
-'EndsWith' | 
-/**
-* Checks whether a value contains with specified value.
-*/
-'Contains';
+ * Specifies the different ways to filter values
+ * ```props
+ * StartsWith :- Checks whether a value begins with the specified value.
+ * EndsWith :- Checks whether a value ends with the specified value.
+ * Contains :- Checks whether a value contains with specified value.
+ * ```
+ */
+export declare type TreeFilterType = 'StartsWith' | 'EndsWith' | 'Contains';
 export declare class Fields extends ChildProperty<Fields> {
     /**
      * This field specifies the child items or mapping field for the nested child items that contains an array of JSON objects.
@@ -222,53 +218,35 @@ export interface DdtKeyPressEventArgs {
      */
     event: KeyboardEventArgs;
 }
-export declare type Mode = 
-/**
-* On blur component will act in the delimiter mode.
-*/
-'Default' | 
-/**
-* Selected items will be visualized in the text content.
-*/
-'Delimiter' | 
-/**
-* Selected items will be visualized in chip.
-*/
-'Box' | 
-/**
-* Selected items will be visualized with the given custom template value
-*/
-'Custom';
-export declare type SortOrder = 
-/**
-* Indicates that the nodes are not sorted.
-*/
-'None' | 
 /**
-* Indicates that the nodes are sorted in the ascending order.
-*/
-'Ascending' | 
-/**
-*  Indicates that the nodes are sorted in the descending order
-*/
-'Descending';
-export declare type ExpandOn = 
-/**
-* Determines automatically whether to trigger the single click or double-click event.
-*/
-'Auto' | 
-/**
-* Triggers the single click event when an item is double-clicekd.
-*/
-'Click' | 
+ * Configures visibility mode for component interaction when allowMultiSelection or checkbox is enabled.
+ * ```props
+ * Default :- On blur component will act in the delimiter mode.
+ * Delimiter :- Selected items will be visualized in the text content.
+ * Box :- Selected items will be visualized in chip.
+ * Custom :- Selected items will be visualized with the given custom template value.
+ * ```
+ */
+export declare type Mode = 'Default' | 'Delimiter' | 'Box' | 'Custom';
 /**
-* Triggers the double-click event when an item is double-clicekd.
-*/
-'DblClick' | 
+ * Specifies a value that indicates whether the items are sorted in the ascending or descending order, or not sorted at all.
+ * ```props
+ * None :- Indicates that the nodes are not sorted.
+ * Ascending :- Indicates that the nodes are sorted in the ascending order.
+ * Descending :- Indicates that the nodes are sorted in the descending order.
+ * ```
+ */
+export declare type SortOrder = 'None' | 'Ascending' | 'Descending';
 /**
-* Does not trigger any event when the user double-clicks on an item.
-*/
-'None';
+ * Specifies the expansion of tree nodes within the Dropdown Tree.
+ * ```props
+ * Auto :- In desktop, the expand or collapse operation happens when you double-click the node, and in mobile devices it happens on single-tap.
+ * Click :- The expand or collapse operation happens when you perform single-click/tap on the pop-up item in both desktop and mobile devices.
+ * DblClick :- The expand or collapse operation happens when you perform a double-click/tap on the pop-up item in both desktop and mobile devices.
+ * None :- The expand or collapse operation will not happen when you perform single-click/tap or double-click/tap on the pop-up items in both desktop and mobile devices.
+ * ```
+ */
+export declare type ExpandOn = 'Auto' | 'Click' | 'DblClick' | 'None';
 /**
  * The Dropdown Tree control allows you to select single or multiple values from hierarchical data in a tree-like structure.
  * It has several out-of-the-box features, such as data binding, check boxes, templates, filter,
@@ -351,8 +329,9 @@ export declare class DropDownTree extends Component<HTMLElement> implements INot
      * Dropdown Tree component when the data fetch request from the remote server fails.
      *
      * @default 'The Request Failed'
+     * @aspType string
      */
-    actionFailureTemplate: string;
+    actionFailureTemplate: string | Function;
     /**
      * When allowFiltering is set to true, it shows the filter bar (search text box) of the component.
      * The filter action retrieves matched items through the **filtering** event based on the characters typed in the search text box.
@@ -388,8 +367,9 @@ export declare class DropDownTree extends Component<HTMLElement> implements INot
      * added to the input instead of the selected item text in the Dropdown Tree when the multi-selection or checkbox support is enabled.
      *
      * @default "${value.length} item(s) selected"
+     * @aspType string
      */
-    customTemplate: string;
+    customTemplate: string | Function;
     /**
      * Defines the value separator character in the input element when multi-selection or checkbox is enabled in the Dropdown Tree.
      * The delimiter character is applicable only for **default** and **delimiter** visibility modes.
@@ -466,8 +446,12 @@ export declare class DropDownTree extends Component<HTMLElement> implements INot
      * By default, the footerTemplate will be null and there will be no footer container for the pop-up list.
      *
      * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
      */
-    footerTemplate: string;
+    footerTemplate: string | Function;
     /**
      * When **ignoreAccent** is set to true, then it ignores the diacritic characters or accents when filtering.
      */
@@ -483,8 +467,12 @@ export declare class DropDownTree extends Component<HTMLElement> implements INot
      * By default, the headerTemplate will be null and there will be no header container for the pop-up list.
      *
      * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
      */
-    headerTemplate: string;
+    headerTemplate: string | Function;
     /**
      * Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.
      *
@@ -500,8 +488,12 @@ export declare class DropDownTree extends Component<HTMLElement> implements INot
      * or HTML element ID holding the content.
      *
      * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
      */
-    itemTemplate: string;
+    itemTemplate: string | Function;
     /**
      * Configures visibility mode for component interaction when allowMultiSelection or checkbox is enabled.
      * Different modes are:
@@ -517,8 +509,9 @@ export declare class DropDownTree extends Component<HTMLElement> implements INot
      * to be displayed within the pop-up.
      *
      * @default 'No Records Found'
+     * @aspType string
      */
-    noRecordsTemplate: string;
+    noRecordsTemplate: string | Function;
     /**
      * Specifies a short hint that describes the expected value of the Dropdown Tree component.
      *

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

@@ -2372,7 +2372,7 @@ var DropDownTree = /** @class */ (function (_super) {
             // eslint-disable-next-line
             var e = void 0;
             try {
-                if (document.querySelectorAll(template).length) {
+                if (typeof template !== 'function' && document.querySelectorAll(template).length) {
                     return compile(document.querySelector(template).innerHTML.trim());
                 }
                 else {

package/src/list-box/list-box.d.ts

@@ -132,6 +132,7 @@ export declare class ListBox extends DropDownBase {
     private toolbarAction;
     private isDataSourceUpdate;
     private dragValue;
+    private customDraggedItem;
     /**
      * Sets the CSS classes to root element of this component, which helps to customize the
      * complete styles.
@@ -457,6 +458,20 @@ export declare class ListBox extends DropDownBase {
      * @returns {void}
      */
     moveDown(value?: string[] | number[] | boolean[]): void;
+    /**
+     * Moves the given value(s) / selected value(s) in Top of the list.
+     *
+     * @param  { string[] | number[] | boolean[] } value - Specifies the value(s).
+     * @returns {void}
+     */
+    moveTop(value?: string[] | number[] | boolean[]): void;
+    /**
+     * Moves the given value(s) / selected value(s) in bottom of the list.
+     *
+     * @param  { string[] | number[] | boolean[] } value - Specifies the value(s).
+     * @returns {void}
+     */
+    moveBottom(value?: string[] | number[] | boolean[]): void;
     /**
      * Moves the given value(s) / selected value(s) to the given / default scoped ListBox.
      *

package/src/list-box/list-box.js

@@ -472,6 +472,7 @@ var ListBox = /** @class */ (function (_super) {
         this.trigger('drag', this.getDragArgs(args));
     };
     ListBox.prototype.beforeDragEnd = function (args) {
+        var items = [];
         this.dragValue = this.getFormattedValue(args.droppedElement.getAttribute('data-value'));
         if (this.value.indexOf(this.dragValue) > -1) {
             args.items = this.getDataByValues(this.value);
@@ -479,7 +480,11 @@ var ListBox = /** @class */ (function (_super) {
         else {
             args.items = this.getDataByValues([this.dragValue]);
         }
+        extend(items, args.items);
         this.trigger('beforeDrop', args);
+        if (args.items !== items) {
+            this.customDraggedItem = args.items;
+        }
     };
     ListBox.prototype.dragEnd = function (args) {
         var _this = this;
@@ -527,6 +532,12 @@ var ListBox = /** @class */ (function (_super) {
             liColl.splice(toIdx_1, 0, liColl.splice(rIdx, 1)[0]);
             if (this.allowDragAll) {
                 selectedOptions = this.value && Array.prototype.indexOf.call(this.value, dropValue) > -1 ? this.value : [dropValue];
+                if (!isNullOrUndefined(this.customDraggedItem)) {
+                    selectedOptions = [];
+                    this.customDraggedItem.forEach(function (item) {
+                        selectedOptions.push(getValue(_this.fields.value, item));
+                    });
+                }
                 selectedOptions.forEach(function (value) {
                     if (value !== dropValue) {
                         var idx = listData.indexOf(_this.getDataByValue(value));
@@ -559,6 +570,12 @@ var ListBox = /** @class */ (function (_super) {
             sortedData = [].slice.call(listObj.sortedData);
             selectedOptions = (this.value && Array.prototype.indexOf.call(this.value, dropValue) > -1 && this.allowDragAll)
                 ? this.value : [dropValue];
+            if (!isNullOrUndefined(this.customDraggedItem)) {
+                selectedOptions = [];
+                this.customDraggedItem.forEach(function (item) {
+                    selectedOptions.push(getValue(_this.fields.value, item));
+                });
+            }
             var fListData_1 = [].slice.call(this.listData);
             var fSortData_1 = [].slice.call(this.sortedData);
             selectedOptions.forEach(function (value, index) {
@@ -629,6 +646,9 @@ var ListBox = /** @class */ (function (_super) {
             var dragArgs1 = extend(destArgs, { currentData: listData });
             dragArgs = extend(dragArgs, { destination: dragArgs1 });
         }
+        if (!isNullOrUndefined(this.customDraggedItem)) {
+            dragArgs.items = this.customDraggedItem;
+        }
         this.trigger('drop', dragArgs);
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         var liCollElem = dragArgs.elements;
@@ -890,6 +910,26 @@ var ListBox = /** @class */ (function (_super) {
         var elem = (value) ? this.getElemByValue(value) : this.getSelectedItems();
         this.moveUpDown(false, false, elem);
     };
+    /**
+     * Moves the given value(s) / selected value(s) in Top of the list.
+     *
+     * @param  { string[] | number[] | boolean[] } value - Specifies the value(s).
+     * @returns {void}
+     */
+    ListBox.prototype.moveTop = function (value) {
+        var elem = (value) ? this.getElemByValue(value) : this.getSelectedItems();
+        this.moveUpDown(null, false, elem, true);
+    };
+    /**
+     * Moves the given value(s) / selected value(s) in bottom of the list.
+     *
+     * @param  { string[] | number[] | boolean[] } value - Specifies the value(s).
+     * @returns {void}
+     */
+    ListBox.prototype.moveBottom = function (value) {
+        var elem = (value) ? this.getElemByValue(value) : this.getSelectedItems();
+        this.moveUpDown(true, false, elem, false, true);
+    };
     /**
      * Moves the given value(s) / selected value(s) to the given / default scoped ListBox.
      *
@@ -1348,7 +1388,7 @@ var ListBox = /** @class */ (function (_super) {
             }
         }
     };
-    ListBox.prototype.moveUpDown = function (isUp, isKey, value) {
+    ListBox.prototype.moveUpDown = function (isUp, isKey, value, isTop, isBottom) {
         var _this = this;
         var elems = this.getSelectedItems();
         if (value) {
@@ -1367,8 +1407,18 @@ var ListBox = /** @class */ (function (_super) {
         (isUp ? elems : elems.reverse()).forEach(function (ele) {
             var jsonToIdx = Array.prototype.indexOf.call(_this.ulElement.querySelectorAll('.e-list-item'), ele);
             var idx = Array.prototype.indexOf.call(_this.ulElement.children, ele);
-            moveTo(_this.ulElement, _this.ulElement, [idx], isUp ? idx - 1 : idx + 2);
-            _this.changeData(idx, isUp ? idx - 1 : idx + 1, isUp ? jsonToIdx - 1 : jsonToIdx + 1, ele);
+            if (isTop) {
+                moveTo(_this.ulElement, _this.ulElement, [idx], 0);
+                _this.changeData(idx, 0, jsonToIdx, ele);
+            }
+            else if (isBottom) {
+                moveTo(_this.ulElement, _this.ulElement, [idx], _this.ulElement.querySelectorAll('.e-list-item').length);
+                _this.changeData(idx, _this.ulElement.querySelectorAll('.e-list-item').length, jsonToIdx, ele);
+            }
+            else {
+                moveTo(_this.ulElement, _this.ulElement, [idx], isUp ? idx - 1 : idx + 2);
+                _this.changeData(idx, isUp ? idx - 1 : idx + 1, isUp ? jsonToIdx - 1 : jsonToIdx + 1, ele);
+            }
         });
         this.trigger('actionComplete', { items: tempItems, eventName: this.toolbarAction });
         elems[0].focus();

package/src/mention/mention-model.d.ts

@@ -112,8 +112,9 @@ export interface MentionModel {
      * Specifies the template for the selected value from the suggestion list.
      *
      * @default null
+     * @aspType string
      */
-    displayTemplate?: string;
+    displayTemplate?: string | Function;
 
     /**
      * Specifies the template for the suggestion list.
@@ -133,8 +134,9 @@ export interface MentionModel {
      * Specifies the template for showing until data is loaded in the popup.
      *
      * @default null
+     * @aspType string
      */
-    spinnerTemplate?: string;
+    spinnerTemplate?: string | Function;
 
     /**
      * Specifies the target selector where the mention component needs to be displayed.

package/src/mention/mention.d.ts

@@ -149,8 +149,9 @@ export declare class Mention extends DropDownBase {
      * Specifies the template for the selected value from the suggestion list.
      *
      * @default null
+     * @aspType string
      */
-    displayTemplate: string;
+    displayTemplate: string | Function;
     /**
      * Specifies the template for the suggestion list.
      *
@@ -167,8 +168,9 @@ export declare class Mention extends DropDownBase {
      * Specifies the template for showing until data is loaded in the popup.
      *
      * @default null
+     * @aspType string
      */
-    spinnerTemplate: string;
+    spinnerTemplate: string | Function;
     /**
      * Specifies the target selector where the mention component needs to be displayed.
      * The mention component listens to the target's user input and displays suggestions as soon as the user inputs the mention character.

package/src/multi-select/multi-select-model.d.ts

@@ -1,4 +1,4 @@
-import { DropDownBase, SelectEventArgs, dropDownBaseClasses, PopupEventArgs, FilteringEventArgs } from '../drop-down-base/drop-down-base';import { FocusEventArgs, BeforeOpenEventArgs, FilterType, FieldSettings, ResultData } from '../drop-down-base/drop-down-base';import { FieldSettingsModel } from '../drop-down-base/drop-down-base-model';import { Popup, createSpinner, showSpinner, hideSpinner } from '@syncfusion/ej2-popups';import { IInput, FloatLabelType, Input } from '@syncfusion/ej2-inputs';import { attributes, setValue, SanitizeHtmlHelper, getValue } from '@syncfusion/ej2-base';import { NotifyPropertyChanges, extend } from '@syncfusion/ej2-base';import { EventHandler, Property, Event, compile, L10n, EmitType, KeyboardEventArgs } from '@syncfusion/ej2-base';import { Animation, AnimationModel, Browser, prepend, Complex } from '@syncfusion/ej2-base';import { Search } from '../common/incremental-search';import { append, addClass, removeClass, closest, detach, remove, select, selectAll } from '@syncfusion/ej2-base';import { getUniqueID, formatUnit, isNullOrUndefined, isUndefined, ModuleDeclaration } from '@syncfusion/ej2-base';import { DataManager, Query, Predicate } from '@syncfusion/ej2-data';import { SortOrder } from '@syncfusion/ej2-lists';import { createFloatLabel, removeFloating, floatLabelFocus, floatLabelBlur, encodePlaceholder } from './float-label';
+import { DropDownBase, SelectEventArgs, dropDownBaseClasses, PopupEventArgs, FilteringEventArgs } from '../drop-down-base/drop-down-base';import { FocusEventArgs, BeforeOpenEventArgs, FilterType, FieldSettings, ResultData } from '../drop-down-base/drop-down-base';import { FieldSettingsModel } from '../drop-down-base/drop-down-base-model';import { Popup, createSpinner, showSpinner, hideSpinner } from '@syncfusion/ej2-popups';import { IInput, FloatLabelType, Input } from '@syncfusion/ej2-inputs';import { attributes, setValue, SanitizeHtmlHelper, getValue } from '@syncfusion/ej2-base';import { NotifyPropertyChanges, extend } from '@syncfusion/ej2-base';import { EventHandler, Property, Event, compile, L10n, EmitType, KeyboardEventArgs } from '@syncfusion/ej2-base';import { Animation, AnimationModel, Browser, prepend, Complex } from '@syncfusion/ej2-base';import { Search } from '../common/incremental-search';import { append, addClass, removeClass, closest, detach, remove, select, selectAll } from '@syncfusion/ej2-base';import { getUniqueID, formatUnit, isNullOrUndefined, isUndefined, ModuleDeclaration } from '@syncfusion/ej2-base';import { DataManager, Query, Predicate, JsonAdaptor } from '@syncfusion/ej2-data';import { SortOrder } from '@syncfusion/ej2-lists';import { createFloatLabel, removeFloating, floatLabelFocus, floatLabelBlur, encodePlaceholder } from './float-label';
 import {visualMode,MultiSelectChangeEventArgs,RemoveEventArgs,ISelectAllEventArgs,TaggingEventArgs,CustomValueEventArgs} from "./multi-select";
 import {DropDownBaseModel} from "../drop-down-base/drop-down-base-model";
 
@@ -43,24 +43,27 @@ export interface MultiSelectModel extends DropDownBaseModel{
      * Accepts the template design and assigns it to the group headers present in the MultiSelect popup list.
      *
      * @default null
+     * @aspType string
      */
-    groupTemplate?: string;
+    groupTemplate?: string | Function;
 
     /**
      * Accepts the template design and assigns it to popup list of MultiSelect component
      * when no data is available on the component.
      *
      * @default 'No records found'
+     * @aspType string
      */
-    noRecordsTemplate?: string;
+    noRecordsTemplate?: string | Function;
 
     /**
      * Accepts the template and assigns it to the popup list content of the MultiSelect component
      * when the data fetch request from the remote server fails.
      *
      * @default 'Request failed'
+     * @aspType string
      */
-    actionFailureTemplate?: string;
+    actionFailureTemplate?: string | Function;
 
     /**
      * Specifies the `sortOrder` to sort the data source. The available type of sort orders are
@@ -240,24 +243,27 @@ export interface MultiSelectModel extends DropDownBaseModel{
      * For EX: We have expression evolution as like ES6 expression string literals.
      *
      * @default null
+     * @aspType string
      */
-    valueTemplate?: 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`](../../multi-select/templates) documentation.
      *
      * @default null
+     * @aspType string
      */
-    headerTemplate?: 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`](../../multi-select/templates) documentation.
      *
      * @default null
+     * @aspType string
      */
-    footerTemplate?: string;
+    footerTemplate?: string | Function;
 
     /**
      * Accepts the template design and assigns it to each list item present in the popup.
@@ -268,8 +274,9 @@ export interface MultiSelectModel extends DropDownBaseModel{
      * For EX: We have expression evolution as like ES6 expression string literals.
      *
      * @default null
+     * @aspType string
      */
-    itemTemplate?: string;
+    itemTemplate?: string | Function;
 
     /**
      * To enable the filtering option in this component.

package/src/multi-select/multi-select.d.ts

@@ -48,6 +48,7 @@ export declare class MultiSelect extends DropDownBase implements IInput {
     private clearIconWidth;
     private previousFilterText;
     private selectedElementID;
+    private focusFirstListItem;
     /**
      * The `fields` property maps the columns of the data table and binds the data to the component.
      * * text - Maps the text column from data table for each list item.
@@ -82,22 +83,25 @@ export declare class MultiSelect extends DropDownBase implements IInput {
      * Accepts the template design and assigns it to the group headers present in the MultiSelect popup list.
      *
      * @default null
+     * @aspType string
      */
-    groupTemplate: string;
+    groupTemplate: string | Function;
     /**
      * Accepts the template design and assigns it to popup list of MultiSelect component
      * when no data is available on the component.
      *
      * @default 'No records found'
+     * @aspType string
      */
-    noRecordsTemplate: string;
+    noRecordsTemplate: string | Function;
     /**
      * Accepts the template and assigns it to the popup list content of the MultiSelect component
      * when the data fetch request from the remote server fails.
      *
      * @default 'Request failed'
+     * @aspType string
      */
-    actionFailureTemplate: string;
+    actionFailureTemplate: string | Function;
     /**
      * Specifies the `sortOrder` to sort the data source. The available type of sort orders are
      * * `None` - The data source is not sorting.
@@ -263,22 +267,25 @@ export declare class MultiSelect extends DropDownBase implements IInput {
      * For EX: We have expression evolution as like ES6 expression string literals.
      *
      * @default null
+     * @aspType string
      */
-    valueTemplate: 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`](../../multi-select/templates) documentation.
      *
      * @default null
+     * @aspType string
      */
-    headerTemplate: 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`](../../multi-select/templates) documentation.
      *
      * @default null
+     * @aspType string
      */
-    footerTemplate: string;
+    footerTemplate: string | Function;
     /**
      * Accepts the template design and assigns it to each list item present in the popup.
      * > For more details about the available template options refer to [`Template`](../../multi-select/templates) documentation.
@@ -288,8 +295,9 @@ export declare class MultiSelect extends DropDownBase implements IInput {
      * For EX: We have expression evolution as like ES6 expression string literals.
      *
      * @default null
+     * @aspType string
      */
-    itemTemplate: string;
+    itemTemplate: string | Function;
     /**
      * To enable the filtering option in this component.
      * Filter action performs when type in search box and collect the matched item through `filtering` event.