@itwin/tree-widget-react 0.5.0 → 0.6.0

package/lib/cjs/components/trees/Common.d.ts

@@ -0,0 +1,21 @@
+/**
+ * An option of how class grouping should work in a component.
+ * @beta
+ */
+export declare enum ClassGroupingOption {
+    /** Class grouping is disabled */
+    No = 0,
+    /** Class grouping is enabled */
+    Yes = 1,
+    /** Class grouping is enabled and grouping node shows grouped items count */
+    YesWithCounts = 2
+}
+/**
+ * Data structure that describes info used to filter visibility tree.
+ * @alpha
+ */
+export interface VisibilityTreeFilterInfo {
+    filter: string;
+    activeMatchIndex?: number;
+}
+//# sourceMappingURL=Common.d.ts.map

package/lib/cjs/components/trees/Common.js

@@ -0,0 +1,21 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClassGroupingOption = void 0;
+/**
+ * An option of how class grouping should work in a component.
+ * @beta
+ */
+var ClassGroupingOption;
+(function (ClassGroupingOption) {
+    /** Class grouping is disabled */
+    ClassGroupingOption[ClassGroupingOption["No"] = 0] = "No";
+    /** Class grouping is enabled */
+    ClassGroupingOption[ClassGroupingOption["Yes"] = 1] = "Yes";
+    /** Class grouping is enabled and grouping node shows grouped items count */
+    ClassGroupingOption[ClassGroupingOption["YesWithCounts"] = 2] = "YesWithCounts";
+})(ClassGroupingOption = exports.ClassGroupingOption || (exports.ClassGroupingOption = {}));
+//# sourceMappingURL=Common.js.map

package/lib/cjs/components/trees/Common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Common.js","sourceRoot":"","sources":["../../../../src/components/trees/Common.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;;GAGG;AACH,IAAY,mBAOX;AAPD,WAAY,mBAAmB;IAC7B,iCAAiC;IACjC,yDAAE,CAAA;IACF,gCAAgC;IAChC,2DAAG,CAAA;IACH,4EAA4E;IAC5E,+EAAa,CAAA;AACf,CAAC,EAPW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAO9B","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\n/**\n * An option of how class grouping should work in a component.\n * @beta\n */\nexport enum ClassGroupingOption {\n  /** Class grouping is disabled */\n  No,\n  /** Class grouping is enabled */\n  Yes,\n  /** Class grouping is enabled and grouping node shows grouped items count */\n  YesWithCounts,\n}\n\n/**\n * Data structure that describes info used to filter visibility tree.\n * @alpha\n */\nexport interface VisibilityTreeFilterInfo {\n  filter: string;\n  activeMatchIndex?: number;\n}\n"]}

package/lib/cjs/components/trees/VisibilityTreeBase.scss

@@ -0,0 +1,53 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+@import "~@itwin/core-react/lib/cjs/core-react/style/themecolors";
+
+@mixin tree-widget-visibility-tree-base {
+  height: 100%;
+  width: 100%;
+  display: flex;
+  flex-direction: column;
+  position: relative;
+
+  .core-tree-node.with-checkbox {
+    >.contents {
+      padding-left: 31px;
+    }
+  }
+
+  .contents > .core-image-checkbox {
+    position: absolute;
+    top: unset;
+    left: 5px;
+    margin: -2px 0px 0px 5px;
+  }
+
+  .filteredTreeOverlay {
+    position: absolute;
+    top: 0;
+    left: 0;
+    width: 100%;
+    height: 100%;
+    z-index: 9999;
+    background-color: rgba(255, 255, 255, .8);
+  }
+
+  .components-tree-errormessage {
+    position: absolute;
+    top: 40%;
+    left: 50%;
+    width: 75%;
+    text-align: center;
+    transform: translate(-50%, -50%);
+    font-style: italic;
+    color: $buic-foreground-muted;
+
+    .errormessage-header {
+      display: block;
+      font-weight: bold;
+    }
+  }
+
+}

package/lib/cjs/components/trees/VisibilityTreeEventHandler.d.ts

@@ -0,0 +1,67 @@
+/** @packageDocumentation
+ * @module IModelComponents
+ */
+import { UnifiedSelectionTreeEventHandler } from "@itwin/presentation-components";
+import type { TreeCheckboxStateChangeEventArgs, TreeNodeItem, TreeSelectionModificationEventArgs, TreeSelectionReplacementEventArgs } from "@itwin/components-react";
+import type { BeEvent, IDisposable } from "@itwin/core-bentley";
+import type { NodeKey } from "@itwin/presentation-common";
+import type { UnifiedSelectionTreeEventHandlerParams } from "@itwin/presentation-components";
+/**
+ * Data structure that describes instance visibility status.
+ * @alpha
+ */
+export interface VisibilityStatus {
+    state: "visible" | "partial" | "hidden";
+    isDisabled?: boolean;
+    tooltip?: string;
+}
+/**
+ * Type definition of visibility change event listener.
+ * @alpha
+ */
+export declare type VisibilityChangeListener = (nodeIds?: string[], visibilityStatus?: Map<string, VisibilityStatus>) => void;
+/**
+ * Visibility handler used to change or get visibility of instances represented by the tree node.
+ * @alpha
+ */
+export interface IVisibilityHandler extends IDisposable {
+    getVisibilityStatus(node: TreeNodeItem, nodeKey: NodeKey): VisibilityStatus | Promise<VisibilityStatus>;
+    changeVisibility(node: TreeNodeItem, nodeKey: NodeKey, shouldDisplay: boolean): Promise<void>;
+    onVisibilityChange: BeEvent<VisibilityChangeListener>;
+}
+/**
+ * Type definition of predicate used to decide if node can be selected.
+ * @alpha
+ */
+export declare type VisibilityTreeSelectionPredicate = (key: NodeKey, node: TreeNodeItem) => boolean;
+/**
+ * Parameters for [[VisibilityTreeEventHandler]]
+ * @alpha
+ */
+export interface VisibilityTreeEventHandlerParams extends UnifiedSelectionTreeEventHandlerParams {
+    visibilityHandler: IVisibilityHandler | undefined;
+    selectionPredicate?: VisibilityTreeSelectionPredicate;
+}
+/**
+ * Base event handler for visibility tree.
+ * @alpha
+ */
+export declare class VisibilityTreeEventHandler extends UnifiedSelectionTreeEventHandler {
+    private _visibilityHandler;
+    private _selectionPredicate?;
+    private _listeners;
+    constructor(params: VisibilityTreeEventHandlerParams);
+    dispose(): void;
+    private filterSelectionItems;
+    onSelectionModified({ modifications }: TreeSelectionModificationEventArgs): import("@itwin/components-react").Subscription | undefined;
+    onSelectionReplaced({ replacements }: TreeSelectionReplacementEventArgs): import("@itwin/components-react").Subscription | undefined;
+    onCheckboxStateChanged(event: TreeCheckboxStateChangeEventArgs): undefined;
+    private changeVisibility;
+    private updateCheckboxes;
+    private updateModel;
+    private collectAffectedNodesCheckboxInfos;
+    private collectAllNodesCheckboxInfos;
+    private getNodeCheckBoxInfo;
+    private createCheckboxInfo;
+}
+//# sourceMappingURL=VisibilityTreeEventHandler.d.ts.map

