@itwin/tree-widget-react 3.0.0-dev.0 → 3.0.0-dev.2

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

@@ -1,13 +1,11 @@
-/// <reference types="react" />
-import "../VisibilityTreeBase.scss";
+import "../Tree.scss";
+import { ModelsTree } from "./ModelsTree";
 import { HideAllButton, InvertButton, ShowAllButton, View2DButton, View3DButton } from "./ModelsTreeButtons";
-import type { ModelsTreeProps } from "./ModelsTree";
+import type { ComponentPropsWithoutRef } from "react";
+import type { SelectionStorage } from "@itwin/presentation-hierarchies-react";
 import type { ModelsTreeHeaderButtonProps } from "./ModelsTreeButtons";
-/**
- * Props for [[ModelsTreeComponent]].
- * @public
- */
-export interface ModelTreeComponentProps extends Omit<ModelsTreeProps, "iModel" | "activeView" | "width" | "height" | "filterInfo" | "onFilterApplied"> {
+type ModelsTreeProps = ComponentPropsWithoutRef<typeof ModelsTree>;
+interface ModelsTreeComponentProps extends Pick<ModelsTreeProps, "getSchemaContext" | "density" | "hierarchyLevelConfig" | "selectionMode" | "onPerformanceMeasured" | "onFeatureUsed" | "hierarchyConfig"> {
     /**
      * Renderers of header buttons. Defaults to:
      * ```ts
@@ -21,14 +19,16 @@ export interface ModelTreeComponentProps extends Omit<ModelsTreeProps, "iModel"
      * ```
      */
     headerButtons?: Array<(props: ModelsTreeHeaderButtonProps) => React.ReactNode>;
+    selectionStorage: SelectionStorage;
 }
 /**
- * A component that renders [[ModelsTree]] and a header with filtering capabilities
+ * A component that renders `ModelsTree` and a header with filtering capabilities
  * and header buttons.
+ *
  * @public
  */
 export declare const ModelsTreeComponent: {
-    (props: ModelTreeComponentProps): JSX.Element | null;
+    (props: ModelsTreeComponentProps): JSX.Element | null;
     /**
      * Renders a "Show all" button that enables display of all models.
      * @public
@@ -55,14 +55,15 @@ export declare const ModelsTreeComponent: {
      */
     View3DButton: typeof View3DButton;
     /**
-     * Id of the component. May be used when a creating a [[TreeDefinition]] for [[SelectableTree]].
+     * Id of the component. May be used when a creating a `TreeDefinition` for `SelectableTree`.
      * @public
      */
     id: string;
     /**
-     * Label of the component. May be used when a creating a [[TreeDefinition]] for [[SelectableTree]].
+     * Label of the component. May be used when a creating a `TreeDefinition` for `SelectableTree`.
      * @public
      */
     getLabel(): string;
 };
+export {};
 //# sourceMappingURL=ModelsTreeComponent.d.ts.map

package/lib/esm/components/trees/models-tree/ModelsTreeComponent.js

@@ -3,19 +3,25 @@ import { jsx as _jsx, jsxs as _jsxs } 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 "../Tree.scss";
 import classNames from "classnames";
-import { Fragment, useMemo } from "react";
+import { Fragment } from "react";
 import { useActiveIModelConnection, useActiveViewport } from "@itwin/appui-react";
+import { SvgCursorClick } from "@itwin/itwinui-icons-react";
+import { IconButton } from "@itwin/itwinui-react";
+import { UnifiedSelectionProvider } from "@itwin/presentation-hierarchies-react";
 import { TreeWidget } from "../../../TreeWidget";
 import { TreeHeader } from "../../tree-header/TreeHeader";
-import { useTreeFilteringState } from "../../TreeFilteringState";
 import { AutoSizer } from "../../utils/AutoSizer";
+import { useFocusedInstancesContext } from "../common/FocusedInstancesContext";
+import { FocusedInstancesContextProvider } from "../common/FocusedInstancesContextProvider";
+import { useFiltering } from "../common/UseFiltering";
 import { ModelsTree } from "./ModelsTree";
 import { HideAllButton, InvertButton, ShowAllButton, useAvailableModels, View2DButton, View3DButton } from "./ModelsTreeButtons";
 /**
- * A component that renders [[ModelsTree]] and a header with filtering capabilities
+ * A component that renders `ModelsTree` and a header with filtering capabilities
  * and header buttons.
+ *
  * @public
  */
 export const ModelsTreeComponent = (props) => {
@@ -52,35 +58,38 @@ ModelsTreeComponent.View2DButton = View2DButton;
  */
 ModelsTreeComponent.View3DButton = View3DButton;
 /**
- * Id of the component. May be used when a creating a [[TreeDefinition]] for [[SelectableTree]].
+ * Id of the component. May be used when a creating a `TreeDefinition` for `SelectableTree`.
  * @public
  */
-ModelsTreeComponent.id = "models-tree";
+ModelsTreeComponent.id = "models-tree-v2";
 /**
- * Label of the component. May be used when a creating a [[TreeDefinition]] for [[SelectableTree]].
+ * Label of the component. May be used when a creating a `TreeDefinition` for `SelectableTree`.
  * @public
  */
-ModelsTreeComponent.getLabel = () => TreeWidget.translate("models");
-function ModelsTreeComponentImpl({ iModel, viewport, headerButtons, ...treeProps }) {
+ModelsTreeComponent.getLabel = () => TreeWidget.translate("modelsTree.label");
+function ModelsTreeComponentImpl({ iModel, viewport, headerButtons, selectionStorage, ...treeProps }) {
     const availableModels = useAvailableModels(iModel);
+    const { filter, applyFilter, clearFilter } = useFiltering();
     const density = treeProps.density;
-    const { searchOptions, filterString, onFilterApplied } = useTreeFilteringState();
-    const contentClassName = classNames("tree-widget-tree-content", density === "enlarged" && "enlarge");
-    const filterInfo = useMemo(() => ({ filter: filterString, activeMatchIndex: searchOptions.activeMatchIndex }), [filterString, searchOptions.activeMatchIndex]);
-    // istanbul ignore next
-    const onModelsTreeFeatureUsed = (feature) => {
-        if (treeProps.onFeatureUsed) {
-            treeProps.onFeatureUsed(`${ModelsTreeComponent.id}-${feature}`);
-        }
-    };
-    return (_jsxs("div", { className: "tree-widget-tree-with-header", children: [_jsx(TreeHeader, { onFilterClear: searchOptions.onFilterCancel, onFilterStart: searchOptions.onFilterStart, onSelectedChanged: searchOptions.onResultSelectedChanged, resultCount: searchOptions.matchedResultCount, selectedIndex: searchOptions.activeMatchIndex, density: density, children: headerButtons
-                    ? headerButtons.map((btn, index) => (_jsx(Fragment, { children: btn({ viewport, models: availableModels, density: treeProps.density, onFeatureUsed: onModelsTreeFeatureUsed }) }, index)))
-                    : [
-                        _jsx(ShowAllButton, { viewport: viewport, models: availableModels, density: treeProps.density, onFeatureUsed: onModelsTreeFeatureUsed }, "show-all-btn"),
-                        _jsx(HideAllButton, { viewport: viewport, models: availableModels, density: treeProps.density, onFeatureUsed: onModelsTreeFeatureUsed }, "hide-all-btn"),
-                        _jsx(InvertButton, { viewport: viewport, models: availableModels, density: treeProps.density, onFeatureUsed: onModelsTreeFeatureUsed }, "invert-all-btn"),
-                        _jsx(View2DButton, { viewport: viewport, models: availableModels, density: treeProps.density, onFeatureUsed: onModelsTreeFeatureUsed }, "view-2d-btn"),
-                        _jsx(View3DButton, { viewport: viewport, models: availableModels, density: treeProps.density, onFeatureUsed: onModelsTreeFeatureUsed }, "view-3d-btn"),
-                    ] }), _jsx("div", { className: contentClassName, children: _jsx(AutoSizer, { children: ({ width, height }) => (_jsx(ModelsTree, { ...treeProps, iModel: iModel, activeView: viewport, width: width, height: height, filterInfo: filterInfo, onFilterApplied: onFilterApplied })) }) })] }));
+    return (_jsx("div", { className: classNames("tw-tree-with-header", density === "enlarged" && "enlarge"), children: _jsx(UnifiedSelectionProvider, { storage: selectionStorage, children: _jsxs(FocusedInstancesContextProvider, { selectionStorage: selectionStorage, imodelKey: iModel.key, children: [_jsx(TreeHeader, { onFilterStart: applyFilter, onFilterClear: clearFilter, onSelectedChanged: () => { }, density: density, children: headerButtons
+                            ? headerButtons.map((btn, index) => (_jsx(Fragment, { children: btn({ viewport, models: availableModels, onFeatureUsed: treeProps.onFeatureUsed }) }, index)))
+                            : [
+                                _jsx(ShowAllButton, { viewport: viewport, models: availableModels, density: density, onFeatureUsed: treeProps.onFeatureUsed }, "show-all-btn"),
+                                _jsx(HideAllButton, { viewport: viewport, models: availableModels, density: density, onFeatureUsed: treeProps.onFeatureUsed }, "hide-all-btn"),
+                                _jsx(InvertButton, { viewport: viewport, models: availableModels, density: density, onFeatureUsed: treeProps.onFeatureUsed }, "invert-all-btn"),
+                                _jsx(View2DButton, { viewport: viewport, models: availableModels, density: density, onFeatureUsed: treeProps.onFeatureUsed }, "view-2d-btn"),
+                                _jsx(View3DButton, { viewport: viewport, models: availableModels, density: density, onFeatureUsed: treeProps.onFeatureUsed }, "view-3d-btn"),
+                                _jsx(ToggleInstancesFocusButton, { density: density, onFeatureUsed: treeProps.onFeatureUsed }, "toggle-instances-focus-btn"),
+                            ] }), _jsx("div", { className: "tw-tree-content", children: _jsx(AutoSizer, { children: ({ width, height }) => _jsx(ModelsTree, { ...treeProps, imodel: iModel, activeView: viewport, width: width, height: height, filter: filter }) }) })] }) }) }));
+}
+function ToggleInstancesFocusButton({ density, onFeatureUsed }) {
+    const { enabled, toggle } = useFocusedInstancesContext();
+    const title = enabled
+        ? TreeWidget.translate("modelsTree.buttons.toggleFocusMode.disable.tooltip")
+        : TreeWidget.translate("modelsTree.buttons.toggleFocusMode.enable.tooltip");
+    return (_jsx(IconButton, { styleType: "borderless", size: density === "enlarged" ? "large" : "small", title: title, onClick: () => {
+            onFeatureUsed?.("models-tree-instancesfocus");
+            toggle();
+        }, isActive: enabled, children: _jsx(SvgCursorClick, {}) }));
 }
 //# sourceMappingURL=ModelsTreeComponent.js.map

package/lib/esm/components/trees/models-tree/ModelsTreeComponent.js.map

@@ -1 +1 @@
-{"version":3,"file":"ModelsTreeComponent.js","sourceRoot":"","sources":["../../../../../src/components/trees/models-tree/ModelsTreeComponent.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAEhG,OAAO,4BAA4B,CAAC;AACpC,OAAO,UAAU,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAC1C,OAAO,EAAE,yBAAyB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAClF,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,aAAa,EAAE,kBAAkB,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AA0BjI;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,KAA8B,EAAE,EAAE;IACpE,MAAM,MAAM,GAAG,yBAAyB,EAAE,CAAC;IAC3C,MAAM,QAAQ,GAAG,iBAAiB,EAAE,CAAC;IAErC,IAAI,CAAC,MAAM,IAAI,CAAC,QAAQ,EAAE;QACxB,OAAO,IAAI,CAAC;KACb;IAED,OAAO,KAAC,uBAAuB,OAAK,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAI,CAAC;AACpF,CAAC,CAAC;AAEF;;;GAGG;AACH,mBAAmB,CAAC,aAAa,GAAG,aAAa,CAAC;AAElD;;;GAGG;AACH,mBAAmB,CAAC,aAAa,GAAG,aAAa,CAAC;AAElD;;;GAGG;AACH,mBAAmB,CAAC,YAAY,GAAG,YAAY,CAAC;AAEhD;;;GAGG;AACH,mBAAmB,CAAC,YAAY,GAAG,YAAY,CAAC;AAEhD;;;GAGG;AACH,mBAAmB,CAAC,YAAY,GAAG,YAAY,CAAC;AAEhD;;;GAGG;AACH,mBAAmB,CAAC,EAAE,GAAG,aAAa,CAAC;AAEvC;;;GAGG;AACH,mBAAmB,CAAC,QAAQ,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;AAEpE,SAAS,uBAAuB,CAAC,EAC/B,MAAM,EACN,QAAQ,EACR,aAAa,EACb,GAAG,SAAS,EACqE;IACjF,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;IACnD,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC;IAClC,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,eAAe,EAAE,GAAG,qBAAqB,EAAE,CAAC;IACjF,MAAM,gBAAgB,GAAG,UAAU,CAAC,0BAA0B,EAAE,OAAO,KAAK,UAAU,IAAI,SAAS,CAAC,CAAC;IAErG,MAAM,UAAU,GAAG,OAAO,CACxB,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,gBAAgB,EAAE,aAAa,CAAC,gBAAgB,EAAE,CAAC,EAClF,CAAC,YAAY,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAC/C,CAAC;IAEF,uBAAuB;IACvB,MAAM,uBAAuB,GAAG,CAAC,OAAe,EAAE,EAAE;QAClD,IAAI,SAAS,CAAC,aAAa,EAAE;YAC3B,SAAS,CAAC,aAAa,CAAC,GAAG,mBAAmB,CAAC,EAAE,IAAI,OAAO,EAAE,CAAC,CAAC;SACjE;IACH,CAAC,CAAC;IAEF,OAAO,CACL,eAAK,SAAS,EAAC,8BAA8B,aAC3C,KAAC,UAAU,IACT,aAAa,EAAE,aAAa,CAAC,cAAc,EAC3C,aAAa,EAAE,aAAa,CAAC,aAAa,EAC1C,iBAAiB,EAAE,aAAa,CAAC,uBAAuB,EACxD,WAAW,EAAE,aAAa,CAAC,kBAAkB,EAC7C,aAAa,EAAE,aAAa,CAAC,gBAAgB,EAC7C,OAAO,EAAE,OAAO,YAEf,aAAa;oBACZ,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAChC,KAAC,QAAQ,cAAc,GAAG,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,EAAE,aAAa,EAAE,uBAAuB,EAAE,CAAC,IAAtH,KAAK,CAA6H,CAClJ,CAAC;oBACJ,CAAC,CAAC;wBACE,KAAC,aAAa,IACZ,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,eAAe,EAEvB,OAAO,EAAE,SAAS,CAAC,OAAO,EAC1B,aAAa,EAAE,uBAAuB,IAFlC,cAAc,CAGlB;wBACF,KAAC,aAAa,IACZ,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,eAAe,EAEvB,OAAO,EAAE,SAAS,CAAC,OAAO,EAC1B,aAAa,EAAE,uBAAuB,IAFlC,cAAc,CAGlB;wBACF,KAAC,YAAY,IACX,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,eAAe,EAEvB,OAAO,EAAE,SAAS,CAAC,OAAO,EAC1B,aAAa,EAAE,uBAAuB,IAFlC,gBAAgB,CAGpB;wBACF,KAAC,YAAY,IACX,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,eAAe,EAEvB,OAAO,EAAE,SAAS,CAAC,OAAO,EAC1B,aAAa,EAAE,uBAAuB,IAFlC,aAAa,CAGjB;wBACF,KAAC,YAAY,IACX,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,eAAe,EAEvB,OAAO,EAAE,SAAS,CAAC,OAAO,EAC1B,aAAa,EAAE,uBAAuB,IAFlC,aAAa,CAGjB;qBACH,GACM,EACb,cAAK,SAAS,EAAE,gBAAgB,YAC9B,KAAC,SAAS,cACP,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CACtB,KAAC,UAAU,OACL,SAAS,EACb,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,QAAQ,EACpB,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,UAAU,EACtB,eAAe,EAAE,eAAe,GAChC,CACH,GACS,GACR,IACF,CACP,CAAC;AACJ,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 classNames from \"classnames\";\nimport { Fragment, useMemo } from \"react\";\nimport { useActiveIModelConnection, useActiveViewport } from \"@itwin/appui-react\";\nimport { TreeWidget } from \"../../../TreeWidget\";\nimport { TreeHeader } from \"../../tree-header/TreeHeader\";\nimport { useTreeFilteringState } from \"../../TreeFilteringState\";\nimport { AutoSizer } from \"../../utils/AutoSizer\";\nimport { ModelsTree } from \"./ModelsTree\";\nimport { HideAllButton, InvertButton, ShowAllButton, useAvailableModels, View2DButton, View3DButton } from \"./ModelsTreeButtons\";\n\nimport type { ModelsTreeProps } from \"./ModelsTree\";\nimport type { IModelConnection, ScreenViewport } from \"@itwin/core-frontend\";\nimport type { ModelsTreeHeaderButtonProps } from \"./ModelsTreeButtons\";\n\n/**\n * Props for [[ModelsTreeComponent]].\n * @public\n */\nexport interface ModelTreeComponentProps extends Omit<ModelsTreeProps, \"iModel\" | \"activeView\" | \"width\" | \"height\" | \"filterInfo\" | \"onFilterApplied\"> {\n  /**\n   * Renderers of header buttons. Defaults to:\n   * ```ts\n   * [\n   *   ModelsTreeComponent.ShowAllButton,\n   *   ModelsTreeComponent.HideAllButton,\n   *   ModelsTreeComponent.InvertButton,\n   *   ModelsTreeComponent.View2DButton,\n   *   ModelsTreeComponent.View3DButton,\n   * ]\n   * ```\n   */\n  headerButtons?: Array<(props: ModelsTreeHeaderButtonProps) => React.ReactNode>;\n}\n\n/**\n * A component that renders [[ModelsTree]] and a header with filtering capabilities\n * and header buttons.\n * @public\n */\nexport const ModelsTreeComponent = (props: ModelTreeComponentProps) => {\n  const iModel = useActiveIModelConnection();\n  const viewport = useActiveViewport();\n\n  if (!iModel || !viewport) {\n    return null;\n  }\n\n  return <ModelsTreeComponentImpl {...props} iModel={iModel} viewport={viewport} />;\n};\n\n/**\n * Renders a \"Show all\" button that enables display of all models.\n * @public\n */\nModelsTreeComponent.ShowAllButton = ShowAllButton;\n\n/**\n * Renders a \"Hide all\" button that disables display of all models.\n * @public\n */\nModelsTreeComponent.HideAllButton = HideAllButton;\n\n/**\n * Renders an \"Invert all\" button that inverts display of all models.\n * @public\n */\nModelsTreeComponent.InvertButton = InvertButton;\n\n/**\n * Renders a \"View 2D\" button that enables display of all plan projection models and disables all others.\n * @public\n */\nModelsTreeComponent.View2DButton = View2DButton;\n\n/**\n * Renders a \"View 3D\" button that enables display of all non-plan projection models and disables all plan projection ones.\n * @public\n */\nModelsTreeComponent.View3DButton = View3DButton;\n\n/**\n * Id of the component. May be used when a creating a [[TreeDefinition]] for [[SelectableTree]].\n * @public\n */\nModelsTreeComponent.id = \"models-tree\";\n\n/**\n * Label of the component. May be used when a creating a [[TreeDefinition]] for [[SelectableTree]].\n * @public\n */\nModelsTreeComponent.getLabel = () => TreeWidget.translate(\"models\");\n\nfunction ModelsTreeComponentImpl({\n  iModel,\n  viewport,\n  headerButtons,\n  ...treeProps\n}: ModelTreeComponentProps & { iModel: IModelConnection; viewport: ScreenViewport }) {\n  const availableModels = useAvailableModels(iModel);\n  const density = treeProps.density;\n  const { searchOptions, filterString, onFilterApplied } = useTreeFilteringState();\n  const contentClassName = classNames(\"tree-widget-tree-content\", density === \"enlarged\" && \"enlarge\");\n\n  const filterInfo = useMemo(\n    () => ({ filter: filterString, activeMatchIndex: searchOptions.activeMatchIndex }),\n    [filterString, searchOptions.activeMatchIndex],\n  );\n\n  // istanbul ignore next\n  const onModelsTreeFeatureUsed = (feature: string) => {\n    if (treeProps.onFeatureUsed) {\n      treeProps.onFeatureUsed(`${ModelsTreeComponent.id}-${feature}`);\n    }\n  };\n\n  return (\n    <div className=\"tree-widget-tree-with-header\">\n      <TreeHeader\n        onFilterClear={searchOptions.onFilterCancel}\n        onFilterStart={searchOptions.onFilterStart}\n        onSelectedChanged={searchOptions.onResultSelectedChanged}\n        resultCount={searchOptions.matchedResultCount}\n        selectedIndex={searchOptions.activeMatchIndex}\n        density={density}\n      >\n        {headerButtons\n          ? headerButtons.map((btn, index) => (\n              <Fragment key={index}>{btn({ viewport, models: availableModels, density: treeProps.density, onFeatureUsed: onModelsTreeFeatureUsed })}</Fragment>\n            ))\n          : [\n              <ShowAllButton\n                viewport={viewport}\n                models={availableModels}\n                key=\"show-all-btn\"\n                density={treeProps.density}\n                onFeatureUsed={onModelsTreeFeatureUsed}\n              />,\n              <HideAllButton\n                viewport={viewport}\n                models={availableModels}\n                key=\"hide-all-btn\"\n                density={treeProps.density}\n                onFeatureUsed={onModelsTreeFeatureUsed}\n              />,\n              <InvertButton\n                viewport={viewport}\n                models={availableModels}\n                key=\"invert-all-btn\"\n                density={treeProps.density}\n                onFeatureUsed={onModelsTreeFeatureUsed}\n              />,\n              <View2DButton\n                viewport={viewport}\n                models={availableModels}\n                key=\"view-2d-btn\"\n                density={treeProps.density}\n                onFeatureUsed={onModelsTreeFeatureUsed}\n              />,\n              <View3DButton\n                viewport={viewport}\n                models={availableModels}\n                key=\"view-3d-btn\"\n                density={treeProps.density}\n                onFeatureUsed={onModelsTreeFeatureUsed}\n              />,\n            ]}\n      </TreeHeader>\n      <div className={contentClassName}>\n        <AutoSizer>\n          {({ width, height }) => (\n            <ModelsTree\n              {...treeProps}\n              iModel={iModel}\n              activeView={viewport}\n              width={width}\n              height={height}\n              filterInfo={filterInfo}\n              onFilterApplied={onFilterApplied}\n            />\n          )}\n        </AutoSizer>\n      </div>\n    </div>\n  );\n}\n"]}
+{"version":3,"file":"ModelsTreeComponent.js","sourceRoot":"","sources":["../../../../../src/components/trees/models-tree/ModelsTreeComponent.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAEhG,OAAO,cAAc,CAAC;AACtB,OAAO,UAAU,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,EAAE,yBAAyB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAClF,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,wBAAwB,EAAE,MAAM,uCAAuC,CAAC;AACjF,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,0BAA0B,EAAE,MAAM,mCAAmC,CAAC;AAC/E,OAAO,EAAE,+BAA+B,EAAE,MAAM,2CAA2C,CAAC;AAC5F,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,aAAa,EAAE,kBAAkB,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AA8BjI;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,KAA+B,EAAE,EAAE;IACrE,MAAM,MAAM,GAAG,yBAAyB,EAAE,CAAC;IAC3C,MAAM,QAAQ,GAAG,iBAAiB,EAAE,CAAC;IAErC,IAAI,CAAC,MAAM,IAAI,CAAC,QAAQ,EAAE;QACxB,OAAO,IAAI,CAAC;KACb;IAED,OAAO,KAAC,uBAAuB,OAAK,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAI,CAAC;AACpF,CAAC,CAAC;AAEF;;;GAGG;AACH,mBAAmB,CAAC,aAAa,GAAG,aAAa,CAAC;AAElD;;;GAGG;AACH,mBAAmB,CAAC,aAAa,GAAG,aAAa,CAAC;AAElD;;;GAGG;AACH,mBAAmB,CAAC,YAAY,GAAG,YAAY,CAAC;AAEhD;;;GAGG;AACH,mBAAmB,CAAC,YAAY,GAAG,YAAY,CAAC;AAEhD;;;GAGG;AACH,mBAAmB,CAAC,YAAY,GAAG,YAAY,CAAC;AAEhD;;;GAGG;AACH,mBAAmB,CAAC,EAAE,GAAG,gBAAgB,CAAC;AAE1C;;;GAGG;AACH,mBAAmB,CAAC,QAAQ,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;AAE9E,SAAS,uBAAuB,CAAC,EAC/B,MAAM,EACN,QAAQ,EACR,aAAa,EACb,gBAAgB,EAChB,GAAG,SAAS,EACsE;IAClF,MAAM,eAAe,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;IACnD,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,YAAY,EAAE,CAAC;IAC5D,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC;IAClC,OAAO,CACL,cAAK,SAAS,EAAE,UAAU,CAAC,qBAAqB,EAAE,OAAO,KAAK,UAAU,IAAI,SAAS,CAAC,YACpF,KAAC,wBAAwB,IAAC,OAAO,EAAE,gBAAgB,YACjD,MAAC,+BAA+B,IAAC,gBAAgB,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,CAAC,GAAG,aACxF,KAAC,UAAU,IAAC,aAAa,EAAE,WAAW,EAAE,aAAa,EAAE,WAAW,EAAE,iBAAiB,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,OAAO,EAAE,OAAO,YAC9G,aAAa;4BACZ,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAChC,KAAC,QAAQ,cAAc,GAAG,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,aAAa,EAAE,SAAS,CAAC,aAAa,EAAE,CAAC,IAA1F,KAAK,CAAiG,CACtH,CAAC;4BACJ,CAAC,CAAC;gCACE,KAAC,aAAa,IAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAqB,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,SAAS,CAAC,aAAa,IAAvE,cAAc,CAA6D;gCAC3I,KAAC,aAAa,IAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAqB,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,SAAS,CAAC,aAAa,IAAvE,cAAc,CAA6D;gCAC3I,KAAC,YAAY,IAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAuB,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,SAAS,CAAC,aAAa,IAAzE,gBAAgB,CAA6D;gCAC5I,KAAC,YAAY,IAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAoB,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,SAAS,CAAC,aAAa,IAAtE,aAAa,CAA6D;gCACzI,KAAC,YAAY,IAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAoB,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,SAAS,CAAC,aAAa,IAAtE,aAAa,CAA6D;gCACzI,KAAC,0BAA0B,IAAkC,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,SAAS,CAAC,aAAa,IAArF,4BAA4B,CAA6D;6BAC1H,GACM,EACb,cAAK,SAAS,EAAC,iBAAiB,YAC9B,KAAC,SAAS,cACP,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,KAAC,UAAU,OAAK,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAI,GAC/H,GACR,IAC0B,GACT,GACvB,CACP,CAAC;AACJ,CAAC;AAED,SAAS,0BAA0B,CAAC,EAAE,OAAO,EAAE,aAAa,EAAmF;IAC7I,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,0BAA0B,EAAE,CAAC;IACzD,MAAM,KAAK,GAAG,OAAO;QACnB,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,oDAAoD,CAAC;QAC5E,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,mDAAmD,CAAC,CAAC;IAC9E,OAAO,CACL,KAAC,UAAU,IACT,SAAS,EAAC,YAAY,EACtB,IAAI,EAAE,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAChD,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,GAAG,EAAE;YACZ,aAAa,EAAE,CAAC,4BAA4B,CAAC,CAAC;YAC9C,MAAM,EAAE,CAAC;QACX,CAAC,EACD,QAAQ,EAAE,OAAO,YAEjB,KAAC,cAAc,KAAG,GACP,CACd,CAAC;AACJ,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 \"../Tree.scss\";\nimport classNames from \"classnames\";\nimport { Fragment } from \"react\";\nimport { useActiveIModelConnection, useActiveViewport } from \"@itwin/appui-react\";\nimport { SvgCursorClick } from \"@itwin/itwinui-icons-react\";\nimport { IconButton } from \"@itwin/itwinui-react\";\nimport { UnifiedSelectionProvider } from \"@itwin/presentation-hierarchies-react\";\nimport { TreeWidget } from \"../../../TreeWidget\";\nimport { TreeHeader } from \"../../tree-header/TreeHeader\";\nimport { AutoSizer } from \"../../utils/AutoSizer\";\nimport { useFocusedInstancesContext } from \"../common/FocusedInstancesContext\";\nimport { FocusedInstancesContextProvider } from \"../common/FocusedInstancesContextProvider\";\nimport { useFiltering } from \"../common/UseFiltering\";\nimport { ModelsTree } from \"./ModelsTree\";\nimport { HideAllButton, InvertButton, ShowAllButton, useAvailableModels, View2DButton, View3DButton } from \"./ModelsTreeButtons\";\n\nimport type { ComponentPropsWithoutRef } from \"react\";\nimport type { IModelConnection, ScreenViewport } from \"@itwin/core-frontend\";\nimport type { SelectionStorage } from \"@itwin/presentation-hierarchies-react\";\nimport type { ModelsTreeHeaderButtonProps } from \"./ModelsTreeButtons\";\n\ntype ModelsTreeProps = ComponentPropsWithoutRef<typeof ModelsTree>;\n\ninterface ModelsTreeComponentProps\n  extends Pick<\n    ModelsTreeProps,\n    \"getSchemaContext\" | \"density\" | \"hierarchyLevelConfig\" | \"selectionMode\" | \"onPerformanceMeasured\" | \"onFeatureUsed\" | \"hierarchyConfig\"\n  > {\n  /**\n   * Renderers of header buttons. Defaults to:\n   * ```ts\n   * [\n   *   ModelsTreeComponent.ShowAllButton,\n   *   ModelsTreeComponent.HideAllButton,\n   *   ModelsTreeComponent.InvertButton,\n   *   ModelsTreeComponent.View2DButton,\n   *   ModelsTreeComponent.View3DButton,\n   * ]\n   * ```\n   */\n  headerButtons?: Array<(props: ModelsTreeHeaderButtonProps) => React.ReactNode>;\n  selectionStorage: SelectionStorage;\n}\n\n/**\n * A component that renders `ModelsTree` and a header with filtering capabilities\n * and header buttons.\n *\n * @public\n */\nexport const ModelsTreeComponent = (props: ModelsTreeComponentProps) => {\n  const iModel = useActiveIModelConnection();\n  const viewport = useActiveViewport();\n\n  if (!iModel || !viewport) {\n    return null;\n  }\n\n  return <ModelsTreeComponentImpl {...props} iModel={iModel} viewport={viewport} />;\n};\n\n/**\n * Renders a \"Show all\" button that enables display of all models.\n * @public\n */\nModelsTreeComponent.ShowAllButton = ShowAllButton;\n\n/**\n * Renders a \"Hide all\" button that disables display of all models.\n * @public\n */\nModelsTreeComponent.HideAllButton = HideAllButton;\n\n/**\n * Renders an \"Invert all\" button that inverts display of all models.\n * @public\n */\nModelsTreeComponent.InvertButton = InvertButton;\n\n/**\n * Renders a \"View 2D\" button that enables display of all plan projection models and disables all others.\n * @public\n */\nModelsTreeComponent.View2DButton = View2DButton;\n\n/**\n * Renders a \"View 3D\" button that enables display of all non-plan projection models and disables all plan projection ones.\n * @public\n */\nModelsTreeComponent.View3DButton = View3DButton;\n\n/**\n * Id of the component. May be used when a creating a `TreeDefinition` for `SelectableTree`.\n * @public\n */\nModelsTreeComponent.id = \"models-tree-v2\";\n\n/**\n * Label of the component. May be used when a creating a `TreeDefinition` for `SelectableTree`.\n * @public\n */\nModelsTreeComponent.getLabel = () => TreeWidget.translate(\"modelsTree.label\");\n\nfunction ModelsTreeComponentImpl({\n  iModel,\n  viewport,\n  headerButtons,\n  selectionStorage,\n  ...treeProps\n}: ModelsTreeComponentProps & { iModel: IModelConnection; viewport: ScreenViewport }) {\n  const availableModels = useAvailableModels(iModel);\n  const { filter, applyFilter, clearFilter } = useFiltering();\n  const density = treeProps.density;\n  return (\n    <div className={classNames(\"tw-tree-with-header\", density === \"enlarged\" && \"enlarge\")}>\n      <UnifiedSelectionProvider storage={selectionStorage}>\n        <FocusedInstancesContextProvider selectionStorage={selectionStorage} imodelKey={iModel.key}>\n          <TreeHeader onFilterStart={applyFilter} onFilterClear={clearFilter} onSelectedChanged={() => {}} density={density}>\n            {headerButtons\n              ? headerButtons.map((btn, index) => (\n                  <Fragment key={index}>{btn({ viewport, models: availableModels, onFeatureUsed: treeProps.onFeatureUsed })}</Fragment>\n                ))\n              : [\n                  <ShowAllButton viewport={viewport} models={availableModels} key=\"show-all-btn\" density={density} onFeatureUsed={treeProps.onFeatureUsed} />,\n                  <HideAllButton viewport={viewport} models={availableModels} key=\"hide-all-btn\" density={density} onFeatureUsed={treeProps.onFeatureUsed} />,\n                  <InvertButton viewport={viewport} models={availableModels} key=\"invert-all-btn\" density={density} onFeatureUsed={treeProps.onFeatureUsed} />,\n                  <View2DButton viewport={viewport} models={availableModels} key=\"view-2d-btn\" density={density} onFeatureUsed={treeProps.onFeatureUsed} />,\n                  <View3DButton viewport={viewport} models={availableModels} key=\"view-3d-btn\" density={density} onFeatureUsed={treeProps.onFeatureUsed} />,\n                  <ToggleInstancesFocusButton key=\"toggle-instances-focus-btn\" density={density} onFeatureUsed={treeProps.onFeatureUsed} />,\n                ]}\n          </TreeHeader>\n          <div className=\"tw-tree-content\">\n            <AutoSizer>\n              {({ width, height }) => <ModelsTree {...treeProps} imodel={iModel} activeView={viewport} width={width} height={height} filter={filter} />}\n            </AutoSizer>\n          </div>\n        </FocusedInstancesContextProvider>\n      </UnifiedSelectionProvider>\n    </div>\n  );\n}\n\nfunction ToggleInstancesFocusButton({ density, onFeatureUsed }: { density?: \"default\" | \"enlarged\"; onFeatureUsed?: (feature: string) => void }) {\n  const { enabled, toggle } = useFocusedInstancesContext();\n  const title = enabled\n    ? TreeWidget.translate(\"modelsTree.buttons.toggleFocusMode.disable.tooltip\")\n    : TreeWidget.translate(\"modelsTree.buttons.toggleFocusMode.enable.tooltip\");\n  return (\n    <IconButton\n      styleType=\"borderless\"\n      size={density === \"enlarged\" ? \"large\" : \"small\"}\n      title={title}\n      onClick={() => {\n        onFeatureUsed?.(\"models-tree-instancesfocus\");\n        toggle();\n      }}\n      isActive={enabled}\n    >\n      <SvgCursorClick />\n    </IconButton>\n  );\n}\n"]}

package/lib/{cjs/components/trees/stateless → esm/components/trees}/models-tree/ModelsTreeDefinition.d.ts

@@ -1,15 +1,43 @@
+import type { Id64String } from "@itwin/core-bentley";
 import type { DefineHierarchyLevelProps, HierarchyDefinition, HierarchyLevelDefinition, HierarchyNodeIdentifiersPath, LimitingECSqlQueryExecutor, ProcessedHierarchyNode } from "@itwin/presentation-hierarchies";
-import type { ECClassHierarchyInspector, ECSchemaProvider, ECSqlQueryExecutor, InstanceKey } from "@itwin/presentation-shared";
+import type { ECClassHierarchyInspector, ECSchemaProvider, InstanceKey } from "@itwin/presentation-shared";
+import type { ModelsTreeIdsCache } from "./internal/ModelsTreeIdsCache";
+interface HierarchyConfiguration {
+    /** Should element nodes be grouped by class. Defaults to `enable`. */
+    elementClassGrouping: "enable" | "enableWithCounts" | "disable";
+    /** Full class name of a `GeometricElement3d` sub-class that should be used to load element nodes. Defaults to `BisCore.GeometricElement3d` */
+    elementClassSpecification: string;
+    /** Should models without elements be shown. Defaults to `false` */
+    showEmptyModels: boolean;
+}
+export declare const defaultHierarchyConfiguration: HierarchyConfiguration;
 interface ModelsTreeDefinitionProps {
-    imodelAccess: ECSchemaProvider & ECClassHierarchyInspector & ECSqlQueryExecutor;
+    imodelAccess: ECSchemaProvider & ECClassHierarchyInspector & LimitingECSqlQueryExecutor;
+    idsCache: ModelsTreeIdsCache;
+    hierarchyConfig: HierarchyConfiguration;
+}
+export interface ElementsGroupInfo {
+    parent: {
+        ids: Id64String[];
+        type: "element";
+    } | {
+        ids: Id64String[];
+        modelIds: Id64String[];
+        type: "category";
+    };
+    classes: string[];
 }
 interface ModelsTreeInstanceKeyPathsFromInstanceKeysProps {
     imodelAccess: ECClassHierarchyInspector & LimitingECSqlQueryExecutor;
-    keys: InstanceKey[];
+    idsCache: ModelsTreeIdsCache;
+    keys: Array<InstanceKey | ElementsGroupInfo>;
+    hierarchyConfig: HierarchyConfiguration;
 }
 interface ModelsTreeInstanceKeyPathsFromInstanceLabelProps {
     imodelAccess: ECClassHierarchyInspector & LimitingECSqlQueryExecutor;
+    idsCache: ModelsTreeIdsCache;
     label: string;
+    hierarchyConfig: HierarchyConfiguration;
 }
 export type ModelsTreeInstanceKeyPathsProps = ModelsTreeInstanceKeyPathsFromInstanceKeysProps | ModelsTreeInstanceKeyPathsFromInstanceLabelProps;
 export declare namespace ModelsTreeInstanceKeyPathsProps {
@@ -17,9 +45,12 @@ export declare namespace ModelsTreeInstanceKeyPathsProps {
 }
 export declare class ModelsTreeDefinition implements HierarchyDefinition {
     private _impl;
-    private _subjectModelIdsCache;
+    private _idsCache;
+    private _hierarchyConfig;
     private _selectQueryFactory;
     private _nodeLabelSelectClauseFactory;
+    private _queryExecutor;
+    private _isSupported?;
     constructor(props: ModelsTreeDefinitionProps);
     postProcessNode(node: ProcessedHierarchyNode): Promise<ProcessedHierarchyNode>;
     defineHierarchyLevel(props: DefineHierarchyLevelProps): Promise<HierarchyLevelDefinition>;
@@ -30,6 +61,7 @@ export declare class ModelsTreeDefinition implements HierarchyDefinition {
     private createSpatialCategoryChildrenQuery;
     private createGeometricElement3dChildrenQuery;
     static createInstanceKeyPaths(props: ModelsTreeInstanceKeyPathsProps): Promise<HierarchyNodeIdentifiersPath[]>;
+    private isSupported;
 }
 export {};
 //# sourceMappingURL=ModelsTreeDefinition.d.ts.map