@itwin/tree-widget-react 0.10.0-dev.1 → 1.0.0-dev.0

package/lib/cjs/components/trees/external-sources-tree/ExternalSourcesTreeComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExternalSourcesTreeComponent.js","sourceRoot":"","sources":["../../../../../src/components/trees/external-sources-tree/ExternalSourcesTreeComponent.tsx"],"names":[],"mappings":";;;;AAAA;;;+FAG+F;AAE/F,sCAAoC;AACpC,oDAA+D;AAC/D,oDAAiD;AACjD,qDAAkD;AAClD,+DAA4D;AAI5D;;;GAGG;AACI,MAAM,4BAA4B,GAAG,CAAC,KAAS,EAAE,EAAE;IACxD,MAAM,MAAM,GAAG,IAAA,uCAAyB,GAAE,CAAC;IAC3C,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,IAAI,CAAC;KACb;IACD,OAAO,CACL,uBAAC,gCAAgC,OAAK,KAAK,EAAE,MAAM,EAAE,MAAM,GAAI,CAChE,CAAC;AACJ,CAAC,CAAC;AARW,QAAA,4BAA4B,gCAQvC;AAEF,SAAS,gCAAgC,CAAC,KAAmC;IAC3E,OAAO,CACL,uBAAC,qBAAS,cACP,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CACtB,uBAAC,yCAAmB,OACd,KAAK,EACT,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,MAAM,GACd,CACH,GACS,CACb,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,oCAA4B,CAAC,EAAE,GAAG,uBAAuB,CAAC;AAE1D;;;GAGG;AACH,oCAA4B,CAAC,QAAQ,GAAG,GAAG,EAAE,CAAC,uBAAU,CAAC,SAAS,CAAC,iBAAiB,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\nimport \"../VisibilityTreeBase.scss\";\nimport { useActiveIModelConnection } from \"@itwin/appui-react\";\nimport { TreeWidget } from \"../../../TreeWidget\";\nimport { AutoSizer } from \"../../utils/AutoSizer\";\nimport { ExternalSourcesTree } from \"./ExternalSourcesTree\";\n\nimport type { IModelConnection } from \"@itwin/core-frontend\";\n\n/**\n * A component that displays an External Sources tree and any necessary \"chrome\".\n * @alpha\n */\nexport const ExternalSourcesTreeComponent = (props: {}) => {\n  const iModel = useActiveIModelConnection();\n  if (!iModel) {\n    return null;\n  }\n  return (\n    <ExternalSourcesTreeComponentImpl {...props} iModel={iModel} />\n  );\n};\n\nfunction ExternalSourcesTreeComponentImpl(props: { iModel: IModelConnection }) {\n  return (\n    <AutoSizer>\n      {({ width, height }) => (\n        <ExternalSourcesTree\n          {...props}\n          width={width}\n          height={height}\n        />\n      )}\n    </AutoSizer>\n  );\n}\n\n/**\n * Id of the component. May be used when a creating a [[TreeDefinition]] for [[ExternalSourcesTreeComponent]].\n * @alpha\n */\nExternalSourcesTreeComponent.id = \"external-sources-tree\";\n\n/**\n * Label of the component. May be used when a creating a [[TreeDefinition]] for [[ExternalSourcesTreeComponent]].\n * @alpha\n */\nExternalSourcesTreeComponent.getLabel = () => TreeWidget.translate(\"externalSources\");\n"]}

package/lib/cjs/components/trees/imodel-content-tree/IModelContentTree.d.ts

@@ -0,0 +1,30 @@
+/// <reference types="react" />
+import { SelectionMode } from "@itwin/components-react";
+import type { IModelConnection } from "@itwin/core-frontend";
+import type { Ruleset } from "@itwin/presentation-common";
+/**
+ * Presentation rules used by IModelContentTree
+ * @internal
+ */
+export declare const RULESET_IMODEL_CONTENT: Ruleset;
+/**
+ * Props for [[IModelContentTree]]
+ * @public
+ */
+export interface IModelContentTreeProps extends Omit<React.HTMLProps<HTMLDivElement>, "children"> {
+    /** An IModel to pull data from */
+    iModel: IModelConnection;
+    /** Width of the component */
+    width: number;
+    /** Height of the component */
+    height: number;
+    /** Selection mode in the tree */
+    selectionMode?: SelectionMode;
+}
+/**
+ * A tree that shows all iModel content starting from the root Subject, then the hierarchy of child
+ * Subjects, their Models and Elements contained in those Models.
+ * @public
+ */
+export declare const IModelContentTree: (props: IModelContentTreeProps) => JSX.Element;
+//# sourceMappingURL=IModelContentTree.d.ts.map

package/lib/cjs/components/trees/imodel-content-tree/IModelContentTree.js

@@ -0,0 +1,39 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IModelContentTree = exports.RULESET_IMODEL_CONTENT = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+const classnames_1 = __importDefault(require("classnames"));
+const react_1 = require("react");
+const components_react_1 = require("@itwin/components-react");
+const presentation_components_1 = require("@itwin/presentation-components");
+/**
+ * Presentation rules used by IModelContentTree
+ * @internal
+ */
+exports.RULESET_IMODEL_CONTENT = require("./IModelContent.json"); // eslint-disable-line @typescript-eslint/no-var-requires
+/**
+ * A tree that shows all iModel content starting from the root Subject, then the hierarchy of child
+ * Subjects, their Models and Elements contained in those Models.
+ * @public
+ */
+const IModelContentTree = (props) => {
+    const { iModel, className, width, height, ...divProps } = props;
+    const { nodeLoader } = (0, presentation_components_1.usePresentationTreeNodeLoader)({
+        imodel: iModel,
+        ruleset: exports.RULESET_IMODEL_CONTENT,
+        pagingSize: 20,
+        appendChildrenCountForGroupingNodes: true,
+    });
+    const eventHandler = (0, components_react_1.useTreeEventsHandler)((0, react_1.useMemo)(() => ({ nodeLoader, modelSource: nodeLoader.modelSource }), [nodeLoader]));
+    const treeModel = (0, components_react_1.useTreeModel)(nodeLoader.modelSource);
+    return ((0, jsx_runtime_1.jsx)("div", { ...divProps, className: (0, classnames_1.default)("imodel-content-tree", className), children: (0, jsx_runtime_1.jsx)(components_react_1.ControlledTree, { width: width, height: height, nodeLoader: nodeLoader, selectionMode: props.selectionMode ? /* istanbul ignore next */ props.selectionMode : components_react_1.SelectionMode.None, eventsHandler: eventHandler, model: treeModel, iconsEnabled: true }) }));
+};
+exports.IModelContentTree = IModelContentTree;
+//# sourceMappingURL=IModelContentTree.js.map

package/lib/cjs/components/trees/imodel-content-tree/IModelContentTree.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModelContentTree.js","sourceRoot":"","sources":["../../../../../src/components/trees/imodel-content-tree/IModelContentTree.tsx"],"names":[],"mappings":";;;;;;;AAAA;;;+FAG+F;AAE/F,4DAAoC;AACpC,iCAAgC;AAChC,8DAA4G;AAC5G,4EAA+E;AAK/E;;;GAGG;AACU,QAAA,sBAAsB,GAAY,OAAO,CAAC,sBAAsB,CAAC,CAAC,CAAC,yDAAyD;AAiBzI;;;;GAIG;AACI,MAAM,iBAAiB,GAAG,CAAC,KAA6B,EAAE,EAAE;IACjE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,QAAQ,EAAE,GAAG,KAAK,CAAC;IAEhE,MAAM,EAAE,UAAU,EAAE,GAAG,IAAA,uDAA6B,EAAC;QACnD,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,8BAAsB;QAC/B,UAAU,EAAE,EAAE;QACd,mCAAmC,EAAE,IAAI;KAC1C,CAAC,CAAC;IACH,MAAM,YAAY,GAAG,IAAA,uCAAoB,EAAC,IAAA,eAAO,EAAC,GAAG,EAAE,CAAC,CAAC,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAE9H,MAAM,SAAS,GAAG,IAAA,+BAAY,EAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IAEvD,OAAO,CACL,mCAAS,QAAQ,EAAE,SAAS,EAAE,IAAA,oBAAU,EAAC,qBAAqB,EAAE,SAAS,CAAC,YACxE,uBAAC,iCAAc,IACb,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,UAAU,EACtB,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,0BAA0B,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,gCAAa,CAAC,IAAI,EACxG,aAAa,EAAE,YAAY,EAC3B,KAAK,EAAE,SAAS,EAChB,YAAY,EAAE,IAAI,GAClB,GACE,CACP,CAAC;AACJ,CAAC,CAAC;AA1BW,QAAA,iBAAiB,qBA0B5B","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 classNames from \"classnames\";\nimport { useMemo } from \"react\";\nimport { ControlledTree, SelectionMode, useTreeEventsHandler, useTreeModel } from \"@itwin/components-react\";\nimport { usePresentationTreeNodeLoader } from \"@itwin/presentation-components\";\n\nimport type { IModelConnection } from \"@itwin/core-frontend\";\nimport type { Ruleset } from \"@itwin/presentation-common\";\n\n/**\n * Presentation rules used by IModelContentTree\n * @internal\n */\nexport const RULESET_IMODEL_CONTENT: Ruleset = require(\"./IModelContent.json\"); // eslint-disable-line @typescript-eslint/no-var-requires\n\n/**\n * Props for [[IModelContentTree]]\n * @public\n */\nexport interface IModelContentTreeProps extends Omit<React.HTMLProps<HTMLDivElement>, \"children\"> {\n  /** An IModel to pull data from */\n  iModel: IModelConnection;\n  /** Width of the component */\n  width: number;\n  /** Height of the component */\n  height: number;\n  /** Selection mode in the tree */\n  selectionMode?: SelectionMode;\n}\n\n/**\n * A tree that shows all iModel content starting from the root Subject, then the hierarchy of child\n * Subjects, their Models and Elements contained in those Models.\n * @public\n */\nexport const IModelContentTree = (props: IModelContentTreeProps) => {\n  const { iModel, className, width, height, ...divProps } = props;\n\n  const { nodeLoader } = usePresentationTreeNodeLoader({\n    imodel: iModel,\n    ruleset: RULESET_IMODEL_CONTENT,\n    pagingSize: 20,\n    appendChildrenCountForGroupingNodes: true,\n  });\n  const eventHandler = useTreeEventsHandler(useMemo(() => ({ nodeLoader, modelSource: nodeLoader.modelSource }), [nodeLoader]));\n\n  const treeModel = useTreeModel(nodeLoader.modelSource);\n\n  return (\n    <div {...divProps} className={classNames(\"imodel-content-tree\", className)}>\n      <ControlledTree\n        width={width}\n        height={height}\n        nodeLoader={nodeLoader}\n        selectionMode={props.selectionMode ? /* istanbul ignore next */ props.selectionMode : SelectionMode.None}\n        eventsHandler={eventHandler}\n        model={treeModel}\n        iconsEnabled={true}\n      />\n    </div>\n  );\n};\n"]}