package/lib/cjs/components/trees/VisibilityTreeEventHandler.js

@@ -0,0 +1,147 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module IModelComponents
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VisibilityTreeEventHandler = void 0;
+const empty_1 = require("rxjs/internal/observable/empty");
+const from_1 = require("rxjs/internal/observable/from");
+const map_1 = require("rxjs/internal/operators/map");
+const mergeMap_1 = require("rxjs/internal/operators/mergeMap");
+const components_react_1 = require("@itwin/components-react");
+const core_react_1 = require("@itwin/core-react");
+const presentation_components_1 = require("@itwin/presentation-components");
+/**
+ * Base event handler for visibility tree.
+ * @alpha
+ */
+class VisibilityTreeEventHandler extends presentation_components_1.UnifiedSelectionTreeEventHandler {
+    constructor(params) {
+        super(params);
+        this._listeners = new Array();
+        this._visibilityHandler = params.visibilityHandler;
+        this._selectionPredicate = params.selectionPredicate;
+        if (this._visibilityHandler) {
+            this._listeners.push(this._visibilityHandler.onVisibilityChange.addListener(async (nodeIds, visibilityStatus) => this.updateCheckboxes(nodeIds, visibilityStatus)));
+        }
+        this._listeners.push(this.modelSource.onModelChanged.addListener(async ([_, changes]) => this.updateCheckboxes([...changes.addedNodeIds, ...changes.modifiedNodeIds])));
+        this.updateCheckboxes(); // eslint-disable-line @typescript-eslint/no-floating-promises
+    }
+    dispose() {
+        super.dispose();
+        this._listeners.forEach((disposeFunc) => disposeFunc());
+    }
+    filterSelectionItems(items) {
+        // istanbul ignore if
+        if (!this._selectionPredicate)
+            return items;
+        return items.filter((item) => this._selectionPredicate(this.getNodeKey(item), item));
+    }
+    onSelectionModified({ modifications }) {
+        const filteredModification = components_react_1.toRxjsObservable(modifications).pipe(map_1.map(({ selectedNodeItems, deselectedNodeItems }) => {
+            return {
+                selectedNodeItems: this.filterSelectionItems(selectedNodeItems),
+                deselectedNodeItems: this.filterSelectionItems(deselectedNodeItems),
+            };
+        }));
+        return super.onSelectionModified({ modifications: filteredModification });
+    }
+    onSelectionReplaced({ replacements }) {
+        const filteredReplacements = components_react_1.toRxjsObservable(replacements).pipe(map_1.map(({ selectedNodeItems }) => {
+            return {
+                selectedNodeItems: this.filterSelectionItems(selectedNodeItems),
+            };
+        }));
+        return super.onSelectionReplaced({ replacements: filteredReplacements });
+    }
+    onCheckboxStateChanged(event) {
+        // istanbul ignore if
+        if (!this._visibilityHandler)
+            return undefined;
+        from_1.from(event.stateChanges)
+            .pipe(mergeMap_1.mergeMap((changes) => this.changeVisibility(changes)))
+            .subscribe();
+        return undefined;
+    }
+    changeVisibility(changes) {
+        return from_1.from(changes)
+            .pipe(mergeMap_1.mergeMap(({ nodeItem, newState }) => {
+            // istanbul ignore if
+            if (!this._visibilityHandler)
+                return empty_1.EMPTY;
+            return from_1.from(this._visibilityHandler.changeVisibility(nodeItem, this.getNodeKey(nodeItem), newState === core_react_1.CheckBoxState.On));
+        }));
+    }
+    async updateCheckboxes(affectedNodes, visibilityStatus) {
+        const changes = await (affectedNodes ? this.collectAffectedNodesCheckboxInfos(affectedNodes, visibilityStatus) : this.collectAllNodesCheckboxInfos(visibilityStatus));
+        this.updateModel(changes);
+    }
+    updateModel(changes) {
+        this.modelSource.modifyModel((model) => {
+            for (const [nodeId, checkboxInfo] of changes) {
+                const node = model.getNode(nodeId);
+                // istanbul ignore if
+                if (!node)
+                    continue;
+                node.checkbox.isDisabled = checkboxInfo.isDisabled;
+                node.checkbox.isVisible = checkboxInfo.isVisible;
+                node.checkbox.state = checkboxInfo.state;
+                node.checkbox.tooltip = checkboxInfo.tooltip;
+            }
+        });
+    }
+    async collectAffectedNodesCheckboxInfos(affectedNodes, visibilityStatus) {
+        const nodeStates = new Map();
+        if (affectedNodes.length === 0)
+            return nodeStates;
+        await Promise.all(affectedNodes.map(async (nodeId) => {
+            const node = this.modelSource.getModel().getNode(nodeId);
+            // istanbul ignore else
+            if (node)
+                nodeStates.set(nodeId, await this.getNodeCheckBoxInfo(node, visibilityStatus));
+        }));
+        return nodeStates;
+    }
+    async collectAllNodesCheckboxInfos(visibilityStatus) {
+        const nodeStates = new Map();
+        for (const node of this.modelSource.getModel().iterateTreeModelNodes()) {
+            nodeStates.set(node.id, await this.getNodeCheckBoxInfo(node, visibilityStatus));
+        }
+        return nodeStates;
+    }
+    async getNodeCheckBoxInfo(node, visibilityStatus) {
+        var _a;
+        if (!this._visibilityHandler)
+            return { ...node.checkbox, isVisible: false };
+        const result = (_a = visibilityStatus === null || visibilityStatus === void 0 ? void 0 : visibilityStatus.get(node.id)) !== null && _a !== void 0 ? _a : this._visibilityHandler.getVisibilityStatus(node.item, this.getNodeKey(node.item));
+        if (core_react_1.isPromiseLike(result))
+            return this.createCheckboxInfo(await result);
+        return this.createCheckboxInfo(result);
+    }
+    createCheckboxInfo(status) {
+        return {
+            state: visibilityStateToCheckboxState(status),
+            isDisabled: status.isDisabled || false,
+            isVisible: true,
+            tooltip: status.tooltip,
+        };
+    }
+}
+exports.VisibilityTreeEventHandler = VisibilityTreeEventHandler;
+const visibilityStateToCheckboxState = (status) => {
+    switch (status.state) {
+        case "visible":
+            return core_react_1.CheckBoxState.On;
+        // istanbul ignore next
+        case "partial":
+            return core_react_1.CheckBoxState.Partial;
+        case "hidden":
+        default:
+            return core_react_1.CheckBoxState.Off;
+    }
+};
+//# sourceMappingURL=VisibilityTreeEventHandler.js.map

