@itwin/components-react 4.17.1 → 5.0.0-dev.2

package/lib/components-react/tree/controlled/TreeEventDispatcher.js

@@ -0,0 +1,209 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Tree
+ */
+import { asapScheduler, concat, concatAll, concatMap, defer, distinctUntilChanged, EMPTY, filter, finalize, from, map, merge, mergeAll, of, shareReplay, subscribeOn, toArray, } from "rxjs";
+import { isRangeSelection, TreeSelectionManager, } from "./internal/TreeSelectionManager.js";
+import { isTreeModelNode } from "./TreeModel.js";
+import { toRxjsObservable } from "./Observable.js";
+/**
+ * Default event dispatcher that emits tree events according performed actions.
+ * It converts low level tree events into TreeEvents.
+ * @internal
+ */
+export class TreeEventDispatcher {
+    constructor(treeEvents, nodeLoader, selectionMode, getVisibleNodes) {
+        this._activeSelections = new Set();
+        this._treeEvents = treeEvents;
+        this._nodeLoader = nodeLoader;
+        this._getVisibleNodes = getVisibleNodes;
+        this._selectionManager = new TreeSelectionManager(selectionMode, this._getVisibleNodes);
+        this._selectionManager.onDragSelection.addListener(({ selectionChanges }) => {
+            const modifications = selectionChanges.pipe(map(({ selectedNodes, deselectedNodes }) => this.collectSelectionChanges(selectedNodes, []).pipe(concatMap(({ selectedNodeItems }) => from(selectedNodeItems)), toArray(), map((collectedIds) => ({
+                selectedNodeItems: collectedIds,
+                deselectedNodeItems: this.collectNodeItems(deselectedNodes),
+            })))), concatAll(), shareReplay({
+                refCount: true,
+            }));
+            if (this._treeEvents.onSelectionModified !== undefined)
+                this._treeEvents.onSelectionModified({ modifications });
+        });
+        this._selectionManager.onSelectionChanged.addListener(({ selectedNodes, deselectedNodes }) => {
+            const modifications = merge(defer(() => {
+                this._activeSelections.add(modifications);
+                return EMPTY;
+            }), this.collectSelectionChanges(selectedNodes, deselectedNodes)).pipe(finalize(() => {
+                this._activeSelections.delete(modifications);
+            }), shareReplay({
+                refCount: true,
+            }));
+            if (this._treeEvents.onSelectionModified !== undefined)
+                this._treeEvents.onSelectionModified({ modifications });
+        });
+        this._selectionManager.onSelectionReplaced.addListener(({ selectedNodeIds }) => {
+            const replacements = merge(defer(() => {
+                this._activeSelections.add(replacements);
+                return EMPTY;
+            }), this.collectSelectionChanges(selectedNodeIds, [])).pipe(finalize(() => {
+                this._activeSelections.delete(replacements);
+            }), shareReplay({
+                refCount: true,
+            }));
+            if (this._treeEvents.onSelectionReplaced !== undefined)
+                this._treeEvents.onSelectionReplaced({ replacements });
+        });
+    }
+    onNodeCheckboxClicked(nodeId, newState) {
+        const visibleNodes = this._getVisibleNodes();
+        const clickedNode = visibleNodes.getModel().getNode(nodeId);
+        if (clickedNode === undefined)
+            return;
+        const immediateStateChanges = [{ nodeItem: clickedNode.item, newState }];
+        if (clickedNode.isSelected) {
+            for (const node of visibleNodes) {
+                if (isTreeModelNode(node) &&
+                    node.id !== clickedNode.id &&
+                    node.isSelected &&
+                    node.checkbox.state !== newState) {
+                    immediateStateChanges.push({ nodeItem: node.item, newState });
+                }
+            }
+        }
+        const stateChanges = concat(of(immediateStateChanges), from(this._activeSelections).pipe(mergeAll(), map(({ selectedNodeItems }) => selectedNodeItems.map((item) => ({ nodeItem: item, newState }))))).pipe(shareReplay({
+            refCount: true,
+        }));
+        if (this._treeEvents.onCheckboxStateChanged !== undefined)
+            this._treeEvents.onCheckboxStateChanged({ stateChanges });
+    }
+    onNodeExpanded(nodeId) {
+        if (this._treeEvents.onNodeExpanded !== undefined)
+            this._treeEvents.onNodeExpanded({ nodeId });
+    }
+    onNodeCollapsed(nodeId) {
+        if (this._treeEvents.onNodeCollapsed !== undefined)
+            this._treeEvents.onNodeCollapsed({ nodeId });
+    }
+    onNodeClicked(nodeId, event) {
+        const node = this._getVisibleNodes().getModel().getNode(nodeId);
+        const isNodeSelected = node && node.isSelected;
+        if (event.detail === 2 &&
+            this._treeEvents.onNodeDoubleClick !== undefined) {
+            this._treeEvents.onNodeDoubleClick({ nodeId });
+            // trigger onNodeClicked as to not lose highlight of the node when double clicking.
+            !isNodeSelected && this._selectionManager.onNodeClicked(nodeId, event);
+        }
+        else {
+            this._selectionManager.onNodeClicked(nodeId, event);
+        }
+        // if clicked node was already selected fire delayed click event
+        if (isNodeSelected && this._treeEvents.onDelayedNodeClick !== undefined) {
+            this._treeEvents.onDelayedNodeClick({ nodeId });
+        }
+    }
+    onNodeMouseDown(nodeId) {
+        this._selectionManager.onNodeMouseDown(nodeId);
+    }
+    onNodeMouseMove(nodeId) {
+        this._selectionManager.onNodeMouseMove(nodeId);
+    }
+    onNodeEditorActivated(nodeId) {
+        const node = this._getVisibleNodes().getModel().getNode(nodeId);
+        const isNodeSelected = node ? node.isSelected : false;
+        // if node was already selected, fire onNodeEditorActivated event
+        if (isNodeSelected &&
+            this._treeEvents.onNodeEditorActivated !== undefined) {
+            this._treeEvents.onNodeEditorActivated({ nodeId });
+        }
+    }
+    onTreeKeyDown(event) {
+        this._selectionManager.onTreeKeyDown(event, this);
+    }
+    onTreeKeyUp(event) {
+        this._selectionManager.onTreeKeyUp(event, this);
+    }
+    collectSelectionChanges(selection, deselection) {
+        const deselectedItems = this.collectNodeItems(deselection);
+        if (isRangeSelection(selection)) {
+            return this.collectNodesBetween(selection.from, selection.to).pipe(map((selectedNodeItems, index) => {
+                return {
+                    selectedNodeItems,
+                    deselectedNodeItems: index === 0 ? deselectedItems : [],
+                };
+            }));
+        }
+        const selectedItems = this.collectNodeItems(selection);
+        return of({
+            selectedNodeItems: selectedItems,
+            deselectedNodeItems: deselectedItems,
+        });
+    }
+    collectNodesBetween(nodeId1, nodeId2) {
+        const [readyNodes, nodesToLoad] = TreeEventDispatcher.groupNodesByLoadingState(this.iterateNodesBetween(nodeId1, nodeId2));
+        const loadedSelectedNodes = from(nodesToLoad.map((node) => {
+            const parentNode = node.parentId
+                ? this._getVisibleNodes().getModel().getNode(node.parentId)
+                : this._getVisibleNodes().getModel().getRootNode();
+            return parentNode
+                ? toRxjsObservable(this._nodeLoader.loadNode(parentNode, node.childIndex))
+                : EMPTY;
+        })).pipe(
+        // We have requested multiple nodes that may belong to the same page.
+        // When the page loads we only want to process the loaded nodes once.
+        // Making assumption that loaded nodes from the same page will be emitted without interruptions.
+        // Maybe we could simplify this to `this._nodeLoader.loadNodes(nodesToLoad)`?
+        mergeAll(), distinctUntilChanged());
+        return concat(of(readyNodes
+            .filter((node) => !node.isSelectionDisabled)
+            .map((node) => node.item)), loadedSelectedNodes.pipe(map(({ loadedNodes }) => loadedNodes.filter((item) => !item.isSelectionDisabled)))).pipe(filter((nodeItems) => nodeItems.length > 0), 
+        // Give enough time for multiple subscribers to subscribe before any emissions begin
+        subscribeOn(asapScheduler));
+    }
+    *iterateNodesBetween(nodeId1, nodeId2) {
+        let firstNodeFound = false;
+        for (const node of this._getVisibleNodes()) {
+            if (firstNodeFound) {
+                yield node;
+            }
+            if (isTreeModelNode(node)) {
+                if (nodeId1 === nodeId2 && node.id === nodeId1) {
+                    yield node;
+                    return;
+                }
+                if (node.id === nodeId1 || node.id === nodeId2) {
+                    if (firstNodeFound) {
+                        return;
+                    }
+                    firstNodeFound = true;
+                    yield node;
+                }
+            }
+        }
+    }
+    collectNodeItems(nodeIds) {
+        const items = [];
+        for (const nodeId of nodeIds) {
+            const node = this._getVisibleNodes().getModel().getNode(nodeId);
+            if (node !== undefined && !node.isSelectionDisabled) {
+                items.push(node.item);
+            }
+        }
+        return items;
+    }
+    static groupNodesByLoadingState(nodes) {
+        const loadedNodeItems = [];
+        const nodesToLoad = [];
+        for (const node of nodes) {
+            if (isTreeModelNode(node)) {
+                loadedNodeItems.push(node);
+            }
+            else {
+                nodesToLoad.push(node);
+            }
+        }
+        return [loadedNodeItems, nodesToLoad];
+    }
+}
+//# sourceMappingURL=TreeEventDispatcher.js.map