package/lib/cjs/components/trees/imodel-content-tree/IModelContentTreeComponent.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="react" />
+import "../VisibilityTreeBase.scss";
+import type { IModelContentTreeProps } from "./IModelContentTree";
+/**
+ * Props for [[IModelContentTreeComponent]].
+ * @public
+ */
+export type IModelContentTreeComponentProps = Omit<IModelContentTreeProps, "iModel" | "width" | "height">;
+/**
+ * A component that renders [[IModelContentTree]]
+ * @public
+ */
+export declare const IModelContentTreeComponent: {
+    (props: IModelContentTreeComponentProps): JSX.Element | null;
+    /**
+     * Id of the component. May be used when a creating a [[TreeDefinition]] for [[TreeWidgetComponent]].
+     * @public
+     */
+    id: string;
+    /**
+     * Label of the component. May be used when a creating a [[TreeDefinition]] for [[TreeWidgetComponent]].
+     * @public
+     */
+    getLabel(): string;
+};
+//# sourceMappingURL=IModelContentTreeComponent.d.ts.map

package/lib/cjs/components/trees/imodel-content-tree/IModelContentTreeComponent.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IModelContentTreeComponent = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+require("../VisibilityTreeBase.scss");
+const appui_react_1 = require("@itwin/appui-react");
+const TreeWidget_1 = require("../../../TreeWidget");
+const AutoSizer_1 = require("../../utils/AutoSizer");
+const IModelContentTree_1 = require("./IModelContentTree");
+/**
+ * A component that renders [[IModelContentTree]]
+ * @public
+ */
+const IModelContentTreeComponent = (props) => {
+    const iModel = (0, appui_react_1.useActiveIModelConnection)();
+    if (!iModel)
+        return null;
+    return ((0, jsx_runtime_1.jsx)(AutoSizer_1.AutoSizer, { children: ({ width, height }) => ((0, jsx_runtime_1.jsx)(IModelContentTree_1.IModelContentTree, { ...props, iModel: iModel, width: width, height: height })) }));
+};
+exports.IModelContentTreeComponent = IModelContentTreeComponent;
+/**
+ * Id of the component. May be used when a creating a [[TreeDefinition]] for [[TreeWidgetComponent]].
+ * @public
+ */
+exports.IModelContentTreeComponent.id = "imodel-content-tree";
+/**
+ * Label of the component. May be used when a creating a [[TreeDefinition]] for [[TreeWidgetComponent]].
+ * @public
+ */
+exports.IModelContentTreeComponent.getLabel = () => TreeWidget_1.TreeWidget.translate("imodelContent");
+//# sourceMappingURL=IModelContentTreeComponent.js.map

package/lib/cjs/components/trees/imodel-content-tree/IModelContentTreeComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModelContentTreeComponent.js","sourceRoot":"","sources":["../../../../../src/components/trees/imodel-content-tree/IModelContentTreeComponent.tsx"],"names":[],"mappings":";;;;AAAA;;;+FAG+F;AAE/F,sCAAoC;AACpC,oDAA+D;AAC/D,oDAAiD;AACjD,qDAAkD;AAClD,2DAAwD;AAUxD;;;GAGG;AACI,MAAM,0BAA0B,GAAG,CAAC,KAAsC,EAAE,EAAE;IACnF,MAAM,MAAM,GAAG,IAAA,uCAAyB,GAAE,CAAC;IAE3C,IAAI,CAAC,MAAM;QACT,OAAO,IAAI,CAAC;IAEd,OAAO,CACL,uBAAC,qBAAS,cACP,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CACtB,uBAAC,qCAAiB,OACZ,KAAK,EACT,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,MAAM,GACd,CACH,GACS,CACb,CAAC;AACJ,CAAC,CAAC;AAlBW,QAAA,0BAA0B,8BAkBrC;AAEF;;;GAGG;AACH,kCAA0B,CAAC,EAAE,GAAG,qBAAqB,CAAC;AAEtD;;;GAGG;AACH,kCAA0B,CAAC,QAAQ,GAAG,GAAG,EAAE,CAAC,uBAAU,CAAC,SAAS,CAAC,eAAe,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\nimport \"../VisibilityTreeBase.scss\";\nimport { useActiveIModelConnection } from \"@itwin/appui-react\";\nimport { TreeWidget } from \"../../../TreeWidget\";\nimport { AutoSizer } from \"../../utils/AutoSizer\";\nimport { IModelContentTree } from \"./IModelContentTree\";\n\nimport type { IModelContentTreeProps } from \"./IModelContentTree\";\n\n/**\n * Props for [[IModelContentTreeComponent]].\n * @public\n */\nexport type IModelContentTreeComponentProps = Omit<IModelContentTreeProps, \"iModel\" | \"width\" | \"height\">;\n\n/**\n * A component that renders [[IModelContentTree]]\n * @public\n */\nexport const IModelContentTreeComponent = (props: IModelContentTreeComponentProps) => {\n  const iModel = useActiveIModelConnection();\n\n  if (!iModel)\n    return null;\n\n  return (\n    <AutoSizer>\n      {({ width, height }) => (\n        <IModelContentTree\n          {...props}\n          iModel={iModel}\n          width={width}\n          height={height}\n        />\n      )}\n    </AutoSizer>\n  );\n};\n\n/**\n * Id of the component. May be used when a creating a [[TreeDefinition]] for [[TreeWidgetComponent]].\n * @public\n */\nIModelContentTreeComponent.id = \"imodel-content-tree\";\n\n/**\n * Label of the component. May be used when a creating a [[TreeDefinition]] for [[TreeWidgetComponent]].\n * @public\n */\nIModelContentTreeComponent.getLabel = () => TreeWidget.translate(\"imodelContent\");\n"]}

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

@@ -1,11 +1,15 @@
 export * from "./Common";
-export * from "./IModelContentTree";
 export * from "./VisibilityTreeEventHandler";
 export * from "./VisibilityTreeRenderer";
+export * from "./imodel-content-tree/IModelContentTree";
+export * from "./imodel-content-tree/IModelContentTreeComponent";
 export * from "./category-tree/CategoriesTree";
 export * from "./category-tree/CategoriesTreeComponent";
 export * from "./category-tree/CategoryVisibilityHandler";
+export * from "./external-sources-tree/ExternalSourcesTree";
+export * from "./external-sources-tree/ExternalSourcesTreeComponent";
 export * from "./models-tree/ModelsTree";
 export * from "./models-tree/ModelsTreeComponent";
 export * from "./models-tree/ModelsVisibilityHandler";
+export * from "./models-tree/Utils";
 //# sourceMappingURL=index.d.ts.map

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

@@ -5,7 +5,11 @@
 *--------------------------------------------------------------------------------------------*/
 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]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -15,13 +19,17 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Common"), exports);
-__exportStar(require("./IModelContentTree"), exports);
 __exportStar(require("./VisibilityTreeEventHandler"), exports);
 __exportStar(require("./VisibilityTreeRenderer"), exports);
+__exportStar(require("./imodel-content-tree/IModelContentTree"), exports);
+__exportStar(require("./imodel-content-tree/IModelContentTreeComponent"), exports);
 __exportStar(require("./category-tree/CategoriesTree"), exports);
 __exportStar(require("./category-tree/CategoriesTreeComponent"), exports);
 __exportStar(require("./category-tree/CategoryVisibilityHandler"), exports);
