@syncfusion/ej2-lists 25.2.3 → 26.2.4

package/dist/global/index.d.ts

@@ -1,6 +1,6 @@
 /*!
 *  filename: index.d.ts
-*  version : 25.2.3
+*  version : 26.2.4
 *  Copyright Syncfusion Inc. 2001 - 2023. All rights reserved.
 *  Use of this code is subject to the terms of our license.
 *  A copy of the current license can be obtained at any time by e-mailing

package/package.json

@@ -1,8 +1,8 @@
 {
   "_from": "@syncfusion/ej2-lists@*",
-  "_id": "@syncfusion/ej2-lists@25.1.39",
+  "_id": "@syncfusion/ej2-lists@26.1.35",
   "_inBundle": false,
-  "_integrity": "sha512-I1Q257ceQxqo7UHcrv3r9XGCW+Xomxh1QHOCu0V0g6oou48Ieph0Sbc0ScgtgXu7TYpKqIv0cc1EJYXvex0EUQ==",
+  "_integrity": "sha512-vOwoqKOGf7k+iZWQIWoJZhJYZU2wZpqGnyBRYLn7n1g/MVcQPxJbCxyTsw/Vn3JtVbBxpLti0BnW04X97IJEDQ==",
   "_location": "/@syncfusion/ej2-lists",
   "_phantomChildren": {},
   "_requested": {
@@ -35,19 +35,19 @@
     "/@syncfusion/ej2-schedule",
     "/@syncfusion/ej2-vue-lists"
   ],
-  "_resolved": "https://nexus.syncfusioninternal.com/repository/ej2-hotfix-new/@syncfusion/ej2-lists/-/ej2-lists-25.1.39.tgz",
-  "_shasum": "80283ddecbd264a24b1363f8d40ca30501095616",
+  "_resolved": "https://nexus.syncfusioninternal.com/repository/ej2-hotfix-new/@syncfusion/ej2-lists/-/ej2-lists-26.1.35.tgz",
+  "_shasum": "f1e44cd7e717bce96aa80f2f72f40ed059a8d30c",
   "_spec": "@syncfusion/ej2-lists@*",
-  "_where": "/jenkins/workspace/elease-automation_release_25.1.1/packages/included",
+  "_where": "/jenkins/workspace/elease-automation_release_26.1.1/packages/included",
   "author": {
     "name": "Syncfusion Inc."
   },
   "bundleDependencies": false,
   "dependencies": {
-    "@syncfusion/ej2-base": "~25.2.3",
-    "@syncfusion/ej2-buttons": "~25.2.3",
-    "@syncfusion/ej2-data": "~25.2.3",
-    "@syncfusion/ej2-popups": "~25.2.3"
+    "@syncfusion/ej2-base": "~26.2.4",
+    "@syncfusion/ej2-buttons": "~26.2.4",
+    "@syncfusion/ej2-data": "~26.2.4",
+    "@syncfusion/ej2-popups": "~26.2.4"
   },
   "deprecated": false,
   "description": "The listview control allows you to select an item or multiple items from a list-like interface and represents the data in interactive hierarchical structure across different layouts or views.",
@@ -87,7 +87,7 @@
     "url": "https://github.com/syncfusion/ej2-javascript-ui-controls/tree/master/controls/lists"
   },
   "typings": "index.d.ts",
-  "version": "25.2.3",
+  "version": "26.2.4",
   "sideEffects": false,
   "homepage": "https://www.syncfusion.com/javascript-ui-controls"
 }

package/src/common/list-base.d.ts

@@ -44,11 +44,11 @@ export declare namespace ListBase {
      *
      * @param  {{Object}[]} dataSource - Specifies an array of JSON data.
      *
-     * @param  {ListBaseOptions} options? - Specifies the list options that need to provide.
+     * @param  {ListBaseOptions} [options] - Specifies the list options that need to provide.
      *
-     * @param  {boolean} isSingleLevel? - Specifies the list options that need to provide.
+     * @param  {boolean} [isSingleLevel] - Specifies the list options that need to provide.
      *
-     * @param  {any} componentInstance? - Specifies the list options that need to provide.
+     * @param  {any} [componentInstance] - Specifies the list options that need to provide.
      *
      * @returns  {createElement} createListFromJson - Specifies the list options that need to provide.
      */