package/lib/components-react/tree/controlled/TreeEventDispatcher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TreeEventDispatcher.js","sourceRoot":"","sources":["../../../../src/components-react/tree/controlled/TreeEventDispatcher.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAGH,OAAO,EACL,aAAa,EACb,MAAM,EACN,SAAS,EACT,SAAS,EACT,KAAK,EACL,oBAAoB,EACpB,KAAK,EACL,MAAM,EACN,QAAQ,EACR,IAAI,EACJ,GAAG,EACH,KAAK,EACL,QAAQ,EACR,EAAE,EACF,WAAW,EACX,WAAW,EACX,OAAO,GACR,MAAM,MAAM,CAAC;AAOd,OAAO,EACL,gBAAgB,EAChB,oBAAoB,GACrB,MAAM,oCAAoC,CAAC;AAQ5C,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAGnD;;;;GAIG;AACH,MAAM,OAAO,mBAAmB;IAc9B,YACE,UAAsB,EACtB,UAA2B,EAC3B,aAA4B,EAC5B,eAAuC;QAXjC,sBAAiB,GAAG,IAAI,GAAG,EAKhC,CAAC;QAQF,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;QAExC,IAAI,CAAC,iBAAiB,GAAG,IAAI,oBAAoB,CAC/C,aAAa,EACb,IAAI,CAAC,gBAAgB,CACtB,CAAC;QAEF,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,WAAW,CAChD,CAAC,EAAE,gBAAgB,EAAE,EAAE,EAAE;YACvB,MAAM,aAAa,GAAG,gBAAgB,CAAC,IAAI,CACzC,GAAG,CAAC,CAAC,EAAE,aAAa,EAAE,eAAe,EAAE,EAAE,EAAE,CACzC,IAAI,CAAC,uBAAuB,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC,IAAI,CAClD,SAAS,CAAC,CAAC,EAAE,iBAAiB,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,EAC7D,OAAO,EAAE,EACT,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;gBACrB,iBAAiB,EAAE,YAAY;gBAC/B,mBAAmB,EAAE,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC;aAC5D,CAAC,CAAC,CACJ,CACF,EACD,SAAS,EAAE,EACX,WAAW,CAAC;gBACV,QAAQ,EAAE,IAAI;aACf,CAAC,CACH,CAAC;YAEF,IAAI,IAAI,CAAC,WAAW,CAAC,mBAAmB,KAAK,SAAS;gBACpD,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC;QAC5D,CAAC,CACF,CAAC;QAEF,IAAI,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,WAAW,CACnD,CAAC,EAAE,aAAa,EAAE,eAAe,EAAE,EAAE,EAAE;YACrC,MAAM,aAAa,GAAG,KAAK,CACzB,KAAK,CAAC,GAAG,EAAE;gBACT,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;gBAC1C,OAAO,KAAK,CAAC;YACf,CAAC,CAAC,EACF,IAAI,CAAC,uBAAuB,CAAC,aAAa,EAAE,eAAe,CAAC,CAC7D,CAAC,IAAI,CACJ,QAAQ,CAAC,GAAG,EAAE;gBACZ,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;YAC/C,CAAC,CAAC,EACF,WAAW,CAAC;gBACV,QAAQ,EAAE,IAAI;aACf,CAAC,CACH,CAAC;YAEF,IAAI,IAAI,CAAC,WAAW,CAAC,mBAAmB,KAAK,SAAS;gBACpD,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC;QAC5D,CAAC,CACF,CAAC;QAEF,IAAI,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,WAAW,CACpD,CAAC,EAAE,eAAe,EAAE,EAAE,EAAE;YACtB,MAAM,YAAY,GAAG,KAAK,CACxB,KAAK,CAAC,GAAG,EAAE;gBACT,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;gBACzC,OAAO,KAAK,CAAC;YACf,CAAC,CAAC,EACF,IAAI,CAAC,uBAAuB,CAAC,eAAe,EAAE,EAAE,CAAC,CAClD,CAAC,IAAI,CACJ,QAAQ,CAAC,GAAG,EAAE;gBACZ,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;YAC9C,CAAC,CAAC,EACF,WAAW,CAAC;gBACV,QAAQ,EAAE,IAAI;aACf,CAAC,CACH,CAAC;YAEF,IAAI,IAAI,CAAC,WAAW,CAAC,mBAAmB,KAAK,SAAS;gBACpD,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;QAC3D,CAAC,CACF,CAAC;IACJ,CAAC;IAEM,qBAAqB,CAAC,MAAc,EAAE,QAAuB;QAClE,MAAM,YAAY,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC7C,MAAM,WAAW,GAAG,YAAY,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC5D,IAAI,WAAW,KAAK,SAAS;YAAE,OAAO;QAEtC,MAAM,qBAAqB,GAAG,CAAC,EAAE,QAAQ,EAAE,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;QACzE,IAAI,WAAW,CAAC,UAAU,EAAE,CAAC;YAC3B,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;gBAChC,IACE,eAAe,CAAC,IAAI,CAAC;oBACrB,IAAI,CAAC,EAAE,KAAK,WAAW,CAAC,EAAE;oBAC1B,IAAI,CAAC,UAAU;oBACf,IAAI,CAAC,QAAQ,CAAC,KAAK,KAAK,QAAQ,EAChC,CAAC;oBACD,qBAAqB,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;gBAChE,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,CACzB,EAAE,CAAC,qBAAqB,CAAC,EACzB,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAC/B,QAAQ,EAAE,EACV,GAAG,CAAC,CAAC,EAAE,iBAAiB,EAAE,EAAE,EAAE,CAC5B,iBAAiB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,CAChE,CACF,CACF,CAAC,IAAI,CACJ,WAAW,CAAC;YACV,QAAQ,EAAE,IAAI;SACf,CAAC,CACH,CAAC;QAEF,IAAI,IAAI,CAAC,WAAW,CAAC,sBAAsB,KAAK,SAAS;YACvD,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;IAC9D,CAAC;IAEM,cAAc,CAAC,MAAc;QAClC,IAAI,IAAI,CAAC,WAAW,CAAC,cAAc,KAAK,SAAS;YAC/C,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IAChD,CAAC;IAEM,eAAe,CAAC,MAAc;QACnC,IAAI,IAAI,CAAC,WAAW,CAAC,eAAe,KAAK,SAAS;YAChD,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IACjD,CAAC;IAEM,aAAa,CAClB,MAAc,EACd,KAA4C;QAE5C,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAChE,MAAM,cAAc,GAAG,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC;QAE/C,IACE,KAAK,CAAC,MAAM,KAAK,CAAC;YAClB,IAAI,CAAC,WAAW,CAAC,iBAAiB,KAAK,SAAS,EAChD,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;YAE/C,mFAAmF;YACnF,CAAC,cAAc,IAAI,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACzE,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACtD,CAAC;QAED,gEAAgE;QAChE,IAAI,cAAc,IAAI,IAAI,CAAC,WAAW,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;YACxE,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAEM,eAAe,CAAC,MAAc;QACnC,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IACjD,CAAC;IAEM,eAAe,CAAC,MAAc;QACnC,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IACjD,CAAC;IAEM,qBAAqB,CAAC,MAAc;QACzC,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAChE,MAAM,cAAc,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC;QAEtD,iEAAiE;QACjE,IACE,cAAc;YACd,IAAI,CAAC,WAAW,CAAC,qBAAqB,KAAK,SAAS,EACpD,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;IAEM,aAAa,CAAC,KAA0B;QAC7C,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;IAEM,WAAW,CAAC,KAA0B;QAC3C,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAClD,CAAC;IAEO,uBAAuB,CAC7B,SAA+C,EAC/C,WAAgC;QAKhC,MAAM,eAAe,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;QAC3D,IAAI,gBAAgB,CAAC,SAAS,CAAC,EAAE,CAAC;YAChC,OAAO,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,IAAI,CAChE,GAAG,CAAC,CAAC,iBAAiB,EAAE,KAAK,EAAE,EAAE;gBAC/B,OAAO;oBACL,iBAAiB;oBACjB,mBAAmB,EAAE,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE;iBACxD,CAAC;YACJ,CAAC,CAAC,CACH,CAAC;QACJ,CAAC;QAED,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QACvD,OAAO,EAAE,CAAC;YACR,iBAAiB,EAAE,aAAa;YAChC,mBAAmB,EAAE,eAAe;SACrC,CAAC,CAAC;IACL,CAAC;IAEO,mBAAmB,CACzB,OAAe,EACf,OAAe;QAEf,MAAM,CAAC,UAAU,EAAE,WAAW,CAAC,GAC7B,mBAAmB,CAAC,wBAAwB,CAC1C,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAC3C,CAAC;QAEJ,MAAM,mBAAmB,GAAG,IAAI,CAC9B,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACvB,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ;gBAC9B,CAAC,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAC3D,CAAC,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,CAAC;YACrD,OAAO,UAAU;gBACf,CAAC,CAAC,gBAAgB,CACd,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CACvD;gBACH,CAAC,CAAC,KAAK,CAAC;QACZ,CAAC,CAAC,CACH,CAAC,IAAI;QACJ,qEAAqE;QACrE,qEAAqE;QACrE,gGAAgG;QAChG,6EAA6E;QAC7E,QAAQ,EAAE,EACV,oBAAoB,EAAE,CACvB,CAAC;QAEF,OAAO,MAAM,CACX,EAAE,CACA,UAAU;aACP,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC;aAC3C,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAC5B,EACD,mBAAmB,CAAC,IAAI,CACtB,GAAG,CAAC,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE,CACtB,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CACxD,CACF,CACF,CAAC,IAAI,CACJ,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;QAC3C,oFAAoF;QACpF,WAAW,CAAC,aAAa,CAAC,CAC3B,CAAC;IACJ,CAAC;IAEO,CAAC,mBAAmB,CAC1B,OAAe,EACf,OAAe;QAEf,IAAI,cAAc,GAAG,KAAK,CAAC;QAC3B,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC;YAC3C,IAAI,cAAc,EAAE,CAAC;gBACnB,MAAM,IAAI,CAAC;YACb,CAAC;YAED,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC1B,IAAI,OAAO,KAAK,OAAO,IAAI,IAAI,CAAC,EAAE,KAAK,OAAO,EAAE,CAAC;oBAC/C,MAAM,IAAI,CAAC;oBACX,OAAO;gBACT,CAAC;gBAED,IAAI,IAAI,CAAC,EAAE,KAAK,OAAO,IAAI,IAAI,CAAC,EAAE,KAAK,OAAO,EAAE,CAAC;oBAC/C,IAAI,cAAc,EAAE,CAAC;wBACnB,OAAO;oBACT,CAAC;oBAED,cAAc,GAAG,IAAI,CAAC;oBACtB,MAAM,IAAI,CAAC;gBACb,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAEO,gBAAgB,CAAC,OAAiB;QACxC,MAAM,KAAK,GAAmB,EAAE,CAAC;QACjC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAChE,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBACpD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxB,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,MAAM,CAAC,wBAAwB,CACrC,KAAyD;QAEzD,MAAM,eAAe,GAAoB,EAAE,CAAC;QAC5C,MAAM,WAAW,GAA+B,EAAE,CAAC;QACnD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC1B,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACN,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACzB,CAAC;QACH,CAAC;QAED,OAAO,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC;IACxC,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Tree\n */\n\nimport type { Observable } from \"rxjs\";\nimport {\n  asapScheduler,\n  concat,\n  concatAll,\n  concatMap,\n  defer,\n  distinctUntilChanged,\n  EMPTY,\n  filter,\n  finalize,\n  from,\n  map,\n  merge,\n  mergeAll,\n  of,\n  shareReplay,\n  subscribeOn,\n  toArray,\n} from \"rxjs\";\nimport type { SelectionMode } from \"../../common/selection/SelectionModes.js\";\nimport type { TreeNodeItem } from \"../TreeDataProvider.js\";\nimport type {\n  IndividualSelection,\n  RangeSelection,\n} from \"./internal/TreeSelectionManager.js\";\nimport {\n  isRangeSelection,\n  TreeSelectionManager,\n} from \"./internal/TreeSelectionManager.js\";\nimport type { TreeActions } from \"./TreeActions.js\";\nimport type { TreeEvents } from \"./TreeEvents.js\";\nimport type {\n  TreeModelNode,\n  TreeModelNodePlaceholder,\n  VisibleTreeNodes,\n} from \"./TreeModel.js\";\nimport { isTreeModelNode } from \"./TreeModel.js\";\nimport type { ITreeNodeLoader } from \"./TreeNodeLoader.js\";\nimport { toRxjsObservable } from \"./Observable.js\";\nimport type { CheckBoxState } from \"../../common/CheckBoxState.js\";\n\n/**\n * Default event dispatcher that emits tree events according performed actions.\n * It converts low level tree events into TreeEvents.\n * @internal\n */\nexport class TreeEventDispatcher implements TreeActions {\n  private _treeEvents: TreeEvents;\n  private _nodeLoader: ITreeNodeLoader;\n  private _getVisibleNodes: () => VisibleTreeNodes;\n\n  private _selectionManager: TreeSelectionManager;\n\n  private _activeSelections = new Set<\n    Observable<{\n      selectedNodeItems: TreeNodeItem[];\n      deselectedNodeItems?: TreeNodeItem[];\n    }>\n  >();\n\n  constructor(\n    treeEvents: TreeEvents,\n    nodeLoader: ITreeNodeLoader,\n    selectionMode: SelectionMode,\n    getVisibleNodes: () => VisibleTreeNodes\n  ) {\n    this._treeEvents = treeEvents;\n    this._nodeLoader = nodeLoader;\n    this._getVisibleNodes = getVisibleNodes;\n\n    this._selectionManager = new TreeSelectionManager(\n      selectionMode,\n      this._getVisibleNodes\n    );\n\n    this._selectionManager.onDragSelection.addListener(\n      ({ selectionChanges }) => {\n        const modifications = selectionChanges.pipe(\n          map(({ selectedNodes, deselectedNodes }) =>\n            this.collectSelectionChanges(selectedNodes, []).pipe(\n              concatMap(({ selectedNodeItems }) => from(selectedNodeItems)),\n              toArray(),\n              map((collectedIds) => ({\n                selectedNodeItems: collectedIds,\n                deselectedNodeItems: this.collectNodeItems(deselectedNodes),\n              }))\n            )\n          ),\n          concatAll(),\n          shareReplay({\n            refCount: true,\n          })\n        );\n\n        if (this._treeEvents.onSelectionModified !== undefined)\n          this._treeEvents.onSelectionModified({ modifications });\n      }\n    );\n\n    this._selectionManager.onSelectionChanged.addListener(\n      ({ selectedNodes, deselectedNodes }) => {\n        const modifications = merge(\n          defer(() => {\n            this._activeSelections.add(modifications);\n            return EMPTY;\n          }),\n          this.collectSelectionChanges(selectedNodes, deselectedNodes)\n        ).pipe(\n          finalize(() => {\n            this._activeSelections.delete(modifications);\n          }),\n          shareReplay({\n            refCount: true,\n          })\n        );\n\n        if (this._treeEvents.onSelectionModified !== undefined)\n          this._treeEvents.onSelectionModified({ modifications });\n      }\n    );\n\n    this._selectionManager.onSelectionReplaced.addListener(\n      ({ selectedNodeIds }) => {\n        const replacements = merge(\n          defer(() => {\n            this._activeSelections.add(replacements);\n            return EMPTY;\n          }),\n          this.collectSelectionChanges(selectedNodeIds, [])\n        ).pipe(\n          finalize(() => {\n            this._activeSelections.delete(replacements);\n          }),\n          shareReplay({\n            refCount: true,\n          })\n        );\n\n        if (this._treeEvents.onSelectionReplaced !== undefined)\n          this._treeEvents.onSelectionReplaced({ replacements });\n      }\n    );\n  }\n\n  public onNodeCheckboxClicked(nodeId: string, newState: CheckBoxState) {\n    const visibleNodes = this._getVisibleNodes();\n    const clickedNode = visibleNodes.getModel().getNode(nodeId);\n    if (clickedNode === undefined) return;\n\n    const immediateStateChanges = [{ nodeItem: clickedNode.item, newState }];\n    if (clickedNode.isSelected) {\n      for (const node of visibleNodes) {\n        if (\n          isTreeModelNode(node) &&\n          node.id !== clickedNode.id &&\n          node.isSelected &&\n          node.checkbox.state !== newState\n        ) {\n          immediateStateChanges.push({ nodeItem: node.item, newState });\n        }\n      }\n    }\n\n    const stateChanges = concat(\n      of(immediateStateChanges),\n      from(this._activeSelections).pipe(\n        mergeAll(),\n        map(({ selectedNodeItems }) =>\n          selectedNodeItems.map((item) => ({ nodeItem: item, newState }))\n        )\n      )\n    ).pipe(\n      shareReplay({\n        refCount: true,\n      })\n    );\n\n    if (this._treeEvents.onCheckboxStateChanged !== undefined)\n      this._treeEvents.onCheckboxStateChanged({ stateChanges });\n  }\n\n  public onNodeExpanded(nodeId: string) {\n    if (this._treeEvents.onNodeExpanded !== undefined)\n      this._treeEvents.onNodeExpanded({ nodeId });\n  }\n\n  public onNodeCollapsed(nodeId: string) {\n    if (this._treeEvents.onNodeCollapsed !== undefined)\n      this._treeEvents.onNodeCollapsed({ nodeId });\n  }\n\n  public onNodeClicked(\n    nodeId: string,\n    event: React.MouseEvent<Element, MouseEvent>\n  ) {\n    const node = this._getVisibleNodes().getModel().getNode(nodeId);\n    const isNodeSelected = node && node.isSelected;\n\n    if (\n      event.detail === 2 &&\n      this._treeEvents.onNodeDoubleClick !== undefined\n    ) {\n      this._treeEvents.onNodeDoubleClick({ nodeId });\n\n      // trigger onNodeClicked as to not lose highlight of the node when double clicking.\n      !isNodeSelected && this._selectionManager.onNodeClicked(nodeId, event);\n    } else {\n      this._selectionManager.onNodeClicked(nodeId, event);\n    }\n\n    // if clicked node was already selected fire delayed click event\n    if (isNodeSelected && this._treeEvents.onDelayedNodeClick !== undefined) {\n      this._treeEvents.onDelayedNodeClick({ nodeId });\n    }\n  }\n\n  public onNodeMouseDown(nodeId: string) {\n    this._selectionManager.onNodeMouseDown(nodeId);\n  }\n\n  public onNodeMouseMove(nodeId: string) {\n    this._selectionManager.onNodeMouseMove(nodeId);\n  }\n\n  public onNodeEditorActivated(nodeId: string) {\n    const node = this._getVisibleNodes().getModel().getNode(nodeId);\n    const isNodeSelected = node ? node.isSelected : false;\n\n    // if node was already selected, fire onNodeEditorActivated event\n    if (\n      isNodeSelected &&\n      this._treeEvents.onNodeEditorActivated !== undefined\n    ) {\n      this._treeEvents.onNodeEditorActivated({ nodeId });\n    }\n  }\n\n  public onTreeKeyDown(event: React.KeyboardEvent): void {\n    this._selectionManager.onTreeKeyDown(event, this);\n  }\n\n  public onTreeKeyUp(event: React.KeyboardEvent): void {\n    this._selectionManager.onTreeKeyUp(event, this);\n  }\n\n  private collectSelectionChanges(\n    selection: IndividualSelection | RangeSelection,\n    deselection: IndividualSelection\n  ): Observable<{\n    selectedNodeItems: TreeNodeItem[];\n    deselectedNodeItems: TreeNodeItem[];\n  }> {\n    const deselectedItems = this.collectNodeItems(deselection);\n    if (isRangeSelection(selection)) {\n      return this.collectNodesBetween(selection.from, selection.to).pipe(\n        map((selectedNodeItems, index) => {\n          return {\n            selectedNodeItems,\n            deselectedNodeItems: index === 0 ? deselectedItems : [],\n          };\n        })\n      );\n    }\n\n    const selectedItems = this.collectNodeItems(selection);\n    return of({\n      selectedNodeItems: selectedItems,\n      deselectedNodeItems: deselectedItems,\n    });\n  }\n\n  private collectNodesBetween(\n    nodeId1: string,\n    nodeId2: string\n  ): Observable<TreeNodeItem[]> {\n    const [readyNodes, nodesToLoad] =\n      TreeEventDispatcher.groupNodesByLoadingState(\n        this.iterateNodesBetween(nodeId1, nodeId2)\n      );\n\n    const loadedSelectedNodes = from(\n      nodesToLoad.map((node) => {\n        const parentNode = node.parentId\n          ? this._getVisibleNodes().getModel().getNode(node.parentId)\n          : this._getVisibleNodes().getModel().getRootNode();\n        return parentNode\n          ? toRxjsObservable(\n              this._nodeLoader.loadNode(parentNode, node.childIndex)\n            )\n          : EMPTY;\n      })\n    ).pipe(\n      // We have requested multiple nodes that may belong to the same page.\n      // When the page loads we only want to process the loaded nodes once.\n      // Making assumption that loaded nodes from the same page will be emitted without interruptions.\n      // Maybe we could simplify this to `this._nodeLoader.loadNodes(nodesToLoad)`?\n      mergeAll(),\n      distinctUntilChanged()\n    );\n\n    return concat(\n      of(\n        readyNodes\n          .filter((node) => !node.isSelectionDisabled)\n          .map((node) => node.item)\n      ),\n      loadedSelectedNodes.pipe(\n        map(({ loadedNodes }) =>\n          loadedNodes.filter((item) => !item.isSelectionDisabled)\n        )\n      )\n    ).pipe(\n      filter((nodeItems) => nodeItems.length > 0),\n      // Give enough time for multiple subscribers to subscribe before any emissions begin\n      subscribeOn(asapScheduler)\n    );\n  }\n\n  private *iterateNodesBetween(\n    nodeId1: string,\n    nodeId2: string\n  ): Iterable<TreeModelNode | TreeModelNodePlaceholder> {\n    let firstNodeFound = false;\n    for (const node of this._getVisibleNodes()) {\n      if (firstNodeFound) {\n        yield node;\n      }\n\n      if (isTreeModelNode(node)) {\n        if (nodeId1 === nodeId2 && node.id === nodeId1) {\n          yield node;\n          return;\n        }\n\n        if (node.id === nodeId1 || node.id === nodeId2) {\n          if (firstNodeFound) {\n            return;\n          }\n\n          firstNodeFound = true;\n          yield node;\n        }\n      }\n    }\n  }\n\n  private collectNodeItems(nodeIds: string[]): TreeNodeItem[] {\n    const items: TreeNodeItem[] = [];\n    for (const nodeId of nodeIds) {\n      const node = this._getVisibleNodes().getModel().getNode(nodeId);\n      if (node !== undefined && !node.isSelectionDisabled) {\n        items.push(node.item);\n      }\n    }\n    return items;\n  }\n\n  private static groupNodesByLoadingState(\n    nodes: Iterable<TreeModelNode | TreeModelNodePlaceholder>\n  ): [TreeModelNode[], TreeModelNodePlaceholder[]] {\n    const loadedNodeItems: TreeModelNode[] = [];\n    const nodesToLoad: TreeModelNodePlaceholder[] = [];\n    for (const node of nodes) {\n      if (isTreeModelNode(node)) {\n        loadedNodeItems.push(node);\n      } else {\n        nodesToLoad.push(node);\n      }\n    }\n\n    return [loadedNodeItems, nodesToLoad];\n  }\n}\n"]}