+__exportStar(require("./external-sources-tree/ExternalSourcesTree"), exports);
+__exportStar(require("./external-sources-tree/ExternalSourcesTreeComponent"), exports);
 __exportStar(require("./models-tree/ModelsTree"), exports);
 __exportStar(require("./models-tree/ModelsTreeComponent"), exports);
 __exportStar(require("./models-tree/ModelsVisibilityHandler"), exports);
+__exportStar(require("./models-tree/Utils"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/components/trees/index.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;;;;;;;;;;AAE/F,2CAAyB;AACzB,sDAAoC;AACpC,+DAA6C;AAC7C,2DAAyC;AACzC,iEAA+C;AAC/C,0EAAwD;AACxD,4EAA0D;AAC1D,2DAAyC;AACzC,oEAAkD;AAClD,wEAAsD","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\nexport * from \"./Common\";\nexport * from \"./IModelContentTree\";\nexport * from \"./VisibilityTreeEventHandler\";\nexport * from \"./VisibilityTreeRenderer\";\nexport * from \"./category-tree/CategoriesTree\";\nexport * from \"./category-tree/CategoriesTreeComponent\";\nexport * from \"./category-tree/CategoryVisibilityHandler\";\nexport * from \"./models-tree/ModelsTree\";\nexport * from \"./models-tree/ModelsTreeComponent\";\nexport * from \"./models-tree/ModelsVisibilityHandler\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/components/trees/index.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;;;;;;;;;;;;;;AAE/F,2CAAyB;AACzB,+DAA6C;AAC7C,2DAAyC;AAEzC,0EAAwD;AACxD,mFAAiE;AAEjE,iEAA+C;AAC/C,0EAAwD;AACxD,4EAA0D;AAE1D,8EAA4D;AAC5D,uFAAqE;AAErE,2DAAyC;AACzC,oEAAkD;AAClD,wEAAsD;AACtD,sDAAoC","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\nexport * from \"./Common\";\nexport * from \"./VisibilityTreeEventHandler\";\nexport * from \"./VisibilityTreeRenderer\";\n\nexport * from \"./imodel-content-tree/IModelContentTree\";\nexport * from \"./imodel-content-tree/IModelContentTreeComponent\";\n\nexport * from \"./category-tree/CategoriesTree\";\nexport * from \"./category-tree/CategoriesTreeComponent\";\nexport * from \"./category-tree/CategoryVisibilityHandler\";\n\nexport * from \"./external-sources-tree/ExternalSourcesTree\";\nexport * from \"./external-sources-tree/ExternalSourcesTreeComponent\";\n\nexport * from \"./models-tree/ModelsTree\";\nexport * from \"./models-tree/ModelsTreeComponent\";\nexport * from \"./models-tree/ModelsVisibilityHandler\";\nexport * from \"./models-tree/Utils\";\n"]}

package/lib/cjs/components/trees/models-tree/ModelsTree.d.ts

@@ -1,16 +1,28 @@
+/// <reference types="react" />
 import "../VisibilityTreeBase.scss";
-import * as React from "react";
 import { SelectionMode } from "@itwin/components-react";
-import { IModelConnection, Viewport } from "@itwin/core-frontend";
-import { Ruleset } from "@itwin/presentation-common";
-import { IPresentationTreeDataProvider } from "@itwin/presentation-components";
-import { ClassGroupingOption, VisibilityTreeFilterInfo } from "../Common";
-import { ModelsTreeSelectionPredicate, ModelsVisibilityHandler } from "./ModelsVisibilityHandler";
-/** @internal */
-export declare const RULESET_MODELS: Ruleset;
-/** @internal */
-export declare const RULESET_MODELS_GROUPED_BY_CLASS: Ruleset;
-/** Props for [[ModelsTree]] component
+import { ClassGroupingOption } from "../Common";
+import { ModelsVisibilityHandler } from "./ModelsVisibilityHandler";
+import type { IModelConnection, Viewport } from "@itwin/core-frontend";
+import type { SingleSchemaClassSpecification } from "@itwin/presentation-common";
+import type { IPresentationTreeDataProvider } from "@itwin/presentation-components";
+import type { VisibilityTreeFilterInfo } from "../Common";
+import type { ModelsTreeSelectionPredicate } from "./ModelsVisibilityHandler";
+/**
+ * Props for configuring the hierarchy in [[ModelsTree]].
+ * @public
+ */
+export interface ModelsTreeHierarchyConfiguration {
+    /** Should the tree group displayed element nodes by class. Defaults to `ClassGroupingOption.No`. */
+    enableElementsClassGrouping?: ClassGroupingOption;
+    /**
+     * Defines the `bis.GeometricElement3d` sub-class that should be used to load element nodes.
+     * Defaults to `bis.GeometricElement3d`. It's expected for the given class to derive from it.
+     */
+    elementClassSpecification?: SingleSchemaClassSpecification;
+}
+/**
+ * Props for [[ModelsTree]] component
  * @public
  */
 export interface ModelsTreeProps {
@@ -28,20 +40,18 @@ export interface ModelsTreeProps {
     selectionMode?: SelectionMode;
     /**
      * Predicate which indicates whether node can be selected or no
-     * @alpha
      */
     selectionPredicate?: ModelsTreeSelectionPredicate;
     /**
      * Active view used to determine and control visibility
      */
-    activeView?: Viewport;
+    activeView: Viewport;
     /**
      * Ref to the root HTML element used by this component
      */
     rootElementRef?: React.Ref<HTMLDivElement>;
     /**
      * Information for tree filtering.
-     * @alpha
      */
     filterInfo?: VisibilityTreeFilterInfo;
     /**
@@ -49,10 +59,9 @@ export interface ModelsTreeProps {
      */
     onFilterApplied?: (filteredDataProvider: IPresentationTreeDataProvider, matchesCount: number) => void;
     /**
-     * Should the tree group displayed element nodes by class.
-     * @beta
+     * Configuration options for the hierarchy loaded in the component.
      */
-    enableElementsClassGrouping?: ClassGroupingOption;
+    hierarchyConfig?: ModelsTreeHierarchyConfiguration;
     /**
      * Auto-update the hierarchy when data in the iModel changes.
      * @alpha
@@ -60,7 +69,6 @@ export interface ModelsTreeProps {
     enableHierarchyAutoUpdate?: boolean;
     /**
      * Custom visibility handler.
-     * @alpha
      */
     modelsVisibilityHandler?: ModelsVisibilityHandler;
 }

package/lib/cjs/components/trees/models-tree/ModelsTree.js

@@ -1,31 +1,13 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModelsTree = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
 /*---------------------------------------------------------------------------------------------
 * 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.ModelsTree = exports.RULESET_MODELS_GROUPED_BY_CLASS = exports.RULESET_MODELS = void 0;
 require("../VisibilityTreeBase.scss");
-const React = __importStar(require("react"));
+const react_1 = 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");
@@ -34,12 +16,8 @@ const Common_1 = require("../Common");
 const VisibilityTreeEventHandler_1 = require("../VisibilityTreeEventHandler");
 const VisibilityTreeRenderer_1 = require("../VisibilityTreeRenderer");
 const ModelsVisibilityHandler_1 = require("./ModelsVisibilityHandler");
+const Utils_1 = require("./Utils");
 const PAGING_SIZE = 20;
-/** @internal */
-exports.RULESET_MODELS = require("./Hierarchy.json"); // eslint-disable-line @typescript-eslint/no-var-requires
-/** @internal */
-exports.RULESET_MODELS_GROUPED_BY_CLASS = require("./Hierarchy.GroupedByClass.json"); // eslint-disable-line @typescript-eslint/no-var-requires
-const RULESET_MODELS_SEARCH = require("./ModelsTreeSearch.json"); // eslint-disable-line @typescript-eslint/no-var-requires
 /**
  * A tree component that shows a subject - model - category - element
  * hierarchy along with checkboxes that represent and allow changing
@@ -52,33 +30,35 @@ function ModelsTree(props) {
     const filterApplied = filteredNodeLoader !== nodeLoader;
     const { activeView, modelsVisibilityHandler, selectionPredicate } = props;
     const visibilityHandler = useVisibilityHandler(nodeLoader.dataProvider.rulesetId, props.iModel, activeView, modelsVisibilityHandler, getFilteredDataProvider(filteredNodeLoader.dataProvider), props.enableHierarchyAutoUpdate);
-    const eventHandler = (0, core_react_1.useDisposable)(React.useCallback(() => new VisibilityTreeEventHandler_1.VisibilityTreeEventHandler({
+    const eventHandler = (0, core_react_1.useDisposable)((0, react_1.useCallback)(() => new VisibilityTreeEventHandler_1.VisibilityTreeEventHandler({
         nodeLoader: filteredNodeLoader,
         visibilityHandler,
-        collapsedChildrenDisposalEnabled: true,
         selectionPredicate: (node) => !selectionPredicate || !(0, presentation_components_1.isPresentationTreeNodeItem)(node) ? true : selectionPredicate(node.key, ModelsVisibilityHandler_1.ModelsVisibilityHandler.getNodeType(node)),
     }), [filteredNodeLoader, visibilityHandler, selectionPredicate]));
     const treeModel = (0, components_react_1.useTreeModel)(filteredNodeLoader.modelSource);
-    const treeRenderer = (0, VisibilityTreeRenderer_1.useVisibilityTreeRenderer)(true, false);
-    const overlay = isFiltering ? React.createElement("div", { className: "filteredTreeOverlay" }) : undefined;
+    const treeRenderer = (0, VisibilityTreeRenderer_1.createVisibilityTreeRenderer)({ iconsEnabled: true, descriptionEnabled: false, levelOffset: 10, disableRootNodeCollapse: true });
+    const overlay = isFiltering ? (0, jsx_runtime_1.jsx)("div", { className: "filteredTreeOverlay" }) : undefined;
     // istanbul ignore next
-    const noFilteredDataRenderer = React.useCallback(() => {
-        return React.createElement(VisibilityTreeRenderer_1.VisibilityTreeNoFilteredData, { title: TreeWidget_1.TreeWidget.translate("modelTree.noModelFound"), message: TreeWidget_1.TreeWidget.translate("modelTree.noMatchingModelNames") });
+    const noFilteredDataRenderer = (0, react_1.useCallback)(() => {
+        return (0, jsx_runtime_1.jsx)(VisibilityTreeRenderer_1.VisibilityTreeNoFilteredData, { title: TreeWidget_1.TreeWidget.translate("modelTree.noModelFound"), message: TreeWidget_1.TreeWidget.translate("modelTree.noMatchingModelNames") });
     }, []);
-    return (React.createElement("div", { className: "tree-widget-visibility-tree-base", ref: props.rootElementRef },
-        React.createElement(components_react_1.ControlledTree, { nodeLoader: filteredNodeLoader, model: treeModel, selectionMode: props.selectionMode || components_react_1.SelectionMode.None, eventsHandler: eventHandler, treeRenderer: treeRenderer, nodeHighlightingProps: nodeHighlightingProps, noDataRenderer: filterApplied ? noFilteredDataRenderer : undefined, onItemsRendered: onItemsRendered, width: props.width, height: props.height }),
-        overlay));
+    return ((0, jsx_runtime_1.jsxs)("div", { className: "tree-widget-visibility-tree-base", ref: props.rootElementRef, children: [(0, jsx_runtime_1.jsx)(components_react_1.ControlledTree, { nodeLoader: filteredNodeLoader, model: treeModel, selectionMode: props.selectionMode || components_react_1.SelectionMode.None, eventsHandler: eventHandler, treeRenderer: treeRenderer, nodeHighlightingProps: nodeHighlightingProps, noDataRenderer: filterApplied ? noFilteredDataRenderer : undefined, onItemsRendered: onItemsRendered, width: props.width, height: props.height }), overlay] }));
 }
 exports.ModelsTree = ModelsTree;
 function useModelsTreeNodeLoader(props) {
     const rulesets = {
-        general: (!props.enableElementsClassGrouping) ? exports.RULESET_MODELS : /* istanbul ignore next */ exports.RULESET_MODELS_GROUPED_BY_CLASS,
-        search: RULESET_MODELS_SEARCH,
+        general: (0, react_1.useMemo)(() => (0, Utils_1.createRuleset)({
+            enableElementsClassGrouping: !!props.hierarchyConfig?.enableElementsClassGrouping,
+            elementClassSpecification: props.hierarchyConfig?.elementClassSpecification,
+        }), [props.hierarchyConfig?.enableElementsClassGrouping, props.hierarchyConfig?.elementClassSpecification]),
+        search: (0, react_1.useMemo)(() => (0, Utils_1.createSearchRuleset)({
+            elementClassSpecification: props.hierarchyConfig?.elementClassSpecification,
+        }), [props.hierarchyConfig?.elementClassSpecification]),
     };
     const { nodeLoader, onItemsRendered } = (0, presentation_components_1.usePresentationTreeNodeLoader)({
         imodel: props.iModel,
         ruleset: rulesets.general,
-        appendChildrenCountForGroupingNodes: (props.enableElementsClassGrouping === Common_1.ClassGroupingOption.YesWithCounts),
+        appendChildrenCountForGroupingNodes: (props.hierarchyConfig?.enableElementsClassGrouping === Common_1.ClassGroupingOption.YesWithCounts),
         pagingSize: PAGING_SIZE,
         enableHierarchyAutoUpdate: props.enableHierarchyAutoUpdate,
     });