@@ -62,11 +62,11 @@ export declare namespace ListBase {
      *
      * @param  {{Object}[]} dataSource - Specifies an array of JSON data.
      *
-     * @param  {ListBaseOptions} options? - Specifies the list options that need to provide.
+     * @param  {boolean} [isSingleLevel] - Specifies the list options that need to provide.
      *
-     * @param  {boolean} isSingleLevel? - Specifies the list options that need to provide.
+     * @param  {ListBaseOptions} [options] - Specifies the list options that need to provide.
      *
-     * @param  {any} componentInstance? - Specifies the list options that need to provide.
+     * @param  {any} [componentInstance] - Specifies the list options that need to provide.
      *
      * @returns  {createElement} generateUL - returns the list options that need to provide.
      */
@@ -78,11 +78,11 @@ export declare namespace ListBase {
      *
      * @param  {{Object}[]} dataSource - Specifies an array of JSON data.
      *
-     * @param  {ListBaseOptions} options? - Specifies the list options that need to provide.
+     * @param  {boolean} [isSingleLevel] - Specifies the list options that need to provide.
      *
-     * @param  {boolean} isSingleLevel? - Specifies the list options that need to provide.
+     * @param  {ListBaseOptions} [options] - Specifies the list options that need to provide.
      *
-     * @param  {any} componentInstance? - Specifies the list options that need to provide.
+     * @param  {any} [componentInstance] - Specifies the list options that need to provide.
      *
      * @returns  {HTMLElement[]} subChild - returns the list options that need to provide.
      */
@@ -94,13 +94,13 @@ export declare namespace ListBase {
      *
      * @param  {{Object}[]} dataSource - Specifies an array of JSON data.
      *
-     * @param  {ListBaseOptions} options? - Specifies the list options that need to provide.
+     * @param  {ListBaseOptions} [options] - Specifies the list options that need to provide.
      *
-     * @param  {boolean} isSingleLevel? - Specifies the list options that need to provide.
+     * @param  {number} [level] - Specifies the list options that need to provide.
      *
-     * @param  {number} level? - Specifies the list options that need to provide.
+     * @param  {boolean} [isSingleLevel] - Specifies the list options that need to provide.
      *
-     * @param  {any} componentInstance? - Specifies the list options that need to provide.
+     * @param  {any} [componentInstance] - Specifies the list options that need to provide.
      *
      * @returns  {HTMLElement[]} child - returns the list options that need to provide.
      */
@@ -114,13 +114,13 @@ export declare namespace ListBase {
      *
      * @param  {{Object}[]} dataSource - Specifies an array of JSON data.
      *
-     * @param  {ListBaseOptions} options? - Specifies the list options that need to provide.
+     * @param  {ListBaseOptions} [options] - Specifies the list options that need to provide.
      *
-     * @param  {number} level? - Specifies the list options that need to provide.
+     * @param  {number} [level] - Specifies the list options that need to provide.
      *
-     * @param  {boolean} isSingleLevel? - Specifies the list options that need to provide.
+     * @param  {boolean} [isSingleLevel] - Specifies the list options that need to provide.
      *
-     * @param  {any} componentInstance? - Specifies the list options that need to provide.
+     * @param  {any} [componentInstance] - Specifies the list options that need to provide.
      *
      * @returns  {createElement} generateUL - Specifies the list options that need to provide.
      */
@@ -131,8 +131,9 @@ export declare namespace ListBase {
      * Return the next or previous visible element.
      *
      * @param  {Element[]|NodeList} elementArray - An element array to find next or previous element.
-     * @param  {Element} li - An element to find next or previous after this element.
-     * @param  {boolean} isPrevious? - Specify when the need get previous element from array.
+     * @param  {Element} element - An element to find next or previous after this element.
+     * @param  {boolean} [isPrevious] - Specify when the need get previous element from array.
+     * @returns {Element|undefined} The next or previous visible element, or undefined if the element array is empty.
      */
     function getSiblingLI(elementArray: Element[] | NodeList, element: Element, isPrevious?: boolean): Element;
     /**
@@ -140,6 +141,7 @@ export declare namespace ListBase {
      *
      * @param  {Element} item - An element to find next or previous after this element.
      * @param  {Element[]} elementArray - An element array to find index of given li.
+     * @returns {number} - The index of the item in the element array, or undefined if either parameter is false.
      */
     function indexOf(item: Element, elementArray: Element[] | NodeList): number;
     /**
@@ -147,7 +149,8 @@ export declare namespace ListBase {
      *
      * @param  {{Object}[]} dataSource - The JSON data which is necessary to process.
      * @param  {FieldsMapping} fields - Fields that are mapped from the data source.
-     * @param  {SortOrder} sortOrder- Specifies final result sort order.
+     * @param  {SortOrder} [sortOrder='None'] - Specifies final result sort order. Defaults to 'None'.
+     * @returns {Object[]} - The grouped data.
      */
     function groupDataSource(dataSource: {
         [key: string]: Object;
@@ -160,6 +163,7 @@ export declare namespace ListBase {
      * @param  {SortOrder} sortOrder - Specifies that sort order.
      * @param  {string} sortBy - Specifies sortBy fields.
      * @param  {Query} query - Pass if any existing query.
+     * @returns {Query} - The updated query object with sorting applied.
      */
     function addSorting(sortOrder: SortOrder, sortBy: string, query?: Query): Query;
     /**
@@ -168,6 +172,8 @@ export declare namespace ListBase {
      * @param  {{Object}[]} dataSource - Specifies local JSON data source.
      *
      * @param  {Query} query - Specifies query that need to process.
+     *
+     * @returns {Object[]} - An array of objects representing the retrieved data.
      */
     function getDataSource(dataSource: {
         [key: string]: Object;
@@ -178,7 +184,8 @@ export declare namespace ListBase {
      * Created JSON data based the UL and LI element
      *
      * @param  {HTMLElement|Element} element - UL element that need to convert as a JSON
-     * @param  {ListBaseOptions} options? - Specifies listbase option for fields.
+     * @param  {ListBaseOptions} [options] - Specifies ListBase option for fields.
+     * @returns {Object[]} - An array of objects representing the JSON data.
      */
     function createJsonFromElement(element: HTMLElement | Element, options?: ListBaseOptions): {
         [key: string]: Object;
@@ -186,9 +193,13 @@ export declare namespace ListBase {
     /**
      * Created UL element from content template.
      *
+     * @param  {createElementParams} createElement - Specifies an array of JSON data.
      * @param  {string} template - that need to convert and generate li element.
      * @param  {{Object}[]} dataSource - Specifies local JSON data source.
-     * @param  {ListBaseOptions} options? - Specifies listbase option for fields.
+     * @param  {FieldsMapping} [fields] - Specifies fields for mapping the dataSource.
+     * @param  {ListBaseOptions} [options] - Specifies ListBase option for fields.
+     * @param  {any} [componentInstance] - Specifies component instance.
+     * @returns {HTMLElement} - The generated LI element.
      */
     function renderContentTemplate(createElement: createElementParams, template: string | Function, dataSource: {
         [key: string]: Object;
@@ -196,36 +207,55 @@ export declare namespace ListBase {
     /**
      * Created header items from group template.
      *
-     * @param  {string} template - that need to convert and generate li element.
+     * @param  {string | Function} groupTemplate - that need to convert and generate li element.
      *
-     * @param  {{Object}[]} dataSource - Specifies local JSON data source.
+     * @param {{Object}[]} groupDataSource - Specifies local JSON data source.
      *
      * @param  {FieldsMapping} fields - Specifies fields for mapping the dataSource.
      *
-     * @param  {Element[]} headerItems? - Specifies listbase header items.
+     * @param  {Element[]} headerItems - Specifies ListBase header items.
+     *
+     * @param {ListBaseOptions} [options] - Optional ListBase options.
+     *
+     * @param {*} [componentInstance] - Optional component instance.
+     *
+     * @returns {Element[]} - An array of header elements with the rendered group template content.
      */
     function renderGroupTemplate(groupTemplate: string | Function, groupDataSource: {
         [key: string]: Object;
     }[], fields: FieldsMapping, headerItems: Element[], options?: ListBaseOptions, componentInstance?: any): Element[];
+    /**
+     * Generates a random hexadecimal ID string.
+     *
+     * @returns {string} - The generated ID string.
+     */
     function generateId(): string;
     /**
      * Returns UL element based on the given LI element.
      *
+     * @param {Function} createElement - Function for creating elements.
+     *
      * @param  {HTMLElement[]} liElement - Specifies array of LI element.
      *
-     * @param  {string} className? - Specifies class name that need to be added in UL element.
+     * @param  {string} [className] - Specifies class name that need to be added in UL element.
      *
-     * @param  {ListBaseOptions} options? - Specifies ListBase options.
+     * @param  {ListBaseOptions} [options] - Specifies ListBase options.
+     *
+     * @returns {HTMLElement} - The created UL element.
      */
     function generateUL(createElement: createElementParams, liElement: HTMLElement[], className?: string, options?: ListBaseOptions): HTMLElement;
     /**
      * Returns LI element with additional DIV tag based on the given LI element.
      *
+     * @param {Function} createElement - Function for creating elements.
+     *
      * @param  {liElement} liElement - Specifies LI element.
      *
-     * @param  {string} className? - Specifies class name that need to be added in created DIV element.
+     * @param  {string} [className] - Specifies class name that need to be added in created DIV element.
+     *
+     * @param  {ListBaseOptions} [options] - Specifies ListBase options.
      *
-     * @param  {ListBaseOptions} options? - Specifies ListBase options.
+     * @returns {HTMLElement} - The modified LI element.
      */
     function generateIcon(createElement: createElementParams, liElement: HTMLElement, className?: string, options?: ListBaseOptions): HTMLElement;
 }
@@ -373,9 +403,10 @@ export interface ListBaseOptions {
 /**
  * Used to get dataSource item from complex data using fields.
  *
- * @param {Object} dataSource - Specifies an  JSON or String data.
+ * @param {Object} dataItem - Specifies an  JSON or String data.
  *
  * @param {FieldsMapping} fields - Fields that are mapped from the dataSource.
+ * @returns {Object|string|number} - The retrieved field values.
  */
 export declare function getFieldValues(dataItem: {
     [key: string]: Object;