package/lib/components-react/tree/controlled/TreeEventHandler.d.ts

@@ -0,0 +1,64 @@
+/** @packageDocumentation
+ * @module Tree
+ */
+import type { IDisposable } from "@itwin/core-bentley";
+import type { Subscription } from "./Observable.js";
+import type { TreeCheckboxStateChangeEventArgs, TreeEvents, TreeNodeEventArgs, TreeSelectionModificationEventArgs, TreeSelectionReplacementEventArgs } from "./TreeEvents.js";
+import type { TreeModelNode } from "./TreeModel.js";
+import type { TreeModelSource } from "./TreeModelSource.js";
+import type { ITreeNodeLoader } from "./TreeNodeLoader.js";
+/**
+ * Params used for tree node editing.
+ * @public
+ */
+export interface TreeEditingParams {
+    /** Callback that is called when node is updated. */
+    onNodeUpdated: (node: TreeModelNode, newValue: string) => void;
+}
+/**
+ * Data structure that describes tree event handler params.
+ * @public
+ */
+export interface TreeEventHandlerParams {
+    /** Model source used to modify tree model while handling events. */
+    modelSource: TreeModelSource;
+    /** Node loader used to load children when node is expanded. */
+    nodeLoader: ITreeNodeLoader;
+    /** Specifies whether children should be disposed when parent node is collapsed or not. */
+    collapsedChildrenDisposalEnabled?: boolean;
+    /** Parameters used for node editing. */
+    editingParams?: TreeEditingParams;
+}
+/**
+ * Default tree event handler.
+ * @public
+ */
+export declare class TreeEventHandler implements TreeEvents, IDisposable {
+    private _modelMutator;
+    private _editingParams?;
+    private _disposed;
+    private _selectionReplaced;
+    constructor(params: TreeEventHandlerParams);
+    /** Disposes tree event handler. */
+    dispose(): void;
+    get modelSource(): TreeModelSource;
+    /** Expands node and starts loading children. */
+    onNodeExpanded({ nodeId }: TreeNodeEventArgs): void;
+    /** Collapses node */
+    onNodeCollapsed({ nodeId }: TreeNodeEventArgs): void;
+    /** Selects and deselects nodes until event is handled, handler is disposed or selection replaced event occurs. */
+    onSelectionModified({ modifications, }: TreeSelectionModificationEventArgs): Subscription | undefined;
+    /** Replaces currently selected nodes until event is handled, handler is disposed or another selection replaced event occurs. */
+    onSelectionReplaced({ replacements, }: TreeSelectionReplacementEventArgs): Subscription | undefined;
+    /** Changes nodes checkbox states. */
+    onCheckboxStateChanged({ stateChanges, }: TreeCheckboxStateChangeEventArgs): Subscription | undefined;
+    /** Activates node editing if editing parameters are supplied and node is editable. */
+    onDelayedNodeClick({ nodeId }: TreeNodeEventArgs): void;
+    /** This method is declared here to be overridden by classes that extend TreeEventHandler */
+    onNodeDoubleClick(_: TreeNodeEventArgs): void;
+    /** Activates node editing if editing parameters are supplied and node is editable. */
+    onNodeEditorActivated({ nodeId }: TreeNodeEventArgs): void;
+    /** Activates node editing if editing parameters are supplied and node is editable. */
+    private activateEditor;
+}
+//# sourceMappingURL=TreeEventHandler.d.ts.map