@@ -96,22 +76,14 @@ function useModelsTreeNodeLoader(props) {
     };
 }
 function useVisibilityHandler(rulesetId, iModel, activeView, visibilityHandler, filteredDataProvider, hierarchyAutoUpdateEnabled) {
-    const subjectModelIdsCache = React.useMemo(() => new ModelsVisibilityHandler_1.SubjectModelIdsCache(iModel), [iModel]);
-    const defaultVisibilityHandler = (0, core_react_1.useOptionalDisposable)(React.useCallback(() => {
-        if (activeView)
-            return createVisibilityHandler(rulesetId, activeView, subjectModelIdsCache, hierarchyAutoUpdateEnabled);
-        return undefined;
-    }, [rulesetId, activeView, subjectModelIdsCache, hierarchyAutoUpdateEnabled]));
+    const subjectModelIdsCache = (0, react_1.useMemo)(() => new ModelsVisibilityHandler_1.SubjectModelIdsCache(iModel), [iModel]);
+    const defaultVisibilityHandler = (0, core_react_1.useDisposable)((0, react_1.useCallback)(() => new ModelsVisibilityHandler_1.ModelsVisibilityHandler({ rulesetId, viewport: activeView, hierarchyAutoUpdateEnabled, subjectModelIdsCache }), [rulesetId, activeView, subjectModelIdsCache, hierarchyAutoUpdateEnabled]));
     const handler = visibilityHandler ?? defaultVisibilityHandler;
-    React.useEffect(() => {
+    (0, react_1.useEffect)(() => {
         handler && handler.setFilteredDataProvider(filteredDataProvider);
     }, [handler, filteredDataProvider]);
     return handler;
 }
-const createVisibilityHandler = (rulesetId, activeView, subjectModelIdsCache, hierarchyAutoUpdateEnabled) => {
-    // istanbul ignore next
-    return new ModelsVisibilityHandler_1.ModelsVisibilityHandler({ rulesetId, viewport: activeView, hierarchyAutoUpdateEnabled, subjectModelIdsCache });
-};
 const isFilteredDataProvider = (dataProvider) => {
     const filteredProvider = dataProvider;
     return filteredProvider.nodeMatchesFilter !== undefined && filteredProvider.getActiveMatch !== undefined && filteredProvider.countFilteringResults !== undefined;

package/lib/cjs/components/trees/models-tree/ModelsTree.js.map

@@ -1 +1 @@
-{"version":3,"file":"ModelsTree.js","sourceRoot":"","sources":["../../../../../src/components/trees/models-tree/ModelsTree.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;;;;;;;;;;;;;;;;;;;;;;AAE/F,sCAAoC;AACpC,6CAA+B;AAC/B,8DAAsF;AAEtF,kDAAyE;AAEzE,4EAEwC;AACxC,oDAAiD;AACjD,sCAA0E;AAC1E,8EAA2E;AAC3E,sEAAgI;AAChI,uEAAwH;AAExH,MAAM,WAAW,GAAG,EAAE,CAAC;AAEvB,gBAAgB;AACH,QAAA,cAAc,GAAY,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,yDAAyD;AAC7H,gBAAgB;AACH,QAAA,+BAA+B,GAAY,OAAO,CAAC,iCAAiC,CAAC,CAAC,CAAC,yDAAyD;AAE7J,MAAM,qBAAqB,GAAY,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,yDAAyD;AAyDpI;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,KAAsB;IAC/C,MAAM,EAAE,UAAU,EAAE,eAAe,EAAE,GAAG,uBAAuB,CAAC,KAAK,CAAC,CAAC;IACvE,MAAM,EAAE,kBAAkB,EAAE,WAAW,EAAE,qBAAqB,EAAE,GAAG,IAAA,mDAA0B,EAAC,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IACnJ,MAAM,aAAa,GAAG,kBAAkB,KAAK,UAAU,CAAC;IAExD,MAAM,EAAE,UAAU,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,KAAK,CAAC;IAE1E,MAAM,iBAAiB,GAAG,oBAAoB,CAC5C,UAAU,CAAC,YAAY,CAAC,SAAS,EACjC,KAAK,CAAC,MAAM,EACZ,UAAU,EACV,uBAAuB,EACvB,uBAAuB,CAAC,kBAAkB,CAAC,YAAY,CAAC,EACxD,KAAK,CAAC,yBAAyB,CAAC,CAAC;IACnC,MAAM,YAAY,GAAG,IAAA,0BAAa,EAAC,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,uDAA0B,CAAC;QACxF,UAAU,EAAE,kBAAkB;QAC9B,iBAAiB;QACjB,gCAAgC,EAAE,IAAI;QACtC,kBAAkB,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,kBAAkB,IAAI,CAAC,IAAA,oDAA0B,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,GAAG,EAAE,iDAAuB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;KACxK,CAAC,EAAE,CAAC,kBAAkB,EAAE,iBAAiB,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAElE,MAAM,SAAS,GAAG,IAAA,+BAAY,EAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;IAC/D,MAAM,YAAY,GAAG,IAAA,kDAAyB,EAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAE5D,MAAM,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,6BAAK,SAAS,EAAC,qBAAqB,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;IAElF,uBAAuB;IACvB,MAAM,sBAAsB,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;QACpD,OAAO,oBAAC,qDAA4B,IAClC,KAAK,EAAE,uBAAU,CAAC,SAAS,CAAC,wBAAwB,CAAC,EACrD,OAAO,EAAE,uBAAU,CAAC,SAAS,CAAC,gCAAgC,CAAC,GAC/D,CAAC;IACL,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,CACL,6BAAK,SAAS,EAAC,kCAAkC,EAAC,GAAG,EAAE,KAAK,CAAC,cAAc;QACzE,oBAAC,iCAAc,IACb,UAAU,EAAE,kBAAkB,EAC9B,KAAK,EAAE,SAAS,EAChB,aAAa,EAAE,KAAK,CAAC,aAAa,IAAI,gCAAa,CAAC,IAAI,EACxD,aAAa,EAAE,YAAY,EAC3B,YAAY,EAAE,YAAY,EAC1B,qBAAqB,EAAE,qBAAqB,EAC5C,cAAc,EAAE,aAAa,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,SAAS,EAClE,eAAe,EAAE,eAAe,EAChC,KAAK,EAAE,KAAK,CAAC,KAAK,EAClB,MAAM,EAAE,KAAK,CAAC,MAAM,GACpB;QACD,OAAO,CACJ,CACP,CAAC;AACJ,CAAC;AAnDD,gCAmDC;AAED,SAAS,uBAAuB,CAAC,KAAsB;IACrD,MAAM,QAAQ,GAAG;QACf,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC,CAAC,CAAC,sBAAc,CAAC,CAAC,CAAC,0BAA0B,CAAC,uCAA+B;QAC3H,MAAM,EAAE,qBAAqB;KAC9B,CAAC;IAEF,MAAM,EAAE,UAAU,EAAE,eAAe,EAAE,GAAG,IAAA,uDAA6B,EAAC;QACpE,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,mCAAmC,EAAE,CAAC,KAAK,CAAC,2BAA2B,KAAK,4BAAmB,CAAC,aAAa,CAAC;QAC9G,UAAU,EAAE,WAAW;QACvB,yBAAyB,EAAE,KAAK,CAAC,yBAAyB;KAC3D,CAAC,CAAC;IACH,MAAM,EAAE,UAAU,EAAE,gBAAgB,EAAE,eAAe,EAAE,qBAAqB,EAAE,GAAG,IAAA,uDAA6B,EAAC;QAC7G,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,OAAO,EAAE,QAAQ,CAAC,MAAM;QACxB,UAAU,EAAE,WAAW;QACvB,yBAAyB,EAAE,KAAK,CAAC,yBAAyB;KAC3D,CAAC,CAAC;IAEH,MAAM,gBAAgB,GAAG,KAAK,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,UAAU,CAAC;IAClF,MAAM,2BAA2B,GAAG,KAAK,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,eAAe,CAAC;IAEvG,OAAO;QACL,UAAU,EAAE,gBAAgB;QAC5B,eAAe,EAAE,2BAA2B;KAC7C,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAC3B,SAAiB,EACjB,MAAwB,EACxB,UAAqB,EACrB,iBAA2C,EAC3C,oBAA4D,EAC5D,0BAAoC;IAEpC,MAAM,oBAAoB,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,8CAAoB,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7F,MAAM,wBAAwB,GAAG,IAAA,kCAAqB,EAAC,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;QAC5E,IAAI,UAAU;YACZ,OAAO,uBAAuB,CAAC,SAAS,EAAE,UAAU,EAAE,oBAAoB,EAAE,0BAA0B,CAAC,CAAC;QAC1G,OAAO,SAAS,CAAC;IACnB,CAAC,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,oBAAoB,EAAE,0BAA0B,CAAC,CAAC,CAAC,CAAC;IAE/E,MAAM,OAAO,GAAG,iBAAiB,IAAI,wBAAwB,CAAC;IAE9D,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,OAAO,IAAI,OAAO,CAAC,uBAAuB,CAAC,oBAAoB,CAAC,CAAC;IACnE,CAAC,EAAE,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC,CAAC;IAEpC,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,uBAAuB,GAAG,CAAC,SAAiB,EAAE,UAAoB,EAAE,oBAA0C,EAAE,0BAAoC,EAAuC,EAAE;IACjM,uBAAuB;IACvB,OAAO,IAAI,iDAAuB,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,0BAA0B,EAAE,oBAAoB,EAAE,CAAC,CAAC;AAC5H,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAAC,YAAmF,EAAyD,EAAE;IAC5K,MAAM,gBAAgB,GAAG,YAAqD,CAAC;IAC/E,OAAO,gBAAgB,CAAC,iBAAiB,KAAK,SAAS,IAAI,gBAAgB,CAAC,cAAc,KAAK,SAAS,IAAI,gBAAgB,CAAC,qBAAqB,KAAK,SAAS,CAAC;AACnK,CAAC,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAAC,YAAmF,EAAqD,EAAE;IACzK,OAAO,sBAAsB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;AACzE,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\nimport \"../VisibilityTreeBase.scss\";\nimport * as React from \"react\";\nimport { ControlledTree, SelectionMode, useTreeModel } from \"@itwin/components-react\";\nimport { IModelConnection, Viewport } from \"@itwin/core-frontend\";\nimport { useDisposable, useOptionalDisposable } from \"@itwin/core-react\";\nimport { Ruleset } from \"@itwin/presentation-common\";\nimport {\n  IFilteredPresentationTreeDataProvider, IPresentationTreeDataProvider, isPresentationTreeNodeItem, usePresentationTreeNodeLoader,\n} from \"@itwin/presentation-components\";\nimport { TreeWidget } from \"../../../TreeWidget\";\nimport { ClassGroupingOption, VisibilityTreeFilterInfo } from \"../Common\";\nimport { VisibilityTreeEventHandler } from \"../VisibilityTreeEventHandler\";\nimport { useVisibilityTreeFiltering, useVisibilityTreeRenderer, VisibilityTreeNoFilteredData } from \"../VisibilityTreeRenderer\";\nimport { ModelsTreeSelectionPredicate, ModelsVisibilityHandler, SubjectModelIdsCache } from \"./ModelsVisibilityHandler\";\n\nconst PAGING_SIZE = 20;\n\n/** @internal */\nexport const RULESET_MODELS: Ruleset = require(\"./Hierarchy.json\"); // eslint-disable-line @typescript-eslint/no-var-requires\n/** @internal */\nexport const RULESET_MODELS_GROUPED_BY_CLASS: Ruleset = require(\"./Hierarchy.GroupedByClass.json\"); // eslint-disable-line @typescript-eslint/no-var-requires\n\nconst RULESET_MODELS_SEARCH: Ruleset = require(\"./ModelsTreeSearch.json\"); // eslint-disable-line @typescript-eslint/no-var-requires\n\n/** Props for [[ModelsTree]] component\n * @public\n */\nexport interface ModelsTreeProps {\n  /**\n   * An IModel to pull data from\n   */\n  iModel: IModelConnection;\n  /** Width of the component */\n  width: number;\n  /** Height of the component */\n  height: number;\n  /**\n   * Selection mode in the tree\n   */\n  selectionMode?: SelectionMode;\n  /**\n   * Predicate which indicates whether node can be selected or no\n   * @alpha\n   */\n  selectionPredicate?: ModelsTreeSelectionPredicate;\n  /**\n   * Active view used to determine and control visibility\n   */\n  activeView?: Viewport;\n  /**\n   * Ref to the root HTML element used by this component\n   */\n  rootElementRef?: React.Ref<HTMLDivElement>;\n  /**\n   * Information for tree filtering.\n   * @alpha\n   */\n  filterInfo?: VisibilityTreeFilterInfo;\n  /**\n   * Callback invoked when tree is filtered.\n   */\n  onFilterApplied?: (filteredDataProvider: IPresentationTreeDataProvider, matchesCount: number) => void;\n  /**\n   * Should the tree group displayed element nodes by class.\n   * @beta\n   */\n  enableElementsClassGrouping?: ClassGroupingOption;\n  /**\n   * Auto-update the hierarchy when data in the iModel changes.\n   * @alpha\n   */\n  enableHierarchyAutoUpdate?: boolean;\n  /**\n   * Custom visibility handler.\n   * @alpha\n   */\n  modelsVisibilityHandler?: ModelsVisibilityHandler;\n}\n\n/**\n * A tree component that shows a subject - model - category - element\n * hierarchy along with checkboxes that represent and allow changing\n * the display of those instances.\n * @public\n */\nexport function ModelsTree(props: ModelsTreeProps) {\n  const { nodeLoader, onItemsRendered } = useModelsTreeNodeLoader(props);\n  const { filteredNodeLoader, isFiltering, nodeHighlightingProps } = useVisibilityTreeFiltering(nodeLoader, props.filterInfo, props.onFilterApplied);\n  const filterApplied = filteredNodeLoader !== nodeLoader;\n\n  const { activeView, modelsVisibilityHandler, selectionPredicate } = props;\n\n  const visibilityHandler = useVisibilityHandler(\n    nodeLoader.dataProvider.rulesetId,\n    props.iModel,\n    activeView,\n    modelsVisibilityHandler,\n    getFilteredDataProvider(filteredNodeLoader.dataProvider),\n    props.enableHierarchyAutoUpdate);\n  const eventHandler = useDisposable(React.useCallback(() => new VisibilityTreeEventHandler({\n    nodeLoader: filteredNodeLoader,\n    visibilityHandler,\n    collapsedChildrenDisposalEnabled: true,\n    selectionPredicate: (node) => !selectionPredicate || !isPresentationTreeNodeItem(node) ? true : selectionPredicate(node.key, ModelsVisibilityHandler.getNodeType(node)),\n  }), [filteredNodeLoader, visibilityHandler, selectionPredicate]));\n\n  const treeModel = useTreeModel(filteredNodeLoader.modelSource);\n  const treeRenderer = useVisibilityTreeRenderer(true, false);\n\n  const overlay = isFiltering ? <div className=\"filteredTreeOverlay\" /> : undefined;\n\n  // istanbul ignore next\n  const noFilteredDataRenderer = React.useCallback(() => {\n    return <VisibilityTreeNoFilteredData\n      title={TreeWidget.translate(\"modelTree.noModelFound\")}\n      message={TreeWidget.translate(\"modelTree.noMatchingModelNames\")}\n    />;\n  }, []);\n\n  return (\n    <div className=\"tree-widget-visibility-tree-base\" ref={props.rootElementRef}>\n      <ControlledTree\n        nodeLoader={filteredNodeLoader}\n        model={treeModel}\n        selectionMode={props.selectionMode || SelectionMode.None}\n        eventsHandler={eventHandler}\n        treeRenderer={treeRenderer}\n        nodeHighlightingProps={nodeHighlightingProps}\n        noDataRenderer={filterApplied ? noFilteredDataRenderer : undefined}\n        onItemsRendered={onItemsRendered}\n        width={props.width}\n        height={props.height}\n      />\n      {overlay}\n    </div>\n  );\n}\n\nfunction useModelsTreeNodeLoader(props: ModelsTreeProps) {\n  const rulesets = {\n    general: (!props.enableElementsClassGrouping) ? RULESET_MODELS : /* istanbul ignore next */ RULESET_MODELS_GROUPED_BY_CLASS,\n    search: RULESET_MODELS_SEARCH,\n  };\n\n  const { nodeLoader, onItemsRendered } = usePresentationTreeNodeLoader({\n    imodel: props.iModel,\n    ruleset: rulesets.general,\n    appendChildrenCountForGroupingNodes: (props.enableElementsClassGrouping === ClassGroupingOption.YesWithCounts),\n    pagingSize: PAGING_SIZE,\n    enableHierarchyAutoUpdate: props.enableHierarchyAutoUpdate,\n  });\n  const { nodeLoader: searchNodeLoader, onItemsRendered: onSearchItemsRendered } = usePresentationTreeNodeLoader({\n    imodel: props.iModel,\n    ruleset: rulesets.search,\n    pagingSize: PAGING_SIZE,\n    enableHierarchyAutoUpdate: props.enableHierarchyAutoUpdate,\n  });\n\n  const activeNodeLoader = props.filterInfo?.filter ? searchNodeLoader : nodeLoader;\n  const activeItemsRenderedCallback = props.filterInfo?.filter ? onSearchItemsRendered : onItemsRendered;\n\n  return {\n    nodeLoader: activeNodeLoader,\n    onItemsRendered: activeItemsRenderedCallback,\n  };\n}\n\nfunction useVisibilityHandler(\n  rulesetId: string,\n  iModel: IModelConnection,\n  activeView?: Viewport,\n  visibilityHandler?: ModelsVisibilityHandler,\n  filteredDataProvider?: IFilteredPresentationTreeDataProvider,\n  hierarchyAutoUpdateEnabled?: boolean,\n) {\n  const subjectModelIdsCache = React.useMemo(() => new SubjectModelIdsCache(iModel), [iModel]);\n  const defaultVisibilityHandler = useOptionalDisposable(React.useCallback(() => {\n    if (activeView)\n      return createVisibilityHandler(rulesetId, activeView, subjectModelIdsCache, hierarchyAutoUpdateEnabled);\n    return undefined;\n  }, [rulesetId, activeView, subjectModelIdsCache, hierarchyAutoUpdateEnabled]));\n\n  const handler = visibilityHandler ?? defaultVisibilityHandler;\n\n  React.useEffect(() => {\n    handler && handler.setFilteredDataProvider(filteredDataProvider);\n  }, [handler, filteredDataProvider]);\n\n  return handler;\n}\n\nconst createVisibilityHandler = (rulesetId: string, activeView: Viewport, subjectModelIdsCache: SubjectModelIdsCache, hierarchyAutoUpdateEnabled?: boolean): ModelsVisibilityHandler | undefined => {\n  // istanbul ignore next\n  return new ModelsVisibilityHandler({ rulesetId, viewport: activeView, hierarchyAutoUpdateEnabled, subjectModelIdsCache });\n};\n\nconst isFilteredDataProvider = (dataProvider: IPresentationTreeDataProvider | IFilteredPresentationTreeDataProvider): dataProvider is IFilteredPresentationTreeDataProvider => {\n  const filteredProvider = dataProvider as IFilteredPresentationTreeDataProvider;\n  return filteredProvider.nodeMatchesFilter !== undefined && filteredProvider.getActiveMatch !== undefined && filteredProvider.countFilteringResults !== undefined;\n};\n\nconst getFilteredDataProvider = (dataProvider: IPresentationTreeDataProvider | IFilteredPresentationTreeDataProvider): IFilteredPresentationTreeDataProvider | undefined => {\n  return isFilteredDataProvider(dataProvider) ? dataProvider : undefined;\n};\n"]}
+{"version":3,"file":"ModelsTree.js","sourceRoot":"","sources":["../../../../../src/components/trees/models-tree/ModelsTree.tsx"],"names":[],"mappings":";;;;AAAA;;;+FAG+F;AAE/F,sCAAoC;AACpC,iCAAwD;AACxD,8DAAsF;AACtF,kDAAkD;AAClD,4EAA2G;AAC3G,oDAAiD;AACjD,sCAAgD;AAChD,8EAA2E;AAC3E,sEAAmI;AACnI,uEAA0F;AAC1F,mCAA6D;AAQ7D,MAAM,WAAW,GAAG,EAAE,CAAC;AAoEvB;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,KAAsB;IAC/C,MAAM,EAAE,UAAU,EAAE,eAAe,EAAE,GAAG,uBAAuB,CAAC,KAAK,CAAC,CAAC;IACvE,MAAM,EAAE,kBAAkB,EAAE,WAAW,EAAE,qBAAqB,EAAE,GAAG,IAAA,mDAA0B,EAAC,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IACnJ,MAAM,aAAa,GAAG,kBAAkB,KAAK,UAAU,CAAC;IAExD,MAAM,EAAE,UAAU,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,GAAG,KAAK,CAAC;IAE1E,MAAM,iBAAiB,GAAG,oBAAoB,CAC5C,UAAU,CAAC,YAAY,CAAC,SAAS,EACjC,KAAK,CAAC,MAAM,EACZ,UAAU,EACV,uBAAuB,EACvB,uBAAuB,CAAC,kBAAkB,CAAC,YAAY,CAAC,EACxD,KAAK,CAAC,yBAAyB,CAAC,CAAC;IACnC,MAAM,YAAY,GAAG,IAAA,0BAAa,EAAC,IAAA,mBAAW,EAAC,GAAG,EAAE,CAAC,IAAI,uDAA0B,CAAC;QAClF,UAAU,EAAE,kBAAkB;QAC9B,iBAAiB;QACjB,kBAAkB,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,kBAAkB,IAAI,CAAC,IAAA,oDAA0B,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,GAAG,EAAE,iDAAuB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;KACxK,CAAC,EAAE,CAAC,kBAAkB,EAAE,iBAAiB,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAElE,MAAM,SAAS,GAAG,IAAA,+BAAY,EAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;IAC/D,MAAM,YAAY,GAAG,IAAA,qDAA4B,EAAC,EAAE,YAAY,EAAE,IAAI,EAAE,kBAAkB,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE,uBAAuB,EAAE,IAAI,EAAE,CAAC,CAAC;IAErJ,MAAM,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,gCAAK,SAAS,EAAC,qBAAqB,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;IAElF,uBAAuB;IACvB,MAAM,sBAAsB,GAAG,IAAA,mBAAW,EAAC,GAAG,EAAE;QAC9C,OAAO,uBAAC,qDAA4B,IAClC,KAAK,EAAE,uBAAU,CAAC,SAAS,CAAC,wBAAwB,CAAC,EACrD,OAAO,EAAE,uBAAU,CAAC,SAAS,CAAC,gCAAgC,CAAC,GAC/D,CAAC;IACL,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,CACL,iCAAK,SAAS,EAAC,kCAAkC,EAAC,GAAG,EAAE,KAAK,CAAC,cAAc,aACzE,uBAAC,iCAAc,IACb,UAAU,EAAE,kBAAkB,EAC9B,KAAK,EAAE,SAAS,EAChB,aAAa,EAAE,KAAK,CAAC,aAAa,IAAI,gCAAa,CAAC,IAAI,EACxD,aAAa,EAAE,YAAY,EAC3B,YAAY,EAAE,YAAY,EAC1B,qBAAqB,EAAE,qBAAqB,EAC5C,cAAc,EAAE,aAAa,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,SAAS,EAClE,eAAe,EAAE,eAAe,EAChC,KAAK,EAAE,KAAK,CAAC,KAAK,EAClB,MAAM,EAAE,KAAK,CAAC,MAAM,GACpB,EACD,OAAO,IACJ,CACP,CAAC;AACJ,CAAC;AAlDD,gCAkDC;AAED,SAAS,uBAAuB,CAAC,KAAsB;IACrD,MAAM,QAAQ,GAAG;QACf,OAAO,EAAE,IAAA,eAAO,EAAC,GAAG,EAAE,CAAC,IAAA,qBAAa,EAAC;YACnC,2BAA2B,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,EAAE,2BAA2B;YACjF,yBAAyB,EAAE,KAAK,CAAC,eAAe,EAAE,yBAAyB;SAC5E,CAAC,EAAE,CAAC,KAAK,CAAC,eAAe,EAAE,2BAA2B,EAAE,KAAK,CAAC,eAAe,EAAE,yBAAyB,CAAC,CAAC;QAC3G,MAAM,EAAE,IAAA,eAAO,EAAC,GAAG,EAAE,CAAC,IAAA,2BAAmB,EAAC;YACxC,yBAAyB,EAAE,KAAK,CAAC,eAAe,EAAE,yBAAyB;SAC5E,CAAC,EAAE,CAAC,KAAK,CAAC,eAAe,EAAE,yBAAyB,CAAC,CAAC;KACxD,CAAC;IAEF,MAAM,EAAE,UAAU,EAAE,eAAe,EAAE,GAAG,IAAA,uDAA6B,EAAC;QACpE,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,mCAAmC,EAAE,CAAC,KAAK,CAAC,eAAe,EAAE,2BAA2B,KAAK,4BAAmB,CAAC,aAAa,CAAC;QAC/H,UAAU,EAAE,WAAW;QACvB,yBAAyB,EAAE,KAAK,CAAC,yBAAyB;KAC3D,CAAC,CAAC;IACH,MAAM,EAAE,UAAU,EAAE,gBAAgB,EAAE,eAAe,EAAE,qBAAqB,EAAE,GAAG,IAAA,uDAA6B,EAAC;QAC7G,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,OAAO,EAAE,QAAQ,CAAC,MAAM;QACxB,UAAU,EAAE,WAAW;QACvB,yBAAyB,EAAE,KAAK,CAAC,yBAAyB;KAC3D,CAAC,CAAC;IAEH,MAAM,gBAAgB,GAAG,KAAK,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,UAAU,CAAC;IAClF,MAAM,2BAA2B,GAAG,KAAK,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,eAAe,CAAC;IAEvG,OAAO;QACL,UAAU,EAAE,gBAAgB;QAC5B,eAAe,EAAE,2BAA2B;KAC7C,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAC3B,SAAiB,EACjB,MAAwB,EACxB,UAAoB,EACpB,iBAA2C,EAC3C,oBAA4D,EAC5D,0BAAoC;IAEpC,MAAM,oBAAoB,GAAG,IAAA,eAAO,EAAC,GAAG,EAAE,CAAC,IAAI,8CAAoB,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEvF,MAAM,wBAAwB,GAAG,IAAA,0BAAa,EAAC,IAAA,mBAAW,EACxD,GAAG,EAAE,CACH,IAAI,iDAAuB,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,0BAA0B,EAAE,oBAAoB,EAAE,CAAC,EACpH,CAAC,SAAS,EAAE,UAAU,EAAE,oBAAoB,EAAE,0BAA0B,CAAC,CAAC,CAC3E,CAAC;IAEF,MAAM,OAAO,GAAG,iBAAiB,IAAI,wBAAwB,CAAC;IAE9D,IAAA,iBAAS,EAAC,GAAG,EAAE;QACb,OAAO,IAAI,OAAO,CAAC,uBAAuB,CAAC,oBAAoB,CAAC,CAAC;IACnE,CAAC,EAAE,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC,CAAC;IAEpC,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,sBAAsB,GAAG,CAAC,YAAmF,EAAyD,EAAE;IAC5K,MAAM,gBAAgB,GAAG,YAAqD,CAAC;IAC/E,OAAO,gBAAgB,CAAC,iBAAiB,KAAK,SAAS,IAAI,gBAAgB,CAAC,cAAc,KAAK,SAAS,IAAI,gBAAgB,CAAC,qBAAqB,KAAK,SAAS,CAAC;AACnK,CAAC,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAAC,YAAmF,EAAqD,EAAE;IACzK,OAAO,sBAAsB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;AACzE,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\nimport \"../VisibilityTreeBase.scss\";\nimport { useCallback, useEffect, useMemo } from \"react\";\nimport { ControlledTree, SelectionMode, useTreeModel } from \"@itwin/components-react\";\nimport { useDisposable } from \"@itwin/core-react\";\nimport { isPresentationTreeNodeItem, usePresentationTreeNodeLoader } from \"@itwin/presentation-components\";\nimport { TreeWidget } from \"../../../TreeWidget\";\nimport { ClassGroupingOption } from \"../Common\";\nimport { VisibilityTreeEventHandler } from \"../VisibilityTreeEventHandler\";\nimport { createVisibilityTreeRenderer, useVisibilityTreeFiltering, VisibilityTreeNoFilteredData } from \"../VisibilityTreeRenderer\";\nimport { ModelsVisibilityHandler, SubjectModelIdsCache } from \"./ModelsVisibilityHandler\";\nimport { createRuleset, createSearchRuleset } from \"./Utils\";\n\nimport type { IModelConnection, Viewport } from \"@itwin/core-frontend\";\nimport type { SingleSchemaClassSpecification } from \"@itwin/presentation-common\";\nimport type { IFilteredPresentationTreeDataProvider, IPresentationTreeDataProvider } from \"@itwin/presentation-components\";\nimport type { VisibilityTreeFilterInfo } from \"../Common\";\nimport type { ModelsTreeSelectionPredicate } from \"./ModelsVisibilityHandler\";\n\nconst PAGING_SIZE = 20;\n\n/**\n * Props for configuring the hierarchy in [[ModelsTree]].\n * @public\n */\nexport interface ModelsTreeHierarchyConfiguration {\n  /** Should the tree group displayed element nodes by class. Defaults to `ClassGroupingOption.No`. */\n  enableElementsClassGrouping?: ClassGroupingOption;\n  /**\n   * Defines the `bis.GeometricElement3d` sub-class that should be used to load element nodes.\n   * Defaults to `bis.GeometricElement3d`. It's expected for the given class to derive from it.\n   */\n  elementClassSpecification?: SingleSchemaClassSpecification;\n}\n\n/**\n * Props for [[ModelsTree]] component\n * @public\n */\nexport interface ModelsTreeProps {\n  /**\n   * An IModel to pull data from\n   */\n  iModel: IModelConnection;\n  /** Width of the component */\n  width: number;\n  /** Height of the component */\n  height: number;\n  /**\n   * Selection mode in the tree\n   */\n  selectionMode?: SelectionMode;\n  /**\n   * Predicate which indicates whether node can be selected or no\n   */\n  selectionPredicate?: ModelsTreeSelectionPredicate;\n  /**\n   * Active view used to determine and control visibility\n   */\n  activeView: Viewport;\n  /**\n   * Ref to the root HTML element used by this component\n   */\n  rootElementRef?: React.Ref<HTMLDivElement>;\n  /**\n   * Information for tree filtering.\n   */\n  filterInfo?: VisibilityTreeFilterInfo;\n  /**\n   * Callback invoked when tree is filtered.\n   */\n  onFilterApplied?: (filteredDataProvider: IPresentationTreeDataProvider, matchesCount: number) => void;\n  /**\n   * Configuration options for the hierarchy loaded in the component.\n   */\n  hierarchyConfig?: ModelsTreeHierarchyConfiguration;\n  /**\n   * Auto-update the hierarchy when data in the iModel changes.\n   * @alpha\n   */\n  enableHierarchyAutoUpdate?: boolean;\n  /**\n   * Custom visibility handler.\n   */\n  modelsVisibilityHandler?: ModelsVisibilityHandler;\n}\n\n/**\n * A tree component that shows a subject - model - category - element\n * hierarchy along with checkboxes that represent and allow changing\n * the display of those instances.\n * @public\n */\nexport function ModelsTree(props: ModelsTreeProps) {\n  const { nodeLoader, onItemsRendered } = useModelsTreeNodeLoader(props);\n  const { filteredNodeLoader, isFiltering, nodeHighlightingProps } = useVisibilityTreeFiltering(nodeLoader, props.filterInfo, props.onFilterApplied);\n  const filterApplied = filteredNodeLoader !== nodeLoader;\n\n  const { activeView, modelsVisibilityHandler, selectionPredicate } = props;\n\n  const visibilityHandler = useVisibilityHandler(\n    nodeLoader.dataProvider.rulesetId,\n    props.iModel,\n    activeView,\n    modelsVisibilityHandler,\n    getFilteredDataProvider(filteredNodeLoader.dataProvider),\n    props.enableHierarchyAutoUpdate);\n  const eventHandler = useDisposable(useCallback(() => new VisibilityTreeEventHandler({\n    nodeLoader: filteredNodeLoader,\n    visibilityHandler,\n    selectionPredicate: (node) => !selectionPredicate || !isPresentationTreeNodeItem(node) ? true : selectionPredicate(node.key, ModelsVisibilityHandler.getNodeType(node)),\n  }), [filteredNodeLoader, visibilityHandler, selectionPredicate]));\n\n  const treeModel = useTreeModel(filteredNodeLoader.modelSource);\n  const treeRenderer = createVisibilityTreeRenderer({ iconsEnabled: true, descriptionEnabled: false, levelOffset: 10, disableRootNodeCollapse: true });\n\n  const overlay = isFiltering ? <div className=\"filteredTreeOverlay\" /> : undefined;\n\n  // istanbul ignore next\n  const noFilteredDataRenderer = useCallback(() => {\n    return <VisibilityTreeNoFilteredData\n      title={TreeWidget.translate(\"modelTree.noModelFound\")}\n      message={TreeWidget.translate(\"modelTree.noMatchingModelNames\")}\n    />;\n  }, []);\n\n  return (\n    <div className=\"tree-widget-visibility-tree-base\" ref={props.rootElementRef}>\n      <ControlledTree\n        nodeLoader={filteredNodeLoader}\n        model={treeModel}\n        selectionMode={props.selectionMode || SelectionMode.None}\n        eventsHandler={eventHandler}\n        treeRenderer={treeRenderer}\n        nodeHighlightingProps={nodeHighlightingProps}\n        noDataRenderer={filterApplied ? noFilteredDataRenderer : undefined}\n        onItemsRendered={onItemsRendered}\n        width={props.width}\n        height={props.height}\n      />\n      {overlay}\n    </div>\n  );\n}\n\nfunction useModelsTreeNodeLoader(props: ModelsTreeProps) {\n  const rulesets = {\n    general: useMemo(() => createRuleset({\n      enableElementsClassGrouping: !!props.hierarchyConfig?.enableElementsClassGrouping,\n      elementClassSpecification: props.hierarchyConfig?.elementClassSpecification,\n    }), [props.hierarchyConfig?.enableElementsClassGrouping, props.hierarchyConfig?.elementClassSpecification]),\n    search: useMemo(() => createSearchRuleset({\n      elementClassSpecification: props.hierarchyConfig?.elementClassSpecification,\n    }), [props.hierarchyConfig?.elementClassSpecification]),\n  };\n\n  const { nodeLoader, onItemsRendered } = usePresentationTreeNodeLoader({\n    imodel: props.iModel,\n    ruleset: rulesets.general,\n    appendChildrenCountForGroupingNodes: (props.hierarchyConfig?.enableElementsClassGrouping === ClassGroupingOption.YesWithCounts),\n    pagingSize: PAGING_SIZE,\n    enableHierarchyAutoUpdate: props.enableHierarchyAutoUpdate,\n  });\n  const { nodeLoader: searchNodeLoader, onItemsRendered: onSearchItemsRendered } = usePresentationTreeNodeLoader({\n    imodel: props.iModel,\n    ruleset: rulesets.search,\n    pagingSize: PAGING_SIZE,\n    enableHierarchyAutoUpdate: props.enableHierarchyAutoUpdate,\n  });\n\n  const activeNodeLoader = props.filterInfo?.filter ? searchNodeLoader : nodeLoader;\n  const activeItemsRenderedCallback = props.filterInfo?.filter ? onSearchItemsRendered : onItemsRendered;\n\n  return {\n    nodeLoader: activeNodeLoader,\n    onItemsRendered: activeItemsRenderedCallback,\n  };\n}\n\nfunction useVisibilityHandler(\n  rulesetId: string,\n  iModel: IModelConnection,\n  activeView: Viewport,\n  visibilityHandler?: ModelsVisibilityHandler,\n  filteredDataProvider?: IFilteredPresentationTreeDataProvider,\n  hierarchyAutoUpdateEnabled?: boolean,\n) {\n  const subjectModelIdsCache = useMemo(() => new SubjectModelIdsCache(iModel), [iModel]);\n\n  const defaultVisibilityHandler = useDisposable(useCallback(\n    () =>\n      new ModelsVisibilityHandler({ rulesetId, viewport: activeView, hierarchyAutoUpdateEnabled, subjectModelIdsCache }),\n    [rulesetId, activeView, subjectModelIdsCache, hierarchyAutoUpdateEnabled])\n  );\n\n  const handler = visibilityHandler ?? defaultVisibilityHandler;\n\n  useEffect(() => {\n    handler && handler.setFilteredDataProvider(filteredDataProvider);\n  }, [handler, filteredDataProvider]);\n\n  return handler;\n}\n\nconst isFilteredDataProvider = (dataProvider: IPresentationTreeDataProvider | IFilteredPresentationTreeDataProvider): dataProvider is IFilteredPresentationTreeDataProvider => {\n  const filteredProvider = dataProvider as IFilteredPresentationTreeDataProvider;\n  return filteredProvider.nodeMatchesFilter !== undefined && filteredProvider.getActiveMatch !== undefined && filteredProvider.countFilteringResults !== undefined;\n};\n\nconst getFilteredDataProvider = (dataProvider: IPresentationTreeDataProvider | IFilteredPresentationTreeDataProvider): IFilteredPresentationTreeDataProvider | undefined => {\n  return isFilteredDataProvider(dataProvider) ? dataProvider : undefined;\n};\n"]}

package/lib/cjs/components/trees/models-tree/ModelsTreeComponent.d.ts

@@ -1,17 +1,85 @@
 /// <reference types="react" />
 import "../VisibilityTreeBase.scss";
-import { ModelsTreeHeaderButtonProps, ModelTreeProps } from "../../../types";
+import type { TreeHeaderButtonProps } from "../../tree-header/TreeHeader";
+import type { ModelsTreeProps } from "./ModelsTree";
+/**
+ * Information about a single Model.
+ * @public
+ */
 export interface ModelInfo {
     id: string;
     isPlanProjection?: boolean;
 }
+/**
+ * Props that get passed to [[ModelsTreeComponent]] header button renderer.
+ * @see ModelTreeComponentProps.headerButtons
+ * @public
+ */
+export interface ModelsTreeHeaderButtonProps extends TreeHeaderButtonProps {
+    /** A list of models available in the iModel. */
+    models: ModelInfo[];
+}
+/**
+ * Props for [[ModelsTreeComponent]].
+ * @public
+ */
+export interface ModelTreeComponentProps extends Omit<ModelsTreeProps, "iModel" | "activeView" | "width" | "height" | "filterInfo" | "onFilterApplied"> {
+    /**
+     * Renderers of header buttons. Defaults to:
+     * ```ts
+     * [
+     *   ModelsTreeComponent.ShowAllButton,
+     *   ModelsTreeComponent.HideAllButton,
+     *   ModelsTreeComponent.InvertButton,
+     *   ModelsTreeComponent.View2DButton,
+     *   ModelsTreeComponent.View3DButton,
+     * ]
+     * ```
+     */
+    headerButtons?: Array<(props: ModelsTreeHeaderButtonProps) => React.ReactNode>;
+}
+/**
+ * A component that renders [[ModelsTree]] and a header with filtering capabilities
+ * and header buttons.
+ * @public
+ */
 export declare const ModelsTreeComponent: {
-    (props: ModelTreeProps): JSX.Element | null;
+    (props: ModelTreeComponentProps): JSX.Element | null;
+    /**
+     * Renders a "Show all" button that enables display of all models.
+     * @public
+     */
     ShowAllButton: typeof ShowAllButton;
+    /**
+     * Renders a "Hide all" button that disables display of all models.
+     * @public
+     */
     HideAllButton: typeof HideAllButton;
+    /**
+     * Renders an "Invert all" button that inverts display of all models.
+     * @public
+     */
     InvertButton: typeof InvertButton;
+    /**
+     * Renders a "View 2D" button that enables display of all plan projection models and disables all others.
+     * @public
+     */
     View2DButton: typeof View2DButton;
+    /**
+     * Renders a "View 3D" button that enables display of all non-plan projection models and disables all plan projection ones.
+     * @public
+     */
     View3DButton: typeof View3DButton;
+    /**
+     * Id of the component. May be used when a creating a [[TreeDefinition]] for [[TreeWidgetComponent]].
+     * @public
+     */
+    id: string;
+    /**
+     * Label of the component. May be used when a creating a [[TreeDefinition]] for [[TreeWidgetComponent]].
+     * @public
+     */
+    getLabel(): string;
 };
 declare function ShowAllButton(props: ModelsTreeHeaderButtonProps): JSX.Element;
 declare function HideAllButton(props: ModelsTreeHeaderButtonProps): JSX.Element;