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

package/lib/esm/components/trees/external-sources-tree/ExternalSources.json

@@ -0,0 +1,230 @@
+{
+  "$schema": "../../../../node_modules/@itwin/presentation-common/Ruleset.schema.json",
+  "id": "tree-widget-react/ExternalSources",
+  "requiredSchemas": [
+    {
+      "name": "BisCore",
+      "minVersion": "1.0.13"
+    }
+  ],
+  "rules": [
+    {
+      "ruleType": "RootNodes",
+      "specifications": [
+        {
+          "specType": "InstanceNodesOfSpecificClasses",
+          "classes": [
+            {
+              "schemaName": "BisCore",
+              "classNames": [
+                "ExternalSource"
+              ],
+              "arePolymorphic": false
+            }
+          ],
+          "relatedInstances": [
+            {
+              "relationshipPath": [
+                {
+                  "relationship": {
+                    "schemaName": "BisCore",
+                    "className": "SynchronizationConfigSpecifiesRootSources"
+                  },
+                  "direction": "Backward"
+                }
+              ],
+              "isRequired": true,
+              "alias": "configRoot"
+            },
+            {
+              "relationshipPath": [
+                {
+                  "relationship": {
+                    "schemaName": "BisCore",
+                    "className": "ExternalSourceIsInRepository"
+                  },
+                  "direction": "Forward"
+                }
+              ],
+              "isRequired": true,
+              "alias": "repo"
+            }
+          ],
+          "instanceFilter": "configRoot.ECInstanceId <> NULL",
+          "groupByClass": false,
+          "groupByLabel": false
+        }
+      ],
+      "autoExpand": true
+    },
+    {
+      "ruleType": "ChildNodes",
+      "condition": "ParentNode.IsOfClass(\"ExternalSourceGroup\", \"BisCore\")",
+      "specifications": [
+        {
+          "specType": "RelatedInstanceNodes",
+          "relationshipPaths": [
+            [
+              {
+                "relationship": {
+                  "schemaName": "BisCore",
+                  "className": "ExternalSourceGroupGroupsSources"
+                },
+                "direction": "Forward"
+              }
+            ]
+          ],
+          "groupByClass": false,
+          "groupByLabel": false
+        }
+      ]
+    },
+    {
+      "ruleType": "ChildNodes",
+      "condition": "ParentNode.IsOfClass(\"ExternalSource\", \"BisCore\")",
+      "specifications": [
+        {
+          "specType": "RelatedInstanceNodes",
+          "relationshipPaths": [
+            [
+              {
+                "relationship": {
+                  "schemaName": "BisCore",
+                  "className": "ExternalSourceOwnsAttachments"
+                },
+                "direction": "Forward"
+              },
+              {
+                "relationship": {
+                  "schemaName": "BisCore",
+                  "className": "ExternalSourceAttachmentAttachesSource"
+                },
+                "direction": "Forward"
+              }
+            ]
+          ],
+          "groupByClass": false,
+          "groupByLabel": false
+        },
+        {
+          "specType": "CustomNode",
+          "type": "T_ExternalSource_Elements",
+          "label": "Elements",
+          "hideIfNoChildren": true,
+          "nestedRules": [
+            {
+              "ruleType": "ChildNodes",
+              "specifications": [
+                {
+                  "specType": "RelatedInstanceNodes",
+                  "relationshipPaths": [
+                    [
+                      {
+                        "relationship": {
+                          "schemaName": "BisCore",
+                          "className": "ElementIsFromSource"
+                        },
+                        "direction": "Backward",
+                        "targetClass": {
+                          "schemaName": "BisCore",
+                          "className": "ExternalSourceAspect"
+                        }
+                      },
+                      {
+                        "relationship": {
+                          "schemaName": "BisCore",
+                          "className": "ElementOwnsMultiAspects"
+                        },
+                        "direction": "Backward",
+                        "targetClass": {
+                          "schemaName": "BisCore",
+                          "className": "GeometricElement"
+                        }
+                      }
+                    ]
+                  ],
+                  "groupByClass": true,
+                  "groupByLabel": false
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "ruleType": "InstanceLabelOverride",
+      "class": {
+        "schemaName": "BisCore",
+        "className": "RepositoryLink"
+      },
+      "values": [
+        {
+          "specType": "Property",
+          "propertyName": "UserLabel"
+        }
+      ]
+    },
+    {
+      "ruleType": "InstanceLabelOverride",
+      "class": {
+        "schemaName": "BisCore",
+        "className": "ExternalSource"
+      },
+      "values": [
+        {
+          "specType": "Composite",
+          "separator": " - ",
+          "parts": [
+            {
+              "spec": {
+                "specType": "RelatedInstanceLabel",
+                "pathToRelatedInstance": {
+                  "relationship": {
+                    "schemaName": "BisCore",
+                    "className": "ExternalSourceIsInRepository"
+                  },
+                  "direction": "Forward"
+                }
+              }
+            },
+            {
+              "spec": {
+                "specType": "Property",
+                "propertyName": "UserLabel"
+              }
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "ruleType": "ExtendedData",
+      "condition": "ThisNode.IsInstanceNode ANDALSO this.IsOfClass(\"ExternalSource\", \"BisCore\")",
+      "items": {
+        "imageId": "\"icon-document\""
+      }
+    },
+    {
+      "ruleType": "ExtendedData",
+      "condition": "ThisNode.Type = \"T_ExternalSource_Elements\"",
+      "items": {
+        "imageId": "\"icon-ec-schema\""
+      }
+    },
+    {
+      "ruleType": "ExtendedData",
+      "condition": "ThisNode.IsClassGroupingNode",
+      "items": {
+        "imageId": "\"icon-ec-class\""
+      }
+    },
+    {
+      "ruleType": "ExtendedData",
+      "condition": "ThisNode.IsInstanceNode ANDALSO ThisNode.IsOfClass(\"GeometricElement\", \"BisCore\")",
+      "items": {
+        "imageId": "\"icon-item\""
+      }
+    }
+  ]
+}

package/lib/esm/components/trees/external-sources-tree/ExternalSourcesTree.d.ts

@@ -0,0 +1,27 @@
+/// <reference types="react" />
+import "../VisibilityTreeBase.scss";
+import type { IModelConnection } from "@itwin/core-frontend";
+import type { Ruleset } from "@itwin/presentation-common";
+/**
+ * Presentation rules used by ControlledCategoriesTree
+ * @internal
+ */
+export declare const RULESET_EXTERNAL_SOURCES: Ruleset;
+/**
+ * Props for the [[ExternalSourcesTree]] component
+ * @alpha
+ */
+export interface ExternalSourcesTreeProps {
+    /** An IModel to pull data from */
+    iModel: IModelConnection;
+    /** Width of the component */
+    width: number;
+    /** Height of the component */
+    height: number;
+}
+/**
+ * Tree which displays a hierarchy of ExternalSources and their elements.
+ * @alpha
+ */
+export declare function ExternalSourcesTree(props: ExternalSourcesTreeProps): JSX.Element;
+//# sourceMappingURL=ExternalSourcesTree.d.ts.map

package/lib/esm/components/trees/external-sources-tree/ExternalSourcesTree.js

@@ -0,0 +1,34 @@
+import { jsx as _jsx } from "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.
+*--------------------------------------------------------------------------------------------*/
+import "../VisibilityTreeBase.scss";
+import { ControlledTree, SelectionMode, useTreeModel } from "@itwin/components-react";
+import { usePresentationTreeNodeLoader, useUnifiedSelectionTreeEventHandler } from "@itwin/presentation-components";
+import * as RULESET_EXTERNAL_SOURCES_IMPORT from "./ExternalSources.json";
+/**
+ * Presentation rules used by ControlledCategoriesTree
+ * @internal
+ */
+export const RULESET_EXTERNAL_SOURCES = RULESET_EXTERNAL_SOURCES_IMPORT;
+const PAGING_SIZE = 20;
+/**
+ * Tree which displays a hierarchy of ExternalSources and their elements.
+ * @alpha
+ */
+export function ExternalSourcesTree(props) {
+    const { nodeLoader } = usePresentationTreeNodeLoader({
+        imodel: props.iModel,
+        ruleset: RULESET_EXTERNAL_SOURCES,
+        pagingSize: PAGING_SIZE,
+        customizeTreeNodeItem,
+    });
+    const eventsHandler = useUnifiedSelectionTreeEventHandler({ nodeLoader });
+    const treeModel = useTreeModel(nodeLoader.modelSource);
+    return (_jsx("div", { className: "tree-widget-visibility-tree-base", children: _jsx(ControlledTree, { nodeLoader: nodeLoader, model: treeModel, selectionMode: SelectionMode.Extended, eventsHandler: eventsHandler, width: props.width, height: props.height, iconsEnabled: true }) }));
+}
+function customizeTreeNodeItem(item, node) {
+    item.icon = node.extendedData?.imageId;
+}
+//# sourceMappingURL=ExternalSourcesTree.js.map

package/lib/esm/components/trees/external-sources-tree/ExternalSourcesTree.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExternalSourcesTree.js","sourceRoot":"","sources":["../../../../../src/components/trees/external-sources-tree/ExternalSourcesTree.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAE/F,OAAO,4BAA4B,CAAC;AACpC,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACtF,OAAO,EAAE,6BAA6B,EAAE,mCAAmC,EAAE,MAAM,gCAAgC,CAAC;AACpH,OAAO,KAAK,+BAA+B,MAAM,wBAAwB,CAAC;AAM1E;;;GAGG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,+BAA0C,CAAC;AAEnF,MAAM,WAAW,GAAG,EAAE,CAAC;AAevB;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAA+B;IACjE,MAAM,EAAE,UAAU,EAAE,GAAG,6BAA6B,CAAC;QACnD,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,OAAO,EAAE,wBAAwB;QACjC,UAAU,EAAE,WAAW;QACvB,qBAAqB;KACtB,CAAC,CAAC;IACH,MAAM,aAAa,GAAG,mCAAmC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;IAC1E,MAAM,SAAS,GAAG,YAAY,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IACvD,OAAO,CACL,cAAK,SAAS,EAAC,kCAAkC,YAC/C,KAAC,cAAc,IACb,UAAU,EAAE,UAAU,EACtB,KAAK,EAAE,SAAS,EAChB,aAAa,EAAE,aAAa,CAAC,QAAQ,EACrC,aAAa,EAAE,aAAa,EAC5B,KAAK,EAAE,KAAK,CAAC,KAAK,EAClB,MAAM,EAAE,KAAK,CAAC,MAAM,EACpB,YAAY,EAAE,IAAI,GAClB,GACE,CACP,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,IAAsC,EAAE,IAAmB;IACxF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC;AACzC,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 { ControlledTree, SelectionMode, useTreeModel } from \"@itwin/components-react\";\nimport { usePresentationTreeNodeLoader, useUnifiedSelectionTreeEventHandler } from \"@itwin/presentation-components\";\nimport * as RULESET_EXTERNAL_SOURCES_IMPORT from \"./ExternalSources.json\";\n\nimport type { DelayLoadedTreeNodeItem } from \"@itwin/components-react\";\nimport type { IModelConnection } from \"@itwin/core-frontend\";\nimport type { Node, Ruleset } from \"@itwin/presentation-common\";\n\n/**\n * Presentation rules used by ControlledCategoriesTree\n * @internal\n */\nexport const RULESET_EXTERNAL_SOURCES = RULESET_EXTERNAL_SOURCES_IMPORT as Ruleset;\n\nconst PAGING_SIZE = 20;\n\n/**\n * Props for the [[ExternalSourcesTree]] component\n * @alpha\n */\nexport interface ExternalSourcesTreeProps {\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}\n\n/**\n * Tree which displays a hierarchy of ExternalSources and their elements.\n * @alpha\n */\nexport function ExternalSourcesTree(props: ExternalSourcesTreeProps) {\n  const { nodeLoader } = usePresentationTreeNodeLoader({\n    imodel: props.iModel,\n    ruleset: RULESET_EXTERNAL_SOURCES,\n    pagingSize: PAGING_SIZE,\n    customizeTreeNodeItem,\n  });\n  const eventsHandler = useUnifiedSelectionTreeEventHandler({ nodeLoader });\n  const treeModel = useTreeModel(nodeLoader.modelSource);\n  return (\n    <div className=\"tree-widget-visibility-tree-base\">\n      <ControlledTree\n        nodeLoader={nodeLoader}\n        model={treeModel}\n        selectionMode={SelectionMode.Extended}\n        eventsHandler={eventsHandler}\n        width={props.width}\n        height={props.height}\n        iconsEnabled={true}\n      />\n    </div>\n  );\n}\n\nfunction customizeTreeNodeItem(item: Partial<DelayLoadedTreeNodeItem>, node: Partial<Node>) {\n  item.icon = node.extendedData?.imageId;\n}\n"]}

package/lib/esm/components/trees/external-sources-tree/ExternalSourcesTreeComponent.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="react" />
+import "../VisibilityTreeBase.scss";
+/**
+ * A component that displays an External Sources tree and any necessary "chrome".
+ * @alpha
+ */
+export declare const ExternalSourcesTreeComponent: {
+    (props: {}): JSX.Element | null;
+    /**
+     * Id of the component. May be used when a creating a [[TreeDefinition]] for [[ExternalSourcesTreeComponent]].
+     * @alpha
+     */
+    id: string;
+    /**
+     * Label of the component. May be used when a creating a [[TreeDefinition]] for [[ExternalSourcesTreeComponent]].
+     * @alpha
+     */
+    getLabel(): string;
+};
+//# sourceMappingURL=ExternalSourcesTreeComponent.d.ts.map

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

@@ -0,0 +1,35 @@
+import { jsx as _jsx } from "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.
+*--------------------------------------------------------------------------------------------*/
+import "../VisibilityTreeBase.scss";
+import { useActiveIModelConnection } from "@itwin/appui-react";
+import { TreeWidget } from "../../../TreeWidget";
+import { AutoSizer } from "../../utils/AutoSizer";
+import { ExternalSourcesTree } from "./ExternalSourcesTree";
+/**
+ * A component that displays an External Sources tree and any necessary "chrome".
+ * @alpha
+ */
+export const ExternalSourcesTreeComponent = (props) => {
+    const iModel = useActiveIModelConnection();
+    if (!iModel) {
+        return null;
+    }
+    return (_jsx(ExternalSourcesTreeComponentImpl, { ...props, iModel: iModel }));
+};
+function ExternalSourcesTreeComponentImpl(props) {
+    return (_jsx(AutoSizer, { children: ({ width, height }) => (_jsx(ExternalSourcesTree, { ...props, width: width, height: height })) }));
+}
+/**
+ * Id of the component. May be used when a creating a [[TreeDefinition]] for [[ExternalSourcesTreeComponent]].
+ * @alpha
+ */
+ExternalSourcesTreeComponent.id = "external-sources-tree";
+/**
+ * Label of the component. May be used when a creating a [[TreeDefinition]] for [[ExternalSourcesTreeComponent]].
+ * @alpha
+ */
+ExternalSourcesTreeComponent.getLabel = () => TreeWidget.translate("externalSources");
+//# sourceMappingURL=ExternalSourcesTreeComponent.js.map

package/lib/esm/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,OAAO,4BAA4B,CAAC;AACpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAI5D;;;GAGG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,KAAS,EAAE,EAAE;IACxD,MAAM,MAAM,GAAG,yBAAyB,EAAE,CAAC;IAC3C,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,IAAI,CAAC;KACb;IACD,OAAO,CACL,KAAC,gCAAgC,OAAK,KAAK,EAAE,MAAM,EAAE,MAAM,GAAI,CAChE,CAAC;AACJ,CAAC,CAAC;AAEF,SAAS,gCAAgC,CAAC,KAAmC;IAC3E,OAAO,CACL,KAAC,SAAS,cACP,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CACtB,KAAC,mBAAmB,OACd,KAAK,EACT,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,MAAM,GACd,CACH,GACS,CACb,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,4BAA4B,CAAC,EAAE,GAAG,uBAAuB,CAAC;AAE1D;;;GAGG;AACH,4BAA4B,CAAC,QAAQ,GAAG,GAAG,EAAE,CAAC,UAAU,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/esm/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/esm/components/trees/imodel-content-tree/IModelContentTree.js

@@ -0,0 +1,32 @@
+import { jsx as _jsx } from "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.
+*--------------------------------------------------------------------------------------------*/
+import classNames from "classnames";
+import { useMemo } from "react";
+import { ControlledTree, SelectionMode, useTreeEventsHandler, useTreeModel } from "@itwin/components-react";
+import { usePresentationTreeNodeLoader } from "@itwin/presentation-components";
+/**
+ * Presentation rules used by IModelContentTree
+ * @internal
+ */
+export const 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
+ */
+export const IModelContentTree = (props) => {
+    const { iModel, className, width, height, ...divProps } = props;
+    const { nodeLoader } = usePresentationTreeNodeLoader({
+        imodel: iModel,
+        ruleset: RULESET_IMODEL_CONTENT,
+        pagingSize: 20,
+        appendChildrenCountForGroupingNodes: true,
+    });
+    const eventHandler = useTreeEventsHandler(useMemo(() => ({ nodeLoader, modelSource: nodeLoader.modelSource }), [nodeLoader]));
+    const treeModel = useTreeModel(nodeLoader.modelSource);
+    return (_jsx("div", { ...divProps, className: classNames("imodel-content-tree", className), children: _jsx(ControlledTree, { width: width, height: height, nodeLoader: nodeLoader, selectionMode: props.selectionMode ? /* istanbul ignore next */ props.selectionMode : SelectionMode.None, eventsHandler: eventHandler, model: treeModel, iconsEnabled: true }) }));
+};
+//# sourceMappingURL=IModelContentTree.js.map

package/lib/esm/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,OAAO,UAAU,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAChC,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAC5G,OAAO,EAAE,6BAA6B,EAAE,MAAM,gCAAgC,CAAC;AAK/E;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAY,OAAO,CAAC,sBAAsB,CAAC,CAAC,CAAC,yDAAyD;AAiBzI;;;;GAIG;AACH,MAAM,CAAC,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,6BAA6B,CAAC;QACnD,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,sBAAsB;QAC/B,UAAU,EAAE,EAAE;QACd,mCAAmC,EAAE,IAAI;KAC1C,CAAC,CAAC;IACH,MAAM,YAAY,GAAG,oBAAoB,CAAC,OAAO,CAAC,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,YAAY,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IAEvD,OAAO,CACL,iBAAS,QAAQ,EAAE,SAAS,EAAE,UAAU,CAAC,qBAAqB,EAAE,SAAS,CAAC,YACxE,KAAC,cAAc,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,aAAa,CAAC,IAAI,EACxG,aAAa,EAAE,YAAY,EAC3B,KAAK,EAAE,SAAS,EAChB,YAAY,EAAE,IAAI,GAClB,GACE,CACP,CAAC;AACJ,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 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/esm/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/esm/components/trees/imodel-content-tree/IModelContentTreeComponent.js

@@ -0,0 +1,31 @@
+import { jsx as _jsx } from "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.
+*--------------------------------------------------------------------------------------------*/
+import "../VisibilityTreeBase.scss";
+import { useActiveIModelConnection } from "@itwin/appui-react";
+import { TreeWidget } from "../../../TreeWidget";
+import { AutoSizer } from "../../utils/AutoSizer";
+import { IModelContentTree } from "./IModelContentTree";
+/**
+ * A component that renders [[IModelContentTree]]
+ * @public
+ */
+export const IModelContentTreeComponent = (props) => {
+    const iModel = useActiveIModelConnection();
+    if (!iModel)
+        return null;
+    return (_jsx(AutoSizer, { children: ({ width, height }) => (_jsx(IModelContentTree, { ...props, iModel: iModel, width: width, height: height })) }));
+};
+/**
+ * Id of the component. May be used when a creating a [[TreeDefinition]] for [[TreeWidgetComponent]].
+ * @public
+ */
+IModelContentTreeComponent.id = "imodel-content-tree";
+/**
+ * Label of the component. May be used when a creating a [[TreeDefinition]] for [[TreeWidgetComponent]].
+ * @public
+ */
+IModelContentTreeComponent.getLabel = () => TreeWidget.translate("imodelContent");
+//# sourceMappingURL=IModelContentTreeComponent.js.map

package/lib/esm/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,OAAO,4BAA4B,CAAC;AACpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAUxD;;;GAGG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,KAAsC,EAAE,EAAE;IACnF,MAAM,MAAM,GAAG,yBAAyB,EAAE,CAAC;IAE3C,IAAI,CAAC,MAAM;QACT,OAAO,IAAI,CAAC;IAEd,OAAO,CACL,KAAC,SAAS,cACP,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CACtB,KAAC,iBAAiB,OACZ,KAAK,EACT,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,MAAM,GACd,CACH,GACS,CACb,CAAC;AACJ,CAAC,CAAC;AAEF;;;GAGG;AACH,0BAA0B,CAAC,EAAE,GAAG,qBAAqB,CAAC;AAEtD;;;GAGG;AACH,0BAA0B,CAAC,QAAQ,GAAG,GAAG,EAAE,CAAC,UAAU,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/esm/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/esm/components/trees/index.js

@@ -3,13 +3,17 @@
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
 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.js.map

package/lib/esm/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,cAAc,UAAU,CAAC;AACzB,cAAc,qBAAqB,CAAC;AACpC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AACzC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,yCAAyC,CAAC;AACxD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,0BAA0B,CAAC;AACzC,cAAc,mCAAmC,CAAC;AAClD,cAAc,uCAAuC,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\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,cAAc,UAAU,CAAC;AACzB,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AAEzC,cAAc,yCAAyC,CAAC;AACxD,cAAc,kDAAkD,CAAC;AAEjE,cAAc,gCAAgC,CAAC;AAC/C,cAAc,yCAAyC,CAAC;AACxD,cAAc,2CAA2C,CAAC;AAE1D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,sDAAsD,CAAC;AAErE,cAAc,0BAA0B,CAAC;AACzC,cAAc,mCAAmC,CAAC;AAClD,cAAc,uCAAuC,CAAC;AACtD,cAAc,qBAAqB,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\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/esm/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;
 }