package/lib/components-react/tree/controlled/TreeEventHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TreeEventHandler.d.ts","sourceRoot":"","sources":["../../../../src/components-react/tree/controlled/TreeEventHandler.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAEvD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAEpD,OAAO,KAAK,EACV,gCAAgC,EAChC,UAAU,EACV,iBAAiB,EACjB,kCAAkC,EAClC,iCAAiC,EAClC,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAE3D;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,oDAAoD;IACpD,aAAa,EAAE,CAAC,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;CAChE;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,oEAAoE;IACpE,WAAW,EAAE,eAAe,CAAC;IAC7B,+DAA+D;IAC/D,UAAU,EAAE,eAAe,CAAC;IAC5B,0FAA0F;IAC1F,gCAAgC,CAAC,EAAE,OAAO,CAAC;IAC3C,wCAAwC;IACxC,aAAa,CAAC,EAAE,iBAAiB,CAAC;CACnC;AAED;;;GAGG;AACH,qBAAa,gBAAiB,YAAW,UAAU,EAAE,WAAW;IAC9D,OAAO,CAAC,aAAa,CAAmB;IACxC,OAAO,CAAC,cAAc,CAAC,CAAoB;IAE3C,OAAO,CAAC,SAAS,CAAuB;IACxC,OAAO,CAAC,kBAAkB,CAAuB;gBAErC,MAAM,EAAE,sBAAsB;IAS1C,mCAAmC;IAC5B,OAAO;IAId,IAAW,WAAW,oBAErB;IAED,gDAAgD;IACzC,cAAc,CAAC,EAAE,MAAM,EAAE,EAAE,iBAAiB;IAMnD,qBAAqB;IACd,eAAe,CAAC,EAAE,MAAM,EAAE,EAAE,iBAAiB;IAIpD,kHAAkH;IAC3G,mBAAmB,CAAC,EACzB,aAAa,GACd,EAAE,kCAAkC,GAAG,YAAY,GAAG,SAAS;IAahE,gIAAgI;IACzH,mBAAmB,CAAC,EACzB,YAAY,GACb,EAAE,iCAAiC,GAAG,YAAY,GAAG,SAAS;IAkB/D,qCAAqC;IAC9B,sBAAsB,CAAC,EAC5B,YAAY,GACb,EAAE,gCAAgC,GAAG,YAAY,GAAG,SAAS;IAM9D,sFAAsF;IAC/E,kBAAkB,CAAC,EAAE,MAAM,EAAE,EAAE,iBAAiB;IAIvD,4FAA4F;IACrF,iBAAiB,CAAC,CAAC,EAAE,iBAAiB;IAE7C,sFAAsF;IAC/E,qBAAqB,CAAC,EAAE,MAAM,EAAE,EAAE,iBAAiB;IAI1D,sFAAsF;IACtF,OAAO,CAAC,cAAc;CAQvB"}