package/lib/cjs/components/trees/VisibilityTreeEventHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VisibilityTreeEventHandler.js","sourceRoot":"","sources":["../../../../src/components/trees/VisibilityTreeEventHandler.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,0DAAuD;AACvD,wDAAqD;AACrD,qDAAkD;AAClD,+DAA4D;AAC5D,8DAA2D;AAC3D,kDAAiE;AACjE,4EAAkF;AAkDlF;;;GAGG;AACH,MAAa,0BAA2B,SAAQ,0DAAgC;IAK9E,YAAY,MAAwC;QAClD,KAAK,CAAC,MAAM,CAAC,CAAC;QAHR,eAAU,GAAG,IAAI,KAAK,EAAc,CAAC;QAI3C,IAAI,CAAC,kBAAkB,GAAG,MAAM,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,mBAAmB,GAAG,MAAM,CAAC,kBAAkB,CAAC;QAErD,IAAI,IAAI,CAAC,kBAAkB,EAAE;YAC3B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,gBAAgB,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;SACrK;QAED,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,GAAG,OAAO,CAAC,YAAY,EAAE,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;QACxK,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC,8DAA8D;IACzF,CAAC;IAEe,OAAO;QACrB,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;IAC1D,CAAC;IAEO,oBAAoB,CAAC,KAAqB;QAChD,qBAAqB;QACrB,IAAI,CAAC,IAAI,CAAC,mBAAmB;YAC3B,OAAO,KAAK,CAAC;QAEf,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,mBAAoB,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;IACxF,CAAC;IAEe,mBAAmB,CAAC,EAAE,aAAa,EAAsC;QACvF,MAAM,oBAAoB,GAAG,mCAAgB,CAAC,aAAa,CAAC,CAAC,IAAI,CAC/D,SAAG,CAAC,CAAC,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,EAAE,EAAE;YACjD,OAAO;gBACL,iBAAiB,EAAE,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,CAAC;gBAC/D,mBAAmB,EAAE,IAAI,CAAC,oBAAoB,CAAC,mBAAmB,CAAC;aACpE,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;QACF,OAAO,KAAK,CAAC,mBAAmB,CAAC,EAAE,aAAa,EAAE,oBAAoB,EAAE,CAAC,CAAC;IAC5E,CAAC;IAEe,mBAAmB,CAAC,EAAE,YAAY,EAAqC;QACrF,MAAM,oBAAoB,GAAG,mCAAgB,CAAC,YAAY,CAAC,CAAC,IAAI,CAC9D,SAAG,CAAC,CAAC,EAAE,iBAAiB,EAAE,EAAE,EAAE;YAC5B,OAAO;gBACL,iBAAiB,EAAE,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,CAAC;aAChE,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;QACF,OAAO,KAAK,CAAC,mBAAmB,CAAC,EAAE,YAAY,EAAE,oBAAoB,EAAE,CAAC,CAAC;IAC3E,CAAC;IAEe,sBAAsB,CAAC,KAAuC;QAC5E,qBAAqB;QACrB,IAAI,CAAC,IAAI,CAAC,kBAAkB;YAC1B,OAAO,SAAS,CAAC;QAEnB,WAAI,CAAC,KAAK,CAAC,YAAY,CAAC;aACrB,IAAI,CACH,mBAAQ,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CACtD;aACA,SAAS,EAAE,CAAC;QACf,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,gBAAgB,CAAC,OAA8B;QACrD,OAAO,WAAI,CAAC,OAAO,CAAC;aACjB,IAAI,CACH,mBAAQ,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,EAAE;YAClC,qBAAqB;YACrB,IAAI,CAAC,IAAI,CAAC,kBAAkB;gBAC1B,OAAO,aAAK,CAAC;YACf,OAAO,WAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,QAAQ,KAAK,0BAAa,CAAC,EAAE,CAAC,CAAC,CAAC;QAC5H,CAAC,CAAC,CACH,CAAC;IACN,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,aAAwB,EAAE,gBAAgD;QACvG,MAAM,OAAO,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,iCAAiC,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,4BAA4B,CAAC,gBAAgB,CAAC,CAAC,CAAC;QACtK,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAC5B,CAAC;IAEO,WAAW,CAAC,OAAkC;QACpD,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,KAAK,EAAE,EAAE;YACrC,KAAK,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,IAAI,OAAO,EAAE;gBAC5C,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBACnC,qBAAqB;gBACrB,IAAI,CAAC,IAAI;oBACP,SAAS;gBAEX,IAAI,CAAC,QAAQ,CAAC,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC;gBACnD,IAAI,CAAC,QAAQ,CAAC,SAAS,GAAG,YAAY,CAAC,SAAS,CAAC;gBACjD,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC;gBACzC,IAAI,CAAC,QAAQ,CAAC,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC;aAC9C;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,iCAAiC,CAAC,aAAuB,EAAE,gBAAgD;QACvH,MAAM,UAAU,GAAG,IAAI,GAAG,EAAwB,CAAC;QACnD,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC;YAC5B,OAAO,UAAU,CAAC;QAEpB,MAAM,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YACnD,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACzD,uBAAuB;YACvB,IAAI,IAAI;gBACN,UAAU,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC;QACnF,CAAC,CAAC,CAAC,CAAC;QACJ,OAAO,UAAU,CAAC;IACpB,CAAC;IAEO,KAAK,CAAC,4BAA4B,CAAC,gBAAgD;QACzF,MAAM,UAAU,GAAG,IAAI,GAAG,EAAwB,CAAC;QACnD,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,qBAAqB,EAAE,EAAE;YACtE,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC;SACjF;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAEO,KAAK,CAAC,mBAAmB,CAAC,IAAmB,EAAE,gBAAgD;;QACrG,IAAI,CAAC,IAAI,CAAC,kBAAkB;YAC1B,OAAO,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;QAEhD,MAAM,MAAM,GAAG,MAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,mCAAI,IAAI,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAEpI,IAAI,0BAAa,CAAC,MAAM,CAAC;YACvB,OAAO,IAAI,CAAC,kBAAkB,CAAC,MAAM,MAAM,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IAEO,kBAAkB,CAAC,MAAwB;QACjD,OAAO;YACL,KAAK,EAAE,8BAA8B,CAAC,MAAM,CAAC;YAC7C,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,KAAK;YACtC,SAAS,EAAE,IAAI;YACf,OAAO,EAAE,MAAM,CAAC,OAAO;SACxB,CAAC;IACJ,CAAC;CACF;AA7ID,gEA6IC;AAED,MAAM,8BAA8B,GAAG,CAAC,MAAwB,EAAE,EAAE;IAClE,QAAQ,MAAM,CAAC,KAAK,EAAE;QACpB,KAAK,SAAS;YACZ,OAAO,0BAAa,CAAC,EAAE,CAAC;QAC1B,uBAAuB;QACvB,KAAK,SAAS;YACZ,OAAO,0BAAa,CAAC,OAAO,CAAC;QAC/B,KAAK,QAAQ,CAAC;QACd;YACE,OAAO,0BAAa,CAAC,GAAG,CAAC;KAC5B;AACH,CAAC,CAAC","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 IModelComponents\n */\n\nimport { EMPTY } from \"rxjs/internal/observable/empty\";\nimport { from } from \"rxjs/internal/observable/from\";\nimport { map } from \"rxjs/internal/operators/map\";\nimport { mergeMap } from \"rxjs/internal/operators/mergeMap\";\nimport { toRxjsObservable } from \"@itwin/components-react\";\nimport { CheckBoxState, isPromiseLike } from \"@itwin/core-react\";\nimport { UnifiedSelectionTreeEventHandler } from \"@itwin/presentation-components\";\nimport type {\n  CheckBoxInfo, CheckboxStateChange, TreeCheckboxStateChangeEventArgs, TreeModelNode, TreeNodeItem,\n  TreeSelectionModificationEventArgs, TreeSelectionReplacementEventArgs,\n} from \"@itwin/components-react\";\nimport type { BeEvent, IDisposable } from \"@itwin/core-bentley\";\nimport type { NodeKey } from \"@itwin/presentation-common\";\nimport type { UnifiedSelectionTreeEventHandlerParams } from \"@itwin/presentation-components\";\n\n/**\n * Data structure that describes instance visibility status.\n * @alpha\n */\nexport interface VisibilityStatus {\n  state: \"visible\" | \"partial\" | \"hidden\";\n  isDisabled?: boolean;\n  tooltip?: string;\n}\n\n/**\n * Type definition of visibility change event listener.\n * @alpha\n */\nexport type VisibilityChangeListener = (nodeIds?: string[], visibilityStatus?: Map<string, VisibilityStatus>) => void;\n\n/**\n * Visibility handler used to change or get visibility of instances represented by the tree node.\n * @alpha\n */\nexport interface IVisibilityHandler extends IDisposable {\n  getVisibilityStatus(node: TreeNodeItem, nodeKey: NodeKey): VisibilityStatus | Promise<VisibilityStatus>;\n  changeVisibility(node: TreeNodeItem, nodeKey: NodeKey, shouldDisplay: boolean): Promise<void>;\n  onVisibilityChange: BeEvent<VisibilityChangeListener>;\n}\n\n/**\n * Type definition of predicate used to decide if node can be selected.\n * @alpha\n */\nexport type VisibilityTreeSelectionPredicate = (key: NodeKey, node: TreeNodeItem) => boolean;\n\n/**\n * Parameters for [[VisibilityTreeEventHandler]]\n * @alpha\n */\nexport interface VisibilityTreeEventHandlerParams extends UnifiedSelectionTreeEventHandlerParams {\n  visibilityHandler: IVisibilityHandler | undefined;\n  selectionPredicate?: VisibilityTreeSelectionPredicate;\n}\n\n/**\n * Base event handler for visibility tree.\n * @alpha\n */\nexport class VisibilityTreeEventHandler extends UnifiedSelectionTreeEventHandler {\n  private _visibilityHandler: IVisibilityHandler | undefined;\n  private _selectionPredicate?: VisibilityTreeSelectionPredicate;\n  private _listeners = new Array<() => void>();\n\n  constructor(params: VisibilityTreeEventHandlerParams) {\n    super(params);\n    this._visibilityHandler = params.visibilityHandler;\n    this._selectionPredicate = params.selectionPredicate;\n\n    if (this._visibilityHandler) {\n      this._listeners.push(this._visibilityHandler.onVisibilityChange.addListener(async (nodeIds, visibilityStatus) => this.updateCheckboxes(nodeIds, visibilityStatus)));\n    }\n\n    this._listeners.push(this.modelSource.onModelChanged.addListener(async ([_, changes]) => this.updateCheckboxes([...changes.addedNodeIds, ...changes.modifiedNodeIds])));\n    this.updateCheckboxes(); // eslint-disable-line @typescript-eslint/no-floating-promises\n  }\n\n  public override dispose() {\n    super.dispose();\n    this._listeners.forEach((disposeFunc) => disposeFunc());\n  }\n\n  private filterSelectionItems(items: TreeNodeItem[]) {\n    // istanbul ignore if\n    if (!this._selectionPredicate)\n      return items;\n\n    return items.filter((item) => this._selectionPredicate!(this.getNodeKey(item), item));\n  }\n\n  public override onSelectionModified({ modifications }: TreeSelectionModificationEventArgs) {\n    const filteredModification = toRxjsObservable(modifications).pipe(\n      map(({ selectedNodeItems, deselectedNodeItems }) => {\n        return {\n          selectedNodeItems: this.filterSelectionItems(selectedNodeItems),\n          deselectedNodeItems: this.filterSelectionItems(deselectedNodeItems),\n        };\n      }),\n    );\n    return super.onSelectionModified({ modifications: filteredModification });\n  }\n\n  public override onSelectionReplaced({ replacements }: TreeSelectionReplacementEventArgs) {\n    const filteredReplacements = toRxjsObservable(replacements).pipe(\n      map(({ selectedNodeItems }) => {\n        return {\n          selectedNodeItems: this.filterSelectionItems(selectedNodeItems),\n        };\n      }),\n    );\n    return super.onSelectionReplaced({ replacements: filteredReplacements });\n  }\n\n  public override onCheckboxStateChanged(event: TreeCheckboxStateChangeEventArgs) {\n    // istanbul ignore if\n    if (!this._visibilityHandler)\n      return undefined;\n\n    from(event.stateChanges)\n      .pipe(\n        mergeMap((changes) => this.changeVisibility(changes)),\n      )\n      .subscribe();\n    return undefined;\n  }\n\n  private changeVisibility(changes: CheckboxStateChange[]) {\n    return from(changes)\n      .pipe(\n        mergeMap(({ nodeItem, newState }) => {\n          // istanbul ignore if\n          if (!this._visibilityHandler)\n            return EMPTY;\n          return from(this._visibilityHandler.changeVisibility(nodeItem, this.getNodeKey(nodeItem), newState === CheckBoxState.On));\n        }),\n      );\n  }\n\n  private async updateCheckboxes(affectedNodes?: string[], visibilityStatus?: Map<string, VisibilityStatus>) {\n    const changes = await (affectedNodes ? this.collectAffectedNodesCheckboxInfos(affectedNodes, visibilityStatus) : this.collectAllNodesCheckboxInfos(visibilityStatus));\n    this.updateModel(changes);\n  }\n\n  private updateModel(changes: Map<string, CheckBoxInfo>) {\n    this.modelSource.modifyModel((model) => {\n      for (const [nodeId, checkboxInfo] of changes) {\n        const node = model.getNode(nodeId);\n        // istanbul ignore if\n        if (!node)\n          continue;\n\n        node.checkbox.isDisabled = checkboxInfo.isDisabled;\n        node.checkbox.isVisible = checkboxInfo.isVisible;\n        node.checkbox.state = checkboxInfo.state;\n        node.checkbox.tooltip = checkboxInfo.tooltip;\n      }\n    });\n  }\n\n  private async collectAffectedNodesCheckboxInfos(affectedNodes: string[], visibilityStatus?: Map<string, VisibilityStatus>) {\n    const nodeStates = new Map<string, CheckBoxInfo>();\n    if (affectedNodes.length === 0)\n      return nodeStates;\n\n    await Promise.all(affectedNodes.map(async (nodeId) => {\n      const node = this.modelSource.getModel().getNode(nodeId);\n      // istanbul ignore else\n      if (node)\n        nodeStates.set(nodeId, await this.getNodeCheckBoxInfo(node, visibilityStatus));\n    }));\n    return nodeStates;\n  }\n\n  private async collectAllNodesCheckboxInfos(visibilityStatus?: Map<string, VisibilityStatus>) {\n    const nodeStates = new Map<string, CheckBoxInfo>();\n    for (const node of this.modelSource.getModel().iterateTreeModelNodes()) {\n      nodeStates.set(node.id, await this.getNodeCheckBoxInfo(node, visibilityStatus));\n    }\n    return nodeStates;\n  }\n\n  private async getNodeCheckBoxInfo(node: TreeModelNode, visibilityStatus?: Map<string, VisibilityStatus>): Promise<CheckBoxInfo> {\n    if (!this._visibilityHandler)\n      return { ...node.checkbox, isVisible: false };\n\n    const result = visibilityStatus?.get(node.id) ?? this._visibilityHandler.getVisibilityStatus(node.item, this.getNodeKey(node.item));\n\n    if (isPromiseLike(result))\n      return this.createCheckboxInfo(await result);\n    return this.createCheckboxInfo(result);\n  }\n\n  private createCheckboxInfo(status: VisibilityStatus): CheckBoxInfo {\n    return {\n      state: visibilityStateToCheckboxState(status),\n      isDisabled: status.isDisabled || false,\n      isVisible: true,\n      tooltip: status.tooltip,\n    };\n  }\n}\n\nconst visibilityStateToCheckboxState = (status: VisibilityStatus) => {\n  switch (status.state) {\n    case \"visible\":\n      return CheckBoxState.On;\n    // istanbul ignore next\n    case \"partial\":\n      return CheckBoxState.Partial;\n    case \"hidden\":\n    default:\n      return CheckBoxState.Off;\n  }\n};\n"]}

