@progress/kendo-react-treeview 13.3.0-develop.9 → 13.4.0-develop.1

package/handleTreeViewCheckChange.d.ts

@@ -0,0 +1,75 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { TreeViewExpandChangeEvent } from './events.js';
+import { TreeViewCheckDescriptor } from './TreeViewOperationDescriptors.js';
+/**
+ * The settings that configure the update of the check descriptor.
+ */
+export interface TreeViewCheckChangeSettings {
+    /**
+     * Determines a selection of a single node at a time.
+     */
+    singleMode?: boolean;
+    /**
+     * Determines if the children checkboxes will be selected when the user selects the parent checkbox.
+     */
+    checkChildren?: boolean;
+    /**
+     * Determines if the parent checkbox will be selected when the user selects all its children checkboxes.
+     */
+    checkParents?: boolean;
+}
+/**
+ * A helper function which updates the check descriptor.
+ *
+ * @param event - The event that triggered the change.
+ * @param check - The check descriptor that will be updated.
+ * @param data - The TreeView items.
+ * @param settings - The additional settings that configure the update of the check descriptor.
+ * @param childrenField - The field that points to the dataItem sub items. Defaults to `items`.
+ * The default behavior allows the selection of multiple items.
+ * @returns - The updated copy of the input check descriptor.
+ *
+ * @example
+ * ```jsx
+ * const App = () => {
+ *    const [check, setCheck] = React.useState([]);
+ *    const [items] = React.useState(tree);
+ *
+ *    const onCheckChange = (event) => {
+ *        setCheck(handleTreeViewCheckChange(event, check, items));
+ *    }
+ *
+ *    return (
+ *        <div>
+ *            <TreeView
+ *                checkboxes={true} onCheckChange={onCheckChange}
+ *                data={processTreeViewItems(items, { check })}
+ *            />
+ *            <div style={{ marginTop: 5 }}>
+ *                <i>Press SPACE to check/uncheck the active item</i>
+ *                <div className="example-config">
+ *                    Checked Indices: {check.join(",")}
+ *                </div>
+ *            </div>
+ *        </div>
+ *    );
+ * }
+ *
+ * const tree = [ {
+ *    text: 'Furniture', expanded: true, items: [
+ *        { text: 'Tables & Chairs' }, { text: 'Sofas' }, { text: 'Occasional Furniture' } ]
+ * }, {
+ *    text: 'Decor', expanded: true, items: [
+ *        { text: 'Bed Linen' }, { text: 'Curtains & Blinds' }, { text: 'Carpets' } ]
+ * } ];
+ * ```
+ */
+export declare function handleTreeViewCheckChange(event: TreeViewExpandChangeEvent, check: string[] | TreeViewCheckDescriptor, data?: any[] | null, settings?: TreeViewCheckChangeSettings, childrenField?: string): any[] | (TreeViewCheckDescriptor & {
+    ids: any[];
+});

package/handleTreeViewCheckChange.mjs

@@ -5,18 +5,18 @@
  * Licensed under commercial license. See LICENSE.md in the package root for more information
  *-------------------------------------------------------------------------------------------
  */
-import { getNestedValue as I, isArray as x, getAllDirectIndirectChildrenIds as m, areAllDirectChildrenChecked as p, getAllParents as g, treeIdUtils as u } from "@progress/kendo-react-common";
+import { isArray as I, getNestedValue as x, getAllDirectIndirectChildrenIds as m, areAllDirectChildrenChecked as p, getAllParents as g, treeIdUtils as u } from "@progress/kendo-react-common";
 import { CHILDREN_FIELD as O } from "./utils/consts.mjs";
 function b(i, n, t, s = {}, d) {
   if (!t || !t.length)
     return [];
-  const { ids: l, idField: r } = k(n), c = r ? I(r, i.item) : i.itemHierarchicalIndex, h = l.indexOf(c), o = h === -1, a = d || O;
+  const { ids: l, idField: r } = k(n), c = r ? x(r, i.item) : i.itemHierarchicalIndex, h = l.indexOf(c), o = h === -1, a = d || O;
   let e;
-  return s.singleMode ? e = o ? [c] : [] : (e = l.slice(), o ? e.push(c) : e.splice(h, 1), s.checkChildren && C(i.item, i.itemHierarchicalIndex, o, r, a, e), s.checkParents && D(i.itemHierarchicalIndex, o, r, a, e, t)), x(n) ? e : Object.assign({}, n, { ids: e });
+  return s.singleMode ? e = o ? [c] : [] : (e = l.slice(), o ? e.push(c) : e.splice(h, 1), s.checkChildren && C(i.item, i.itemHierarchicalIndex, o, r, a, e), s.checkParents && D(i.itemHierarchicalIndex, o, r, a, e, t)), I(n) ? e : Object.assign({}, n, { ids: e });
 }
 function k(i) {
   let n, t;
-  return x(i) ? n = i : (n = i.ids || [], t = i.idField), { ids: n, idField: t };
+  return I(i) ? n = i : (n = i.ids || [], t = i.idField), { ids: n, idField: t };
 }
 function C(i, n, t, s, d, l) {
   m(i, n, d, s).forEach((r) => {
@@ -49,7 +49,7 @@ function D(i, n, t, s, d, l) {
     if (t) {
       const e = g(i, s, l);
       for (let f = e.length - 1; f > -1; f--)
-        yield { id: I(t, e[f]), item: n ? e[f] : void 0 };
+        yield { id: x(t, e[f]), item: n ? e[f] : void 0 };
     } else {
       let e = u.getDirectParentId(i);
       for (; e; )