package/lib/components-react/tree/controlled/TreeEventHandler.js

@@ -0,0 +1,86 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Tree
+ */
+import { Subject, takeUntil } from "rxjs";
+import { TreeModelMutator } from "./internal/TreeModelMutator.js";
+import { toRxjsObservable } from "./Observable.js";
+/**
+ * Default tree event handler.
+ * @public
+ */
+export class TreeEventHandler {
+    constructor(params) {
+        this._disposed = new Subject();
+        this._selectionReplaced = new Subject();
+        this._modelMutator = new TreeModelMutator(params.modelSource, params.nodeLoader, !!params.collapsedChildrenDisposalEnabled);
+        this._editingParams = params.editingParams;
+    }
+    /** Disposes tree event handler. */
+    dispose() {
+        this._disposed.next();
+    }
+    get modelSource() {
+        return this._modelMutator.modelSource;
+    }
+    /** Expands node and starts loading children. */
+    onNodeExpanded({ nodeId }) {
+        toRxjsObservable(this._modelMutator.expandNode(nodeId))
+            .pipe(takeUntil(this._disposed))
+            .subscribe();
+    }
+    /** Collapses node */
+    onNodeCollapsed({ nodeId }) {
+        this._modelMutator.collapseNode(nodeId);
+    }
+    /** Selects and deselects nodes until event is handled, handler is disposed or selection replaced event occurs. */
+    onSelectionModified({ modifications, }) {
+        return toRxjsObservable(modifications)
+            .pipe(takeUntil(this._disposed), takeUntil(this._selectionReplaced))
+            .subscribe({
+            next: ({ selectedNodeItems, deselectedNodeItems }) => {
+                this._modelMutator.modifySelection(selectedNodeItems, deselectedNodeItems);
+            },
+        });
+    }
+    /** Replaces currently selected nodes until event is handled, handler is disposed or another selection replaced event occurs. */
+    onSelectionReplaced({ replacements, }) {
+        this._selectionReplaced.next();
+        let firstEmission = true;
+        return toRxjsObservable(replacements)
+            .pipe(takeUntil(this._disposed), takeUntil(this._selectionReplaced))
+            .subscribe({
+            next: ({ selectedNodeItems }) => {
+                if (firstEmission) {
+                    firstEmission = false;
+                    this._modelMutator.replaceSelection(selectedNodeItems);
+                }
+                this._modelMutator.modifySelection(selectedNodeItems, []);
+            },
+        });
+    }
+    /** Changes nodes checkbox states. */
+    onCheckboxStateChanged({ stateChanges, }) {
+        return stateChanges.subscribe((changes) => this._modelMutator.setCheckboxStates(changes));
+    }
+    /** Activates node editing if editing parameters are supplied and node is editable. */
+    onDelayedNodeClick({ nodeId }) {
+        this.activateEditor(nodeId);
+    }
+    /** This method is declared here to be overridden by classes that extend TreeEventHandler */
+    onNodeDoubleClick(_) { }
+    /** Activates node editing if editing parameters are supplied and node is editable. */
+    onNodeEditorActivated({ nodeId }) {
+        this.activateEditor(nodeId);
+    }
+    /** Activates node editing if editing parameters are supplied and node is editable. */
+    activateEditor(nodeId) {
+        if (this._editingParams === undefined)
+            return;
+        this._modelMutator.activateEditing(nodeId, this._editingParams.onNodeUpdated);
+    }
+}
+//# sourceMappingURL=TreeEventHandler.js.map