package/lib/cjs/components/trees/VisibilityTreeRenderer.d.ts

@@ -0,0 +1,43 @@
+/// <reference types="react" />
+import type { IPresentationTreeDataProvider } from "@itwin/presentation-components";
+import type { AbstractTreeNodeLoaderWithProvider, TreeNodeRendererProps, TreeRendererProps } from "@itwin/components-react";
+import type { NodeCheckboxRenderProps } from "@itwin/core-react";
+import type { VisibilityTreeFilterInfo } from "./Common";
+/**
+ * Creates Visibility tree renderer which renders nodes with eye checkbox.
+ * @alpha
+ */
+export declare const useVisibilityTreeRenderer: (iconsEnabled: boolean, descriptionsEnabled: boolean) => (props: TreeRendererProps) => JSX.Element;
+/**
+ * Creates node renderer which renders node with eye checkbox.
+ * @alpha
+ */
+export declare const createVisibilityTreeNodeRenderer: (iconsEnabled: boolean, descriptionEnabled: boolean) => (props: TreeNodeRendererProps) => JSX.Element;
+/**
+ * Checkbox renderer that renders an eye.
+ * @alpha
+ */
+export declare const visibilityTreeNodeCheckboxRenderer: (props: NodeCheckboxRenderProps) => JSX.Element;
+/**
+ * Filters data provider used in supplied node loader and invokes onFilterApplied when filtering is completed.
+ * @alpha
+ */
+export declare const useVisibilityTreeFiltering: (nodeLoader: AbstractTreeNodeLoaderWithProvider<IPresentationTreeDataProvider>, filterInfo?: VisibilityTreeFilterInfo | undefined, onFilterApplied?: ((filteredDataProvider: IPresentationTreeDataProvider, matchesCount: number) => void) | undefined) => {
+    filteredNodeLoader: AbstractTreeNodeLoaderWithProvider<IPresentationTreeDataProvider>;
+    isFiltering: boolean;
+    nodeHighlightingProps: import("@itwin/components-react").HighlightableTreeProps | undefined;
+};
+/**
+ * Properties for [[VisibilityTreeNoFilteredData]] component.
+ * @alpha
+ */
+export interface VisibilityTreeNoFilteredDataProps {
+    title: string;
+    message: string;
+}
+/**
+ * Renders message that no nodes was found for filter.
+ * @alpha
+ */
+export declare function VisibilityTreeNoFilteredData(props: VisibilityTreeNoFilteredDataProps): JSX.Element;
+//# sourceMappingURL=VisibilityTreeRenderer.d.ts.map

package/lib/cjs/components/trees/VisibilityTreeRenderer.js

@@ -0,0 +1,81 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VisibilityTreeNoFilteredData = exports.useVisibilityTreeFiltering = exports.visibilityTreeNodeCheckboxRenderer = exports.createVisibilityTreeNodeRenderer = exports.useVisibilityTreeRenderer = void 0;
+const React = __importStar(require("react"));
+const components_react_1 = require("@itwin/components-react");
+const core_react_1 = require("@itwin/core-react");
+const presentation_components_1 = require("@itwin/presentation-components");
+/**
+ * Creates Visibility tree renderer which renders nodes with eye checkbox.
+ * @alpha
+ */
+const useVisibilityTreeRenderer = (iconsEnabled, descriptionsEnabled) => {
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    const nodeRenderer = React.useCallback(exports.createVisibilityTreeNodeRenderer(iconsEnabled, descriptionsEnabled), [iconsEnabled, descriptionsEnabled]);
+    return React.useCallback((props) => (React.createElement(components_react_1.TreeRenderer, { ...props, nodeRenderer: nodeRenderer })), [nodeRenderer]);
+};
+exports.useVisibilityTreeRenderer = useVisibilityTreeRenderer;
+const imageLoader = new components_react_1.TreeImageLoader();
+/**
+ * Creates node renderer which renders node with eye checkbox.
+ * @alpha
+ */
+const createVisibilityTreeNodeRenderer = (iconsEnabled, descriptionEnabled) => {
+    return (props) => ( // eslint-disable-line react/display-name
+    React.createElement(components_react_1.TreeNodeRenderer, { ...props, checkboxRenderer: exports.visibilityTreeNodeCheckboxRenderer, descriptionEnabled: descriptionEnabled, imageLoader: iconsEnabled ? imageLoader : undefined, className: "with-checkbox" }));
+};
+exports.createVisibilityTreeNodeRenderer = createVisibilityTreeNodeRenderer;
+/**
+ * Checkbox renderer that renders an eye.
+ * @alpha
+ */
+const visibilityTreeNodeCheckboxRenderer = (props) => (React.createElement(core_react_1.ImageCheckBox, { checked: props.checked, disabled: props.disabled, imageOn: "icon-visibility", imageOff: "icon-visibility-hide-2", onClick: props.onChange, tooltip: props.title }));
+exports.visibilityTreeNodeCheckboxRenderer = visibilityTreeNodeCheckboxRenderer;
+/**
+ * Filters data provider used in supplied node loader and invokes onFilterApplied when filtering is completed.
+ * @alpha
+ */
+const useVisibilityTreeFiltering = (nodeLoader, filterInfo, onFilterApplied) => {
+    const { filter, activeMatchIndex } = filterInfo !== null && filterInfo !== void 0 ? filterInfo : { filter: undefined, activeMatchIndex: undefined };
+    const { filteredNodeLoader, isFiltering, matchesCount, nodeHighlightingProps, } = presentation_components_1.useControlledPresentationTreeFiltering({ nodeLoader, filter, activeMatchIndex });
+    React.useEffect(() => {
+        if (filter && matchesCount !== undefined && filteredNodeLoader !== nodeLoader)
+            onFilterApplied && onFilterApplied(filteredNodeLoader.dataProvider, matchesCount);
+    }, [filter, matchesCount, nodeLoader, filteredNodeLoader, onFilterApplied]);
+    return { filteredNodeLoader, isFiltering, nodeHighlightingProps };
+};
+exports.useVisibilityTreeFiltering = useVisibilityTreeFiltering;
+/**
+ * Renders message that no nodes was found for filter.
+ * @alpha
+ */
+function VisibilityTreeNoFilteredData(props) {
+    return (React.createElement("div", { className: "components-tree-errormessage" },
+        React.createElement("span", { className: "errormessage-header" }, props.title),
+        React.createElement("span", { className: "errormessage-body" }, props.message)));
+}
+exports.VisibilityTreeNoFilteredData = VisibilityTreeNoFilteredData;
+//# sourceMappingURL=VisibilityTreeRenderer.js.map