package/lib/components-react/tree/controlled/TreeEventHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TreeEventHandler.js","sourceRoot":"","sources":["../../../../src/components-react/tree/controlled/TreeEventHandler.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAE1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAElE,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAoCnD;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IAO3B,YAAY,MAA8B;QAHlC,cAAS,GAAG,IAAI,OAAO,EAAQ,CAAC;QAChC,uBAAkB,GAAG,IAAI,OAAO,EAAQ,CAAC;QAG/C,IAAI,CAAC,aAAa,GAAG,IAAI,gBAAgB,CACvC,MAAM,CAAC,WAAW,EAClB,MAAM,CAAC,UAAU,EACjB,CAAC,CAAC,MAAM,CAAC,gCAAgC,CAC1C,CAAC;QACF,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC;IAC7C,CAAC;IAED,mCAAmC;IAC5B,OAAO;QACZ,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IACxB,CAAC;IAED,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;IACxC,CAAC;IAED,gDAAgD;IACzC,cAAc,CAAC,EAAE,MAAM,EAAqB;QACjD,gBAAgB,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;aACpD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aAC/B,SAAS,EAAE,CAAC;IACjB,CAAC;IAED,qBAAqB;IACd,eAAe,CAAC,EAAE,MAAM,EAAqB;QAClD,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;IAED,kHAAkH;IAC3G,mBAAmB,CAAC,EACzB,aAAa,GACsB;QACnC,OAAO,gBAAgB,CAAC,aAAa,CAAC;aACnC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;aACnE,SAAS,CAAC;YACT,IAAI,EAAE,CAAC,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,EAAE,EAAE;gBACnD,IAAI,CAAC,aAAa,CAAC,eAAe,CAChC,iBAAiB,EACjB,mBAAmB,CACpB,CAAC;YACJ,CAAC;SACF,CAAC,CAAC;IACP,CAAC;IAED,gIAAgI;IACzH,mBAAmB,CAAC,EACzB,YAAY,GACsB;QAClC,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC;QAE/B,IAAI,aAAa,GAAG,IAAI,CAAC;QACzB,OAAO,gBAAgB,CAAC,YAAY,CAAC;aAClC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;aACnE,SAAS,CAAC;YACT,IAAI,EAAE,CAAC,EAAE,iBAAiB,EAAE,EAAE,EAAE;gBAC9B,IAAI,aAAa,EAAE,CAAC;oBAClB,aAAa,GAAG,KAAK,CAAC;oBACtB,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;gBACzD,CAAC;gBAED,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;YAC5D,CAAC;SACF,CAAC,CAAC;IACP,CAAC;IAED,qCAAqC;IAC9B,sBAAsB,CAAC,EAC5B,YAAY,GACqB;QACjC,OAAO,YAAY,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE,CACxC,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAC9C,CAAC;IACJ,CAAC;IAED,sFAAsF;IAC/E,kBAAkB,CAAC,EAAE,MAAM,EAAqB;QACrD,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC;IAED,4FAA4F;IACrF,iBAAiB,CAAC,CAAoB,IAAG,CAAC;IAEjD,sFAAsF;IAC/E,qBAAqB,CAAC,EAAE,MAAM,EAAqB;QACxD,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC;IAED,sFAAsF;IAC9E,cAAc,CAAC,MAAc;QACnC,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS;YAAE,OAAO;QAE9C,IAAI,CAAC,aAAa,CAAC,eAAe,CAChC,MAAM,EACN,IAAI,CAAC,cAAc,CAAC,aAAa,CAClC,CAAC;IACJ,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Tree\n */\n\nimport { Subject, takeUntil } from \"rxjs\";\nimport type { IDisposable } from \"@itwin/core-bentley\";\nimport { TreeModelMutator } from \"./internal/TreeModelMutator.js\";\nimport type { Subscription } from \"./Observable.js\";\nimport { toRxjsObservable } from \"./Observable.js\";\nimport type {\n  TreeCheckboxStateChangeEventArgs,\n  TreeEvents,\n  TreeNodeEventArgs,\n  TreeSelectionModificationEventArgs,\n  TreeSelectionReplacementEventArgs,\n} from \"./TreeEvents.js\";\nimport type { TreeModelNode } from \"./TreeModel.js\";\nimport type { TreeModelSource } from \"./TreeModelSource.js\";\nimport type { ITreeNodeLoader } from \"./TreeNodeLoader.js\";\n\n/**\n * Params used for tree node editing.\n * @public\n */\nexport interface TreeEditingParams {\n  /** Callback that is called when node is updated. */\n  onNodeUpdated: (node: TreeModelNode, newValue: string) => void;\n}\n\n/**\n * Data structure that describes tree event handler params.\n * @public\n */\nexport interface TreeEventHandlerParams {\n  /** Model source used to modify tree model while handling events. */\n  modelSource: TreeModelSource;\n  /** Node loader used to load children when node is expanded. */\n  nodeLoader: ITreeNodeLoader;\n  /** Specifies whether children should be disposed when parent node is collapsed or not. */\n  collapsedChildrenDisposalEnabled?: boolean;\n  /** Parameters used for node editing. */\n  editingParams?: TreeEditingParams;\n}\n\n/**\n * Default tree event handler.\n * @public\n */\nexport class TreeEventHandler implements TreeEvents, IDisposable {\n  private _modelMutator: TreeModelMutator;\n  private _editingParams?: TreeEditingParams;\n\n  private _disposed = new Subject<void>();\n  private _selectionReplaced = new Subject<void>();\n\n  constructor(params: TreeEventHandlerParams) {\n    this._modelMutator = new TreeModelMutator(\n      params.modelSource,\n      params.nodeLoader,\n      !!params.collapsedChildrenDisposalEnabled\n    );\n    this._editingParams = params.editingParams;\n  }\n\n  /** Disposes tree event handler. */\n  public dispose() {\n    this._disposed.next();\n  }\n\n  public get modelSource() {\n    return this._modelMutator.modelSource;\n  }\n\n  /** Expands node and starts loading children. */\n  public onNodeExpanded({ nodeId }: TreeNodeEventArgs) {\n    toRxjsObservable(this._modelMutator.expandNode(nodeId))\n      .pipe(takeUntil(this._disposed))\n      .subscribe();\n  }\n\n  /** Collapses node */\n  public onNodeCollapsed({ nodeId }: TreeNodeEventArgs) {\n    this._modelMutator.collapseNode(nodeId);\n  }\n\n  /** Selects and deselects nodes until event is handled, handler is disposed or selection replaced event occurs. */\n  public onSelectionModified({\n    modifications,\n  }: TreeSelectionModificationEventArgs): Subscription | undefined {\n    return toRxjsObservable(modifications)\n      .pipe(takeUntil(this._disposed), takeUntil(this._selectionReplaced))\n      .subscribe({\n        next: ({ selectedNodeItems, deselectedNodeItems }) => {\n          this._modelMutator.modifySelection(\n            selectedNodeItems,\n            deselectedNodeItems\n          );\n        },\n      });\n  }\n\n  /** Replaces currently selected nodes until event is handled, handler is disposed or another selection replaced event occurs. */\n  public onSelectionReplaced({\n    replacements,\n  }: TreeSelectionReplacementEventArgs): Subscription | undefined {\n    this._selectionReplaced.next();\n\n    let firstEmission = true;\n    return toRxjsObservable(replacements)\n      .pipe(takeUntil(this._disposed), takeUntil(this._selectionReplaced))\n      .subscribe({\n        next: ({ selectedNodeItems }) => {\n          if (firstEmission) {\n            firstEmission = false;\n            this._modelMutator.replaceSelection(selectedNodeItems);\n          }\n\n          this._modelMutator.modifySelection(selectedNodeItems, []);\n        },\n      });\n  }\n\n  /** Changes nodes checkbox states. */\n  public onCheckboxStateChanged({\n    stateChanges,\n  }: TreeCheckboxStateChangeEventArgs): Subscription | undefined {\n    return stateChanges.subscribe((changes) =>\n      this._modelMutator.setCheckboxStates(changes)\n    );\n  }\n\n  /** Activates node editing if editing parameters are supplied and node is editable. */\n  public onDelayedNodeClick({ nodeId }: TreeNodeEventArgs) {\n    this.activateEditor(nodeId);\n  }\n\n  /** This method is declared here to be overridden by classes that extend TreeEventHandler */\n  public onNodeDoubleClick(_: TreeNodeEventArgs) {}\n\n  /** Activates node editing if editing parameters are supplied and node is editable. */\n  public onNodeEditorActivated({ nodeId }: TreeNodeEventArgs) {\n    this.activateEditor(nodeId);\n  }\n\n  /** Activates node editing if editing parameters are supplied and node is editable. */\n  private activateEditor(nodeId: string) {\n    if (this._editingParams === undefined) return;\n\n    this._modelMutator.activateEditing(\n      nodeId,\n      this._editingParams.onNodeUpdated\n    );\n  }\n}\n"]}

package/lib/components-react/tree/controlled/TreeEvents.d.ts

@@ -0,0 +1,111 @@
+/** @packageDocumentation
+ * @module Tree
+ */
+import type { CheckBoxState } from "../../common/CheckBoxState.js";
+import type { TreeNodeItem } from "../TreeDataProvider.js";
+import type { Observable, Subscription } from "./Observable.js";
+/**
+ * Tree events that can occur while interacting with tree.
+ *
+ * **Note:** Selection and checkbox state change events payload is an Observable.
+ * Observable is a stream of data over time (e.g. in case of selection replaced event
+ * it is a stream of selected node items arrays). To access data inside stream `subscribe()` method
+ * should be called. This method accepts any subset of 'next', 'error' and 'complete' callbacks.
+ * Once subscribe is called observable will start emitting data and calls 'next' callback each time new
+ * data is emitted. If some selected nodes are not loaded yet they will be loaded and observable will
+ * emit loaded node items. When all selected node items are emitted observable completes and calls
+ * 'complete' callback if supplied.
+ *
+ * @public
+ */
+export interface TreeEvents {
+    /** Called when tree node is expanded. */
+    onNodeExpanded?(event: TreeNodeEventArgs): void;
+    /** Called when tree node is collapsed. */
+    onNodeCollapsed?(event: TreeNodeEventArgs): void;
+    /** Called when selected tree node is clicked. */
+    onDelayedNodeClick?(event: TreeNodeEventArgs): void;
+    /** Called when a tree node is double-clicked */
+    onNodeDoubleClick?(event: TreeNodeEventArgs): void;
+    /** Called when selected tree node editor is activated. */
+    onNodeEditorActivated?(event: TreeNodeEventArgs): void;
+    /**
+     * Called when tree selection is modified.
+     * If Subscription is returned it can be used to stop event handling by calling `unsubscribe()`.
+     */
+    onSelectionModified?(event: TreeSelectionModificationEventArgs): Subscription | undefined;
+    /**
+     * Called when tree selection is replaced.
+     * If Subscription is returned it can be used to stop event handling by calling `unsubscribe()`.
+     */
+    onSelectionReplaced?(event: TreeSelectionReplacementEventArgs): Subscription | undefined;
+    /**
+     * Called when checkbox states for nodes are changed.
+     * If Subscription is returned it can be used to stop event handling by calling `unsubscribe()`.
+     */
+    onCheckboxStateChanged?(event: TreeCheckboxStateChangeEventArgs): Subscription | undefined;
+}
+/**
+ * Data structure that describes tree node event payload.
+ * @public
+ */
+export interface TreeNodeEventArgs {
+    /** Id of node that is affected by event. */
+    nodeId: string;
+}
+/**
+ * Data structure that describes tree selection modification event payload.
+ * @public
+ */
+export interface TreeSelectionModificationEventArgs {
+    /**
+     * An observable that emits tree selection changes.
+     * It starts emitting values when '.subscribe()' is called.
+     */
+    modifications: Observable<TreeSelectionChange>;
+}
+/**
+ * Data structure that describes tree selection change.
+ * @public
+ */
+export interface TreeSelectionChange {
+    /** Tree node items that where selected. */
+    selectedNodeItems: TreeNodeItem[];
+    /** Tree node items that where deselected. */
+    deselectedNodeItems: TreeNodeItem[];
+}
+/**
+ * Data structure that describes tree selection replacement event payload.
+ * @public
+ */
+export interface TreeSelectionReplacementEventArgs {
+    /**
+     * An observable that emits tree selection replacements containing selected tree node items.
+     * It starts emitting values when '.subscribe()' is called.
+     */
+    replacements: Observable<{
+        selectedNodeItems: TreeNodeItem[];
+    }>;
+}
+/**
+ * Data structure that describes tree checkbox state change event payload.
+ * @public
+ */
+export interface TreeCheckboxStateChangeEventArgs {
+    /**
+     * An observable that emits checkbox state changes.
+     * It starts emitting values when '.subscribe()' is called.
+     */
+    stateChanges: Observable<CheckboxStateChange[]>;
+}
+/**
+ * Data structure that describes checkbox state change.
+ * @public
+ */
+export interface CheckboxStateChange {
+    /** Tree node item that was affected by checkbox state change. */
+    nodeItem: TreeNodeItem;
+    /** New state of the checkbox. */
+    newState: CheckBoxState;
+}
+//# sourceMappingURL=TreeEvents.d.ts.map

package/lib/components-react/tree/controlled/TreeEvents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TreeEvents.d.ts","sourceRoot":"","sources":["../../../../src/components-react/tree/controlled/TreeEvents.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAEhE;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,UAAU;IACzB,yCAAyC;IACzC,cAAc,CAAC,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAChD,0CAA0C;IAC1C,eAAe,CAAC,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI,CAAC;IACjD,iDAAiD;IACjD,kBAAkB,CAAC,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI,CAAC;IACpD,gDAAgD;IAChD,iBAAiB,CAAC,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI,CAAC;IACnD,0DAA0D;IAC1D,qBAAqB,CAAC,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI,CAAC;IACvD;;;OAGG;IACH,mBAAmB,CAAC,CAClB,KAAK,EAAE,kCAAkC,GACxC,YAAY,GAAG,SAAS,CAAC;IAC5B;;;OAGG;IACH,mBAAmB,CAAC,CAClB,KAAK,EAAE,iCAAiC,GACvC,YAAY,GAAG,SAAS,CAAC;IAE5B;;;OAGG;IACH,sBAAsB,CAAC,CACrB,KAAK,EAAE,gCAAgC,GACtC,YAAY,GAAG,SAAS,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,4CAA4C;IAC5C,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,kCAAkC;IACjD;;;OAGG;IACH,aAAa,EAAE,UAAU,CAAC,mBAAmB,CAAC,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,2CAA2C;IAC3C,iBAAiB,EAAE,YAAY,EAAE,CAAC;IAClC,6CAA6C;IAC7C,mBAAmB,EAAE,YAAY,EAAE,CAAC;CACrC;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD;;;OAGG;IACH,YAAY,EAAE,UAAU,CAAC;QAAE,iBAAiB,EAAE,YAAY,EAAE,CAAA;KAAE,CAAC,CAAC;CACjE;AAED;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;;OAGG;IACH,YAAY,EAAE,UAAU,CAAC,mBAAmB,EAAE,CAAC,CAAC;CACjD;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,iEAAiE;IACjE,QAAQ,EAAE,YAAY,CAAC;IACvB,iCAAiC;IACjC,QAAQ,EAAE,aAAa,CAAC;CACzB"}

package/lib/components-react/tree/controlled/TreeEvents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TreeEvents.js","sourceRoot":"","sources":["../../../../src/components-react/tree/controlled/TreeEvents.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Tree\n */\n\nimport type { CheckBoxState } from \"../../common/CheckBoxState.js\";\nimport type { TreeNodeItem } from \"../TreeDataProvider.js\";\nimport type { Observable, Subscription } from \"./Observable.js\";\n\n/**\n * Tree events that can occur while interacting with tree.\n *\n * **Note:** Selection and checkbox state change events payload is an Observable.\n * Observable is a stream of data over time (e.g. in case of selection replaced event\n * it is a stream of selected node items arrays). To access data inside stream `subscribe()` method\n * should be called. This method accepts any subset of 'next', 'error' and 'complete' callbacks.\n * Once subscribe is called observable will start emitting data and calls 'next' callback each time new\n * data is emitted. If some selected nodes are not loaded yet they will be loaded and observable will\n * emit loaded node items. When all selected node items are emitted observable completes and calls\n * 'complete' callback if supplied.\n *\n * @public\n */\nexport interface TreeEvents {\n  /** Called when tree node is expanded. */\n  onNodeExpanded?(event: TreeNodeEventArgs): void;\n  /** Called when tree node is collapsed. */\n  onNodeCollapsed?(event: TreeNodeEventArgs): void;\n  /** Called when selected tree node is clicked. */\n  onDelayedNodeClick?(event: TreeNodeEventArgs): void;\n  /** Called when a tree node is double-clicked */\n  onNodeDoubleClick?(event: TreeNodeEventArgs): void;\n  /** Called when selected tree node editor is activated. */\n  onNodeEditorActivated?(event: TreeNodeEventArgs): void;\n  /**\n   * Called when tree selection is modified.\n   * If Subscription is returned it can be used to stop event handling by calling `unsubscribe()`.\n   */\n  onSelectionModified?(\n    event: TreeSelectionModificationEventArgs\n  ): Subscription | undefined;\n  /**\n   * Called when tree selection is replaced.\n   * If Subscription is returned it can be used to stop event handling by calling `unsubscribe()`.\n   */\n  onSelectionReplaced?(\n    event: TreeSelectionReplacementEventArgs\n  ): Subscription | undefined;\n\n  /**\n   * Called when checkbox states for nodes are changed.\n   * If Subscription is returned it can be used to stop event handling by calling `unsubscribe()`.\n   */\n  onCheckboxStateChanged?(\n    event: TreeCheckboxStateChangeEventArgs\n  ): Subscription | undefined;\n}\n\n/**\n * Data structure that describes tree node event payload.\n * @public\n */\nexport interface TreeNodeEventArgs {\n  /** Id of node that is affected by event. */\n  nodeId: string;\n}\n\n/**\n * Data structure that describes tree selection modification event payload.\n * @public\n */\nexport interface TreeSelectionModificationEventArgs {\n  /**\n   * An observable that emits tree selection changes.\n   * It starts emitting values when '.subscribe()' is called.\n   */\n  modifications: Observable<TreeSelectionChange>;\n}\n\n/**\n * Data structure that describes tree selection change.\n * @public\n */\nexport interface TreeSelectionChange {\n  /** Tree node items that where selected. */\n  selectedNodeItems: TreeNodeItem[];\n  /** Tree node items that where deselected. */\n  deselectedNodeItems: TreeNodeItem[];\n}\n\n/**\n * Data structure that describes tree selection replacement event payload.\n * @public\n */\nexport interface TreeSelectionReplacementEventArgs {\n  /**\n   * An observable that emits tree selection replacements containing selected tree node items.\n   * It starts emitting values when '.subscribe()' is called.\n   */\n  replacements: Observable<{ selectedNodeItems: TreeNodeItem[] }>;\n}\n\n/**\n * Data structure that describes tree checkbox state change event payload.\n * @public\n */\nexport interface TreeCheckboxStateChangeEventArgs {\n  /**\n   * An observable that emits checkbox state changes.\n   * It starts emitting values when '.subscribe()' is called.\n   */\n  stateChanges: Observable<CheckboxStateChange[]>;\n}\n\n/**\n * Data structure that describes checkbox state change.\n * @public\n */\nexport interface CheckboxStateChange {\n  /** Tree node item that was affected by checkbox state change. */\n  nodeItem: TreeNodeItem;\n  /** New state of the checkbox. */\n  newState: CheckBoxState;\n}\n"]}

package/lib/components-react/tree/controlled/TreeHooks.d.ts

@@ -0,0 +1,61 @@
+/** @packageDocumentation
+ * @module Tree
+ */
+import type { TreeDataProvider } from "../TreeDataProvider.js";
+import type { TreeEventHandlerParams } from "./TreeEventHandler.js";
+import { TreeEventHandler } from "./TreeEventHandler.js";
+import type { TreeModel } from "./TreeModel.js";
+import { TreeModelSource } from "./TreeModelSource.js";
+import { PagedTreeNodeLoader, TreeNodeLoader } from "./TreeNodeLoader.js";
+/**
+ * React hook that returns an immutable `TreeModel` whenever it changes in the given
+ * `TreeModelSource`.
+ *
+ * @public
+ */
+export declare function useTreeModel(modelSource: TreeModelSource): TreeModel;
+/**
+ * Custom hook which creates a nodes' loader using the supplied data provider and model source. The
+ * loader pulls nodes from the data provider and puts them into the model source.
+ *
+ * @public
+ */
+export declare function useTreeNodeLoader<TDataProvider extends TreeDataProvider>(dataProvider: TDataProvider, modelSource: TreeModelSource): TreeNodeLoader<TDataProvider>;
+/**
+ * Custom hook which creates a paging nodes' loader using the supplied data provider and model source. The loader pulls
+ * nodes from the data provider and puts them into the model source.
+ * @public
+ */
+export declare function usePagedTreeNodeLoader<TDataProvider extends TreeDataProvider>(dataProvider: TDataProvider, pageSize: number, modelSource: TreeModelSource): PagedTreeNodeLoader<TDataProvider>;
+/**
+ * Custom hook which creates a `TreeModelSource`.
+ *
+ * @note The model source has no direct dependency on the data provider, but we want a fresh model
+ * source whenever the data provider changes - that's the reason the hook takes a data provider.
+ *
+ * @public
+ */
+export declare function useTreeModelSource(dataProvider: TreeDataProvider): TreeModelSource;
+/**
+ * Custom hook which creates and takes care of disposing a TreeEventsHandler. The input is either a factory method
+ * for a custom `TreeEventHandler` implementation or parameters for the default implementation.
+ *
+ * @note Caller must ensure `factoryOrParams` changes only when a new handler needs to be created. `useCallback` or `useMemo` can
+ * be used for that purpose based on whether the input is a factory function or params object.
+ *
+ * @public
+ * @deprecated in 4.9.0. This hook does not work correctly in React 18 Strict mode. Use [[useControlledTreeEventsHandler]] instead.
+ */
+export declare function useTreeEventsHandler<TEventsHandler extends TreeEventHandler>(factoryOrParams: (() => TEventsHandler) | TreeEventHandlerParams): TreeEventHandler;
+/**
+ * Custom hook which creates and takes care of disposing a [[TreeEventHandler]]. The input is either a factory method
+ * for a custom [[TreeEventHandler]] implementation or parameters for the default implementation.
+ *
+ * @note Caller must ensure `factoryOrParams` changes only when a new handler needs to be created. `useCallback` or `useMemo` can
+ * be used for that purpose based on whether the input is a factory function or params object.
+ *
+ * @returns `undefined` on first render and a valid [[TreeEventHandler]] on all subsequent renders.
+ * @public
+ */
+export declare function useControlledTreeEventsHandler<TEventsHandler extends TreeEventHandler>(factoryOrParams: (() => TEventsHandler) | TreeEventHandlerParams): TreeEventHandler | undefined;
+//# sourceMappingURL=TreeHooks.d.ts.map

package/lib/components-react/tree/controlled/TreeHooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TreeHooks.d.ts","sourceRoot":"","sources":["../../../../src/components-react/tree/controlled/TreeHooks.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE1E;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,WAAW,EAAE,eAAe,GAAG,SAAS,CAUpE;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,SAAS,gBAAgB,EACtE,YAAY,EAAE,aAAa,EAC3B,WAAW,EAAE,eAAe,iCAM7B;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,aAAa,SAAS,gBAAgB,EAC3E,YAAY,EAAE,aAAa,EAC3B,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,eAAe,sCAM7B;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,gBAAgB,mBAGhE;AAED;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAAC,cAAc,SAAS,gBAAgB,EAC1E,eAAe,EAAE,CAAC,MAAM,cAAc,CAAC,GAAG,sBAAsB,oBAQjE;AAED;;;;;;;;;GASG;AACH,wBAAgB,8BAA8B,CAC5C,cAAc,SAAS,gBAAgB,EACvC,eAAe,EAAE,CAAC,MAAM,cAAc,CAAC,GAAG,sBAAsB,gCAOjE"}