package/lib/cjs/components/trees/VisibilityTreeRenderer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VisibilityTreeRenderer.js","sourceRoot":"","sources":["../../../../src/components/trees/VisibilityTreeRenderer.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;;;;;;;;;;;;;;;;;;;;;;AAE/F,6CAA+B;AAC/B,8DAA0F;AAC1F,kDAAkD;AAClD,4EAAwF;AAQxF;;;GAGG;AACI,MAAM,yBAAyB,GAAG,CAAC,YAAqB,EAAE,mBAA4B,EAAE,EAAE;IAC/F,uDAAuD;IACvD,MAAM,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC,wCAAgC,CAAC,YAAY,EAAE,mBAAmB,CAAC,EAAE,CAAC,YAAY,EAAE,mBAAmB,CAAC,CAAC,CAAC;IACjJ,OAAO,KAAK,CAAC,WAAW,CAAC,CAAC,KAAwB,EAAE,EAAE,CAAC,CACrD,oBAAC,+BAAY,OACP,KAAK,EACT,YAAY,EAAE,YAAY,GAC1B,CACH,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;AACrB,CAAC,CAAC;AATW,QAAA,yBAAyB,6BASpC;AAEF,MAAM,WAAW,GAAG,IAAI,kCAAe,EAAE,CAAC;AAC1C;;;GAGG;AACI,MAAM,gCAAgC,GAAG,CAAC,YAAqB,EAAE,kBAA2B,EAAE,EAAE;IACrG,OAAO,CAAC,KAA4B,EAAE,EAAE,CAAC,EAAE,yCAAyC;IAClF,oBAAC,mCAAgB,OACX,KAAK,EACT,gBAAgB,EAAE,0CAAkC,EACpD,kBAAkB,EAAE,kBAAkB,EACtC,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,EACnD,SAAS,EAAC,eAAe,GACzB,CACH,CAAC;AACJ,CAAC,CAAC;AAVW,QAAA,gCAAgC,oCAU3C;AAEF;;;GAGG;AACI,MAAM,kCAAkC,GAAG,CAAC,KAA8B,EAAE,EAAE,CAAC,CACpF,oBAAC,0BAAa,IACZ,OAAO,EAAE,KAAK,CAAC,OAAO,EACtB,QAAQ,EAAE,KAAK,CAAC,QAAQ,EACxB,OAAO,EAAC,iBAAiB,EACzB,QAAQ,EAAC,wBAAwB,EACjC,OAAO,EAAE,KAAK,CAAC,QAAQ,EACvB,OAAO,EAAE,KAAK,CAAC,KAAK,GACpB,CACH,CAAC;AATW,QAAA,kCAAkC,sCAS7C;AAEF;;;GAGG;AACI,MAAM,0BAA0B,GAAG,CACxC,UAA6E,EAC7E,UAAqC,EACrC,eAAqG,EACrG,EAAE;IACF,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,EAAE,MAAM,EAAE,SAAS,EAAE,gBAAgB,EAAE,SAAS,EAAE,CAAC;IACtG,MAAM,EACJ,kBAAkB,EAClB,WAAW,EACX,YAAY,EACZ,qBAAqB,GACtB,GAAG,gEAAsC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC,CAAC;IAErF,KAAK,CAAC,SAAS,CACb,GAAG,EAAE;QACH,IAAI,MAAM,IAAI,YAAY,KAAK,SAAS,IAAI,kBAAkB,KAAK,UAAU;YAC3E,eAAe,IAAI,eAAe,CAAC,kBAAkB,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;IACtF,CAAC,EACD,CAAC,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,kBAAkB,EAAE,eAAe,CAAC,CACxE,CAAC;IAEF,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,qBAAqB,EAAE,CAAC;AACpE,CAAC,CAAC;AAtBW,QAAA,0BAA0B,8BAsBrC;AAWF;;;GAGG;AACH,SAAgB,4BAA4B,CAAC,KAAwC;IACnF,OAAO,CACL,6BAAK,SAAS,EAAC,8BAA8B;QAC3C,8BAAM,SAAS,EAAC,qBAAqB,IAAE,KAAK,CAAC,KAAK,CAAQ;QAC1D,8BAAM,SAAS,EAAC,mBAAmB,IAAE,KAAK,CAAC,OAAO,CAAQ,CACtD,CACP,CAAC;AACJ,CAAC;AAPD,oEAOC","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\nimport * as React from \"react\";\nimport { TreeImageLoader, TreeNodeRenderer, TreeRenderer } from \"@itwin/components-react\";\nimport { ImageCheckBox } from \"@itwin/core-react\";\nimport { useControlledPresentationTreeFiltering } from \"@itwin/presentation-components\";\nimport type { IPresentationTreeDataProvider } from \"@itwin/presentation-components\";\nimport type {\n  AbstractTreeNodeLoaderWithProvider, TreeNodeRendererProps, TreeRendererProps,\n} from \"@itwin/components-react\";\nimport type { NodeCheckboxRenderProps } from \"@itwin/core-react\";\nimport type { VisibilityTreeFilterInfo } from \"./Common\";\n\n/**\n * Creates Visibility tree renderer which renders nodes with eye checkbox.\n * @alpha\n */\nexport const useVisibilityTreeRenderer = (iconsEnabled: boolean, descriptionsEnabled: boolean) => {\n  // eslint-disable-next-line react-hooks/exhaustive-deps\n  const nodeRenderer = React.useCallback(createVisibilityTreeNodeRenderer(iconsEnabled, descriptionsEnabled), [iconsEnabled, descriptionsEnabled]);\n  return React.useCallback((props: TreeRendererProps) => (\n    <TreeRenderer\n      {...props}\n      nodeRenderer={nodeRenderer}\n    />\n  ), [nodeRenderer]);\n};\n\nconst imageLoader = new TreeImageLoader();\n/**\n * Creates node renderer which renders node with eye checkbox.\n * @alpha\n */\nexport const createVisibilityTreeNodeRenderer = (iconsEnabled: boolean, descriptionEnabled: boolean) => {\n  return (props: TreeNodeRendererProps) => ( // eslint-disable-line react/display-name\n    <TreeNodeRenderer\n      {...props}\n      checkboxRenderer={visibilityTreeNodeCheckboxRenderer}\n      descriptionEnabled={descriptionEnabled}\n      imageLoader={iconsEnabled ? imageLoader : undefined}\n      className=\"with-checkbox\"\n    />\n  );\n};\n\n/**\n * Checkbox renderer that renders an eye.\n * @alpha\n */\nexport const visibilityTreeNodeCheckboxRenderer = (props: NodeCheckboxRenderProps) => (\n  <ImageCheckBox\n    checked={props.checked}\n    disabled={props.disabled}\n    imageOn=\"icon-visibility\"\n    imageOff=\"icon-visibility-hide-2\"\n    onClick={props.onChange}\n    tooltip={props.title}\n  />\n);\n\n/**\n * Filters data provider used in supplied node loader and invokes onFilterApplied when filtering is completed.\n * @alpha\n */\nexport const useVisibilityTreeFiltering = (\n  nodeLoader: AbstractTreeNodeLoaderWithProvider<IPresentationTreeDataProvider>,\n  filterInfo?: VisibilityTreeFilterInfo,\n  onFilterApplied?: (filteredDataProvider: IPresentationTreeDataProvider, matchesCount: number) => void,\n) => {\n  const { filter, activeMatchIndex } = filterInfo ?? { filter: undefined, activeMatchIndex: undefined };\n  const {\n    filteredNodeLoader,\n    isFiltering,\n    matchesCount,\n    nodeHighlightingProps,\n  } = useControlledPresentationTreeFiltering({ nodeLoader, filter, activeMatchIndex });\n\n  React.useEffect(\n    () => {\n      if (filter && matchesCount !== undefined && filteredNodeLoader !== nodeLoader)\n        onFilterApplied && onFilterApplied(filteredNodeLoader.dataProvider, matchesCount);\n    },\n    [filter, matchesCount, nodeLoader, filteredNodeLoader, onFilterApplied],\n  );\n\n  return { filteredNodeLoader, isFiltering, nodeHighlightingProps };\n};\n\n/**\n * Properties for [[VisibilityTreeNoFilteredData]] component.\n * @alpha\n */\nexport interface VisibilityTreeNoFilteredDataProps {\n  title: string;\n  message: string;\n}\n\n/**\n * Renders message that no nodes was found for filter.\n * @alpha\n */\nexport function VisibilityTreeNoFilteredData(props: VisibilityTreeNoFilteredDataProps) {\n  return (\n    <div className=\"components-tree-errormessage\">\n      <span className=\"errormessage-header\">{props.title}</span>\n      <span className=\"errormessage-body\">{props.message}</span>\n    </div>\n  );\n}\n"]}

package/lib/cjs/components/trees/category-tree/Categories.json

@@ -0,0 +1,102 @@
+{
+  "$schema": "../../../../node_modules/@itwin/presentation-common/Ruleset.schema.json",
+  "id": "tree-widget-react/CategoriesTree",
+  "rules": [
+    {
+      "ruleType": "RootNodes",
+      "subConditions": [
+        {
+          "condition": "GetVariableStringValue(\"ViewType\") = \"3d\"",
+          "specifications": [
+            {
+              "specType": "InstanceNodesOfSpecificClasses",
+              "classes": [
+                {
+                  "schemaName": "BisCore",
+                  "classNames": [
+                    "SpatialCategory"
+                  ]
+                }
+              ],
+              "arePolymorphic": true,
+              "relatedInstances": [
+                {
+                  "relationshipPath": {
+                    "relationship": {
+                      "schemaName": "BisCore",
+                      "className": "ModelContainsElements"
+                    },
+                    "direction": "Backward"
+                  },
+                  "isRequired": true,
+                  "alias": "model"
+                }
+              ],
+              "instanceFilter": "NOT this.IsPrivate AND (NOT model.IsPrivate OR model.IsOfClass(\"DictionaryModel\", \"BisCore\")) AND this.HasRelatedInstance(\"BisCore:GeometricElement3dIsInCategory\", \"Backward\", \"BisCore:Element\")",
+              "groupByClass": false,
+              "groupByLabel": false
+            }
+          ]
+        },
+        {
+          "condition": "GetVariableStringValue(\"ViewType\") = \"2d\"",
+          "specifications": [
+            {
+              "specType": "InstanceNodesOfSpecificClasses",
+              "classes": [
+                {
+                  "schemaName": "BisCore",
+                  "classNames": [
+                    "DrawingCategory"
+                  ]
+                }
+              ],
+              "arePolymorphic": true,
+              "relatedInstances": [
+                {
+                  "relationshipPath": {
+                    "relationship": {
+                      "schemaName": "BisCore",
+                      "className": "ModelContainsElements"
+                    },
+                    "direction": "Backward"
+                  },
+                  "isRequired": true,
+                  "alias": "model"
+                }
+              ],
+              "instanceFilter": "NOT this.IsPrivate AND (NOT model.IsPrivate OR model.IsOfClass(\"DictionaryModel\", \"BisCore\")) AND this.HasRelatedInstance(\"BisCore:GeometricElement2dIsInCategory\", \"Backward\", \"BisCore:Element\")",
+              "groupByClass": false,
+              "groupByLabel": false
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "ruleType": "ChildNodes",
+      "condition": "ParentNode.IsOfClass(\"Category\", \"BisCore\") ANDALSO ParentNode.ECInstance.GetRelatedInstancesCount(\"BisCore:CategoryOwnsSubCategories\", \"Forward\", \"BisCore:SubCategory\") > 1",
+      "specifications": [
+        {
+          "specType": "RelatedInstanceNodes",
+          "relationshipPaths": [
+            {
+              "relationship": {
+                "schemaName": "BisCore",
+                "className": "CategoryOwnsSubCategories"
+              },
+              "direction": "Forward"
+            }
+          ],
+          "groupByClass": false,
+          "groupByLabel": false
+        }
+      ]
+    },
+    {
+      "ruleType": "LabelOverride",
+      "condition": "this.IsOfClass(\"Category\", \"BisCore\")",
+      "description": "this.Description"
+    }
+  ]
+}

package/lib/cjs/components/trees/category-tree/CategoriesTree.d.ts

@@ -0,0 +1,65 @@
+/// <reference types="react" />
+import "./CategoriesTree.scss";
+import { CategoryVisibilityHandler } from "./CategoryVisibilityHandler";
+import type { IModelConnection, ViewManager, Viewport } from "@itwin/core-frontend";
+import type { Ruleset } from "@itwin/presentation-common";
+import type { IPresentationTreeDataProvider } from "@itwin/presentation-components";
+import type { VisibilityTreeFilterInfo } from "../Common";
+/**
+ * Presentation rules used by ControlledCategoriesTree
+ * @internal
+ */
+export declare const RULESET_CATEGORIES: Ruleset;
+/**
+ * Properties for the [[CategoryTree]] component
+ * @public
+ */
+export interface CategoryTreeProps {
+    /** Flag for accommodating all viewports */
+    allViewports?: boolean;
+    /** Active viewport */
+    activeView?: Viewport;
+    /**
+     * An IModel to pull data from
+     */
+    iModel: IModelConnection;
+    /** Width of the component */
+    width: number;
+    /** Height of the component */
+    height: number;
+    /**
+     * Information for tree filtering.
+     * @alpha
+     */
+    filterInfo?: VisibilityTreeFilterInfo;
+    /**
+     * Callback invoked when tree is filtered.
+     */
+    onFilterApplied?: (filteredDataProvider: IPresentationTreeDataProvider, matchesCount: number) => void;
+    /**
+     * Custom category visibility handler to use for testing
+     * @internal
+     */
+    categoryVisibilityHandler?: CategoryVisibilityHandler;
+    /**
+     * Custom view manager to use for testing
+     * @internal
+     */
+    viewManager?: ViewManager;
+}
+/**
+ * Tree which displays and manages categories contained in an iModel.
+ * @public
+ */
+export declare function CategoryTree(props: CategoryTreeProps): JSX.Element;
+/**
+ * Toggles visibility of categories to show or hide.
+ * @alpha
+ */
+export declare function toggleAllCategories(viewManager: ViewManager, imodel: IModelConnection, display: boolean, viewport?: Viewport, forAllViewports?: boolean, filteredProvider?: IPresentationTreeDataProvider): Promise<void>;
+/**
+ * Gets ids of all categories or categories from filtered data provider.
+ * @alpha
+ */
+export declare function getCategories(imodel: IModelConnection, viewport?: Viewport, filteredProvider?: IPresentationTreeDataProvider): Promise<string[]>;
+//# sourceMappingURL=CategoriesTree.d.ts.map