@itwin/tree-widget-react 3.0.0-dev.1 → 3.0.0-dev.3

package/lib/cjs/components/trees/common/components/Tree.d.ts

@@ -0,0 +1,54 @@
+import { useSelectionHandler } from "@itwin/presentation-hierarchies-react";
+import type { ComponentPropsWithoutRef, ReactNode } from "react";
+import type { IModelConnection } from "@itwin/core-frontend";
+import type { SchemaContext } from "@itwin/ecschema-metadata";
+import type { SelectionStorage, useTree } from "@itwin/presentation-hierarchies-react";
+import type { HighlightInfo } from "../UseNodeHighlighting";
+import type { TreeRenderer } from "./TreeRenderer";
+/**
+ * Properties that are passed to `treeRenderer` from `Tree` component.
+ * @beta
+ */
+export type TreeRendererProps = Required<Pick<ComponentPropsWithoutRef<typeof TreeRenderer>, "rootNodes" | "expandNode" | "onNodeClick" | "onNodeKeyDown" | "onFilterClick" | "isNodeSelected" | "getHierarchyLevelDetails" | "size" | "getLabel">>;
+/** @beta */
+interface TreeOwnProps {
+    height: number;
+    width: number;
+    /** iModel connection that should be used to pull data from. */
+    imodel: IModelConnection;
+    /** Callback for getting `SchemaContext` for specific iModel. */
+    getSchemaContext: (imodel: IModelConnection) => SchemaContext;
+    /** Unique tree component name that will be used as unified selection change event source when selecting node. */
+    treeName: string;
+    /** Unified selection storage that should be used by tree to handle tree selection changes. */
+    selectionStorage: SelectionStorage;
+    /** Tree renderer that should be used to render tree data. */
+    treeRenderer: (treeProps: TreeRendererProps) => ReactNode;
+    /** Custom iModel access that is stored outside tree component. If not provided it new iModel access will be created using `imodel` prop. */
+    imodelAccess?: IModelAccess;
+    /** Size limit that should be applied on each hierarchy level. Default to `1000`. */
+    hierarchyLevelSizeLimit?: number;
+    /** Modifies the density of tree nodes. `enlarged` tree nodes have bigger button hit boxes. */
+    density?: "default" | "enlarged";
+    /** Message that should be renderer if there are no tree nodes. */
+    noDataMessage?: ReactNode;
+    /** Callback that this invoked when tree reloads. */
+    onReload?: () => void;
+    /** Options for highlighting node labels. */
+    highlight?: HighlightInfo;
+}
+/** @beta */
+type UseTreeProps = Parameters<typeof useTree>[0];
+/** @beta */
+type UseSelectionHandlerProps = Parameters<typeof useSelectionHandler>[0];
+/** @beta */
+type IModelAccess = UseTreeProps["imodelAccess"];
+/** @beta */
+type TreeProps = TreeOwnProps & Pick<UseTreeProps, "getFilteredPaths" | "getHierarchyDefinition"> & Pick<Partial<UseSelectionHandlerProps>, "selectionMode">;
+/**
+ * Default tree component that manages tree state and renders using supplied `treeRenderer`.
+ * @Beta
+ */
+export declare function Tree({ getSchemaContext, hierarchyLevelSizeLimit, selectionStorage, imodelAccess: providedIModelAccess, ...props }: TreeProps): JSX.Element;
+export {};
+//# sourceMappingURL=Tree.d.ts.map

package/lib/cjs/components/trees/common/components/{BaseTree.js → Tree.js}

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseTree = void 0;
+exports.Tree = void 0;
 const jsx_runtime_1 = require("react/jsx-runtime");
 /*---------------------------------------------------------------------------------------------
  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
@@ -11,48 +11,55 @@ const itwinui_react_1 = require("@itwin/itwinui-react");
 const presentation_components_1 = require("@itwin/presentation-components");
 const presentation_hierarchies_react_1 = require("@itwin/presentation-hierarchies-react");
 const TreeWidget_1 = require("../../../../TreeWidget");
-const UseFeatureReporting_1 = require("../UseFeatureReporting");
 const UseHierarchiesLocalization_1 = require("../UseHierarchiesLocalization");
 const UseHierarchyFiltering_1 = require("../UseHierarchyFiltering");
 const UseIModelChangeListener_1 = require("../UseIModelChangeListener");
 const UseNodeHighlighting_1 = require("../UseNodeHighlighting");
+const UseTelemetryContext_1 = require("../UseTelemetryContext");
 const Utils_1 = require("../Utils");
 const Delayed_1 = require("./Delayed");
 const ProgressOverlay_1 = require("./ProgressOverlay");
-const TreeRenderer_1 = require("./TreeRenderer");
-/** @internal */
-function BaseTree({ getSchemaContext, hierarchyLevelSizeLimit, imodelAccess: providedIModelAccess, ...props }) {
+/**
+ * Default tree component that manages tree state and renders using supplied `treeRenderer`.
+ * @Beta
+ */
+function Tree({ getSchemaContext, hierarchyLevelSizeLimit, selectionStorage, imodelAccess: providedIModelAccess, ...props }) {
     const defaultHierarchyLevelSizeLimit = hierarchyLevelSizeLimit ?? 1000;
     const imodelAccess = (0, react_1.useMemo)(() => {
         return providedIModelAccess ?? (0, Utils_1.createIModelAccess)({ getSchemaContext, imodel: props.imodel });
     }, [providedIModelAccess, getSchemaContext, props.imodel]);
-    return ((0, jsx_runtime_1.jsx)(presentation_components_1.SchemaMetadataContextProvider, { imodel: props.imodel, schemaContextProvider: getSchemaContext, children: (0, jsx_runtime_1.jsx)(BaseTreeRenderer, { ...props, imodelAccess: imodelAccess, defaultHierarchyLevelSizeLimit: defaultHierarchyLevelSizeLimit }) }));
+    return ((0, jsx_runtime_1.jsx)(presentation_components_1.SchemaMetadataContextProvider, { imodel: props.imodel, schemaContextProvider: getSchemaContext, children: (0, jsx_runtime_1.jsx)(presentation_hierarchies_react_1.UnifiedSelectionProvider, { storage: selectionStorage, children: (0, jsx_runtime_1.jsx)(TreeImpl, { ...props, imodelAccess: imodelAccess, defaultHierarchyLevelSizeLimit: defaultHierarchyLevelSizeLimit }) }) }));
 }
-exports.BaseTree = BaseTree;
-/** @internal */
-function BaseTreeRenderer({ imodel, imodelAccess, height, width, treeName, noDataMessage, getFilteredPaths, defaultHierarchyLevelSizeLimit, getHierarchyDefinition, selectionMode, onPerformanceMeasured, reportUsage, treeRenderer, density, getIcon, getSublabel, onNodeDoubleClick, searchText, }) {
+exports.Tree = Tree;
+function TreeImpl({ imodel, imodelAccess, height, width, treeName, noDataMessage, getFilteredPaths, defaultHierarchyLevelSizeLimit, getHierarchyDefinition, selectionMode, onReload, treeRenderer, density, highlight, }) {
     const localizedStrings = (0, UseHierarchiesLocalization_1.useHierarchiesLocalization)();
-    const { rootNodes, isLoading, reloadTree, selectNodes, setFormatter: _setFormatter, expandNode, ...treeProps } = (0, presentation_hierarchies_react_1.useUnifiedSelectionTree)({
+    const { onFeatureUsed, onPerformanceMeasured } = (0, UseTelemetryContext_1.useTelemetryContext)();
+    const { rootNodes, isLoading, selectNodes, setFormatter: _setFormatter, expandNode, ...treeProps } = (0, presentation_hierarchies_react_1.useUnifiedSelectionTree)({
         imodelAccess,
         getHierarchyDefinition,
         getFilteredPaths,
         imodelKey: imodel.key,
         sourceName: treeName,
         localizedStrings,
-        onPerformanceMeasured,
-        onHierarchyLimitExceeded: () => reportUsage?.({ featureId: "hierarchy-level-size-limit-hit", reportInteraction: false }),
+        onPerformanceMeasured: (action, duration) => {
+            if (action === "reload") {
+                onReload?.();
+            }
+            onPerformanceMeasured(action, duration);
+        },
+        onHierarchyLimitExceeded: () => onFeatureUsed({ featureId: "hierarchy-level-size-limit-hit", reportInteraction: false }),
     });
+    const reloadTree = treeProps.reloadTree;
     (0, UseIModelChangeListener_1.useIModelChangeListener)({ imodel, action: (0, react_1.useCallback)(() => reloadTree({ dataSourceChanged: true }), [reloadTree]) });
-    const reportingSelectNodes = (0, UseFeatureReporting_1.useReportingAction)({ action: selectNodes, reportUsage });
+    const reportingSelectNodes = (0, UseTelemetryContext_1.useReportingAction)({ action: selectNodes });
     const { onNodeClick, onNodeKeyDown } = (0, presentation_hierarchies_react_1.useSelectionHandler)({ rootNodes, selectNodes: reportingSelectNodes, selectionMode: selectionMode ?? "single" });
     const { filteringDialog, onFilterClick } = (0, UseHierarchyFiltering_1.useHierarchyLevelFiltering)({
         imodel,
         defaultHierarchyLevelSizeLimit,
-        reportUsage,
     });
-    const reportingExpandNode = (0, UseFeatureReporting_1.useReportingAction)({ action: expandNode, reportUsage });
-    const reportingOnFilterClicked = (0, UseFeatureReporting_1.useReportingAction)({ action: onFilterClick, reportUsage });
-    const { getLabel } = (0, UseNodeHighlighting_1.useNodeHighlighting)({ rootNodes, searchText });
+    const reportingExpandNode = (0, UseTelemetryContext_1.useReportingAction)({ action: expandNode });
+    const reportingOnFilterClicked = (0, UseTelemetryContext_1.useReportingAction)({ action: onFilterClick });
+    const { getLabel } = (0, UseNodeHighlighting_1.useNodeHighlighting)({ rootNodes, highlight });
     if (rootNodes === undefined) {
         return ((0, jsx_runtime_1.jsx)(itwinui_react_1.Flex, { alignItems: "center", justifyContent: "center", flexDirection: "column", style: { width, height }, children: (0, jsx_runtime_1.jsx)(Delayed_1.Delayed, { show: true, children: (0, jsx_runtime_1.jsx)(itwinui_react_1.ProgressRadial, { size: "large" }) }) }));
     }
@@ -66,12 +73,9 @@ function BaseTreeRenderer({ imodel, imodelAccess, height, width, treeName, noDat
         onNodeKeyDown,
         expandNode: reportingExpandNode,
         onFilterClick: reportingOnFilterClicked,
-        getIcon,
         getLabel,
-        getSublabel,
-        onNodeDoubleClick,
         size: density === "enlarged" ? "default" : "small",
     };
-    return ((0, jsx_runtime_1.jsxs)("div", { style: { position: "relative", height, overflow: "hidden" }, children: [(0, jsx_runtime_1.jsxs)("div", { id: "tw-tree-renderer-container", style: { overflow: "auto", height: "100%" }, children: [treeRenderer ? treeRenderer(treeRendererProps) : (0, jsx_runtime_1.jsx)(TreeRenderer_1.TreeRenderer, { ...treeRendererProps }), filteringDialog] }), (0, jsx_runtime_1.jsx)(Delayed_1.Delayed, { show: isLoading, children: (0, jsx_runtime_1.jsx)(ProgressOverlay_1.ProgressOverlay, {}) })] }));
+    return ((0, jsx_runtime_1.jsxs)("div", { style: { position: "relative", height, overflow: "hidden" }, children: [(0, jsx_runtime_1.jsxs)("div", { id: "tw-tree-renderer-container", style: { overflow: "auto", height: "100%" }, children: [treeRenderer(treeRendererProps), filteringDialog] }), (0, jsx_runtime_1.jsx)(Delayed_1.Delayed, { show: isLoading, children: (0, jsx_runtime_1.jsx)(ProgressOverlay_1.ProgressOverlay, {}) })] }));
 }
-//# sourceMappingURL=BaseTree.js.map
+//# sourceMappingURL=Tree.js.map

package/lib/cjs/components/trees/common/components/Tree.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Tree.js","sourceRoot":"","sources":["../../../../../../src/components/trees/common/components/Tree.tsx"],"names":[],"mappings":";;;;AAAA;;;gGAGgG;AAEhG,iCAA6C;AAC7C,wDAAkE;AAClE,4EAA+E;AAC/E,0FAA+H;AAC/H,uDAAoD;AACpD,8EAA2E;AAC3E,oEAAsE;AACtE,wEAAqE;AACrE,gEAA6D;AAC7D,gEAAiF;AACjF,oCAA8C;AAC9C,uCAAoC;AACpC,uDAAoD;AA6DpD;;;GAGG;AACH,SAAgB,IAAI,CAAC,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,YAAY,EAAE,oBAAoB,EAAE,GAAG,KAAK,EAAa;IAC3I,MAAM,8BAA8B,GAAG,uBAAuB,IAAI,IAAI,CAAC;IAEvE,MAAM,YAAY,GAAG,IAAA,eAAO,EAAC,GAAG,EAAE;QAChC,OAAO,oBAAoB,IAAI,IAAA,0BAAkB,EAAC,EAAE,gBAAgB,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IAChG,CAAC,EAAE,CAAC,oBAAoB,EAAE,gBAAgB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IAE3D,OAAO,CACL,uBAAC,uDAA6B,IAAC,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,qBAAqB,EAAE,gBAAgB,YAC1F,uBAAC,yDAAwB,IAAC,OAAO,EAAE,gBAAgB,YACjD,uBAAC,QAAQ,OAAK,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,8BAA8B,EAAE,8BAA8B,GAAI,GAC1F,GACG,CACjC,CAAC;AACJ,CAAC;AAdD,oBAcC;AAED,SAAS,QAAQ,CAAC,EAChB,MAAM,EACN,YAAY,EACZ,MAAM,EACN,KAAK,EACL,QAAQ,EACR,aAAa,EACb,gBAAgB,EAChB,8BAA8B,EAC9B,sBAAsB,EACtB,aAAa,EACb,QAAQ,EACR,YAAY,EACZ,OAAO,EACP,SAAS,GAC2H;IACpI,MAAM,gBAAgB,GAAG,IAAA,uDAA0B,GAAE,CAAC;IACtD,MAAM,EAAE,aAAa,EAAE,qBAAqB,EAAE,GAAG,IAAA,yCAAmB,GAAE,CAAC;IACvE,MAAM,EACJ,SAAS,EACT,SAAS,EACT,WAAW,EACX,YAAY,EAAE,aAAa,EAC3B,UAAU,EACV,GAAG,SAAS,EACb,GAAG,IAAA,wDAAuB,EAAC;QAC1B,YAAY;QACZ,sBAAsB;QACtB,gBAAgB;QAChB,SAAS,EAAE,MAAM,CAAC,GAAG;QACrB,UAAU,EAAE,QAAQ;QACpB,gBAAgB;QAChB,qBAAqB,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE;YAC1C,IAAI,MAAM,KAAK,QAAQ,EAAE;gBACvB,QAAQ,EAAE,EAAE,CAAC;aACd;YACD,qBAAqB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAC1C,CAAC;QACD,wBAAwB,EAAE,GAAG,EAAE,CAAC,aAAa,CAAC,EAAE,SAAS,EAAE,gCAAgC,EAAE,iBAAiB,EAAE,KAAK,EAAE,CAAC;KACzH,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,SAAS,CAAC,UAAU,CAAC;IACxC,IAAA,iDAAuB,EAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAA,mBAAW,EAAC,GAAG,EAAE,CAAC,UAAU,CAAC,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC;IACtH,MAAM,oBAAoB,GAAG,IAAA,wCAAkB,EAAC,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;IACzE,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,GAAG,IAAA,oDAAmB,EAAC,EAAE,SAAS,EAAE,WAAW,EAAE,oBAAoB,EAAE,aAAa,EAAE,aAAa,IAAI,QAAQ,EAAE,CAAC,CAAC;IACvJ,MAAM,EAAE,eAAe,EAAE,aAAa,EAAE,GAAG,IAAA,kDAA0B,EAAC;QACpE,MAAM;QACN,8BAA8B;KAC/B,CAAC,CAAC;IACH,MAAM,mBAAmB,GAAG,IAAA,wCAAkB,EAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;IACvE,MAAM,wBAAwB,GAAG,IAAA,wCAAkB,EAAC,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;IAC/E,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,yCAAmB,EAAC,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC;IAEnE,IAAI,SAAS,KAAK,SAAS,EAAE;QAC3B,OAAO,CACL,uBAAC,oBAAI,IAAC,UAAU,EAAC,QAAQ,EAAC,cAAc,EAAC,QAAQ,EAAC,aAAa,EAAC,QAAQ,EAAC,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,YAC/F,uBAAC,iBAAO,IAAC,IAAI,EAAE,IAAI,YACjB,uBAAC,8BAAc,IAAC,IAAI,EAAC,OAAO,GAAG,GACvB,GACL,CACR,CAAC;KACH;IAED,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE;QACxC,OAAO,CACL,uBAAC,oBAAI,IAAC,UAAU,EAAC,QAAQ,EAAC,cAAc,EAAC,QAAQ,EAAC,aAAa,EAAC,QAAQ,EAAC,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,YAC9F,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,uBAAC,oBAAI,cAAE,uBAAU,CAAC,SAAS,CAAC,6BAA6B,CAAC,GAAQ,GAC9F,CACR,CAAC;KACH;IAED,MAAM,iBAAiB,GAAsB;QAC3C,GAAG,SAAS;QACZ,SAAS;QACT,WAAW;QACX,aAAa;QACb,UAAU,EAAE,mBAAmB;QAC/B,aAAa,EAAE,wBAAwB;QACvC,QAAQ;QACR,IAAI,EAAE,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO;KACnD,CAAC;IAEF,OAAO,CACL,iCAAK,KAAK,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAC9D,iCAAK,EAAE,EAAC,4BAA4B,EAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,aAC7E,YAAY,CAAC,iBAAiB,CAAC,EAC/B,eAAe,IACZ,EACN,uBAAC,iBAAO,IAAC,IAAI,EAAE,SAAS,YACtB,uBAAC,iCAAe,KAAG,GACX,IACN,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 { useCallback, useMemo } from \"react\";\nimport { Flex, ProgressRadial, Text } from \"@itwin/itwinui-react\";\nimport { SchemaMetadataContextProvider } from \"@itwin/presentation-components\";\nimport { UnifiedSelectionProvider, useSelectionHandler, useUnifiedSelectionTree } from \"@itwin/presentation-hierarchies-react\";\nimport { TreeWidget } from \"../../../../TreeWidget\";\nimport { useHierarchiesLocalization } from \"../UseHierarchiesLocalization\";\nimport { useHierarchyLevelFiltering } from \"../UseHierarchyFiltering\";\nimport { useIModelChangeListener } from \"../UseIModelChangeListener\";\nimport { useNodeHighlighting } from \"../UseNodeHighlighting\";\nimport { useReportingAction, useTelemetryContext } from \"../UseTelemetryContext\";\nimport { createIModelAccess } from \"../Utils\";\nimport { Delayed } from \"./Delayed\";\nimport { ProgressOverlay } from \"./ProgressOverlay\";\n\nimport type { ComponentPropsWithoutRef, ReactNode } from \"react\";\nimport type { MarkRequired } from \"@itwin/core-bentley\";\nimport type { IModelConnection } from \"@itwin/core-frontend\";\nimport type { SchemaContext } from \"@itwin/ecschema-metadata\";\nimport type { SelectionStorage, useTree } from \"@itwin/presentation-hierarchies-react\";\nimport type { HighlightInfo } from \"../UseNodeHighlighting\";\nimport type { TreeRenderer } from \"./TreeRenderer\";\n\n/**\n * Properties that are passed to `treeRenderer` from `Tree` component.\n * @beta\n */\nexport type TreeRendererProps = Required<\n  Pick<\n    ComponentPropsWithoutRef<typeof TreeRenderer>,\n    \"rootNodes\" | \"expandNode\" | \"onNodeClick\" | \"onNodeKeyDown\" | \"onFilterClick\" | \"isNodeSelected\" | \"getHierarchyLevelDetails\" | \"size\" | \"getLabel\"\n  >\n>;\n\n/** @beta */\ninterface TreeOwnProps {\n  height: number;\n  width: number;\n  /** iModel connection that should be used to pull data from. */\n  imodel: IModelConnection;\n  /** Callback for getting `SchemaContext` for specific iModel. */\n  getSchemaContext: (imodel: IModelConnection) => SchemaContext;\n  /** Unique tree component name that will be used as unified selection change event source when selecting node. */\n  treeName: string;\n  /** Unified selection storage that should be used by tree to handle tree selection changes. */\n  selectionStorage: SelectionStorage;\n  /** Tree renderer that should be used to render tree data. */\n  treeRenderer: (treeProps: TreeRendererProps) => ReactNode;\n  /** Custom iModel access that is stored outside tree component. If not provided it new iModel access will be created using `imodel` prop. */\n  imodelAccess?: IModelAccess;\n  /** Size limit that should be applied on each hierarchy level. Default to `1000`. */\n  hierarchyLevelSizeLimit?: number;\n  /** Modifies the density of tree nodes. `enlarged` tree nodes have bigger button hit boxes. */\n  density?: \"default\" | \"enlarged\";\n  /** Message that should be renderer if there are no tree nodes. */\n  noDataMessage?: ReactNode;\n  /** Callback that this invoked when tree reloads. */\n  onReload?: () => void;\n  /** Options for highlighting node labels. */\n  highlight?: HighlightInfo;\n}\n\n/** @beta */\ntype UseTreeProps = Parameters<typeof useTree>[0];\n\n/** @beta */\ntype UseSelectionHandlerProps = Parameters<typeof useSelectionHandler>[0];\n\n/** @beta */\ntype IModelAccess = UseTreeProps[\"imodelAccess\"];\n\n/** @beta */\ntype TreeProps = TreeOwnProps & Pick<UseTreeProps, \"getFilteredPaths\" | \"getHierarchyDefinition\"> & Pick<Partial<UseSelectionHandlerProps>, \"selectionMode\">;\n\n/**\n * Default tree component that manages tree state and renders using supplied `treeRenderer`.\n * @Beta\n */\nexport function Tree({ getSchemaContext, hierarchyLevelSizeLimit, selectionStorage, imodelAccess: providedIModelAccess, ...props }: TreeProps) {\n  const defaultHierarchyLevelSizeLimit = hierarchyLevelSizeLimit ?? 1000;\n\n  const imodelAccess = useMemo(() => {\n    return providedIModelAccess ?? createIModelAccess({ getSchemaContext, imodel: props.imodel });\n  }, [providedIModelAccess, getSchemaContext, props.imodel]);\n\n  return (\n    <SchemaMetadataContextProvider imodel={props.imodel} schemaContextProvider={getSchemaContext}>\n      <UnifiedSelectionProvider storage={selectionStorage}>\n        <TreeImpl {...props} imodelAccess={imodelAccess} defaultHierarchyLevelSizeLimit={defaultHierarchyLevelSizeLimit} />\n      </UnifiedSelectionProvider>\n    </SchemaMetadataContextProvider>\n  );\n}\n\nfunction TreeImpl({\n  imodel,\n  imodelAccess,\n  height,\n  width,\n  treeName,\n  noDataMessage,\n  getFilteredPaths,\n  defaultHierarchyLevelSizeLimit,\n  getHierarchyDefinition,\n  selectionMode,\n  onReload,\n  treeRenderer,\n  density,\n  highlight,\n}: MarkRequired<Omit<TreeProps, \"getSchemaContext\" | \"selectionStorage\">, \"imodelAccess\"> & { defaultHierarchyLevelSizeLimit: number }) {\n  const localizedStrings = useHierarchiesLocalization();\n  const { onFeatureUsed, onPerformanceMeasured } = useTelemetryContext();\n  const {\n    rootNodes,\n    isLoading,\n    selectNodes,\n    setFormatter: _setFormatter,\n    expandNode,\n    ...treeProps\n  } = useUnifiedSelectionTree({\n    imodelAccess,\n    getHierarchyDefinition,\n    getFilteredPaths,\n    imodelKey: imodel.key,\n    sourceName: treeName,\n    localizedStrings,\n    onPerformanceMeasured: (action, duration) => {\n      if (action === \"reload\") {\n        onReload?.();\n      }\n      onPerformanceMeasured(action, duration);\n    },\n    onHierarchyLimitExceeded: () => onFeatureUsed({ featureId: \"hierarchy-level-size-limit-hit\", reportInteraction: false }),\n  });\n\n  const reloadTree = treeProps.reloadTree;\n  useIModelChangeListener({ imodel, action: useCallback(() => reloadTree({ dataSourceChanged: true }), [reloadTree]) });\n  const reportingSelectNodes = useReportingAction({ action: selectNodes });\n  const { onNodeClick, onNodeKeyDown } = useSelectionHandler({ rootNodes, selectNodes: reportingSelectNodes, selectionMode: selectionMode ?? \"single\" });\n  const { filteringDialog, onFilterClick } = useHierarchyLevelFiltering({\n    imodel,\n    defaultHierarchyLevelSizeLimit,\n  });\n  const reportingExpandNode = useReportingAction({ action: expandNode });\n  const reportingOnFilterClicked = useReportingAction({ action: onFilterClick });\n  const { getLabel } = useNodeHighlighting({ rootNodes, highlight });\n\n  if (rootNodes === undefined) {\n    return (\n      <Flex alignItems=\"center\" justifyContent=\"center\" flexDirection=\"column\" style={{ width, height }}>\n        <Delayed show={true}>\n          <ProgressRadial size=\"large\" />\n        </Delayed>\n      </Flex>\n    );\n  }\n\n  if (rootNodes.length === 0 && !isLoading) {\n    return (\n      <Flex alignItems=\"center\" justifyContent=\"center\" flexDirection=\"column\" style={{ width, height }}>\n        {noDataMessage ? noDataMessage : <Text>{TreeWidget.translate(\"baseTree.dataIsNotAvailable\")}</Text>}\n      </Flex>\n    );\n  }\n\n  const treeRendererProps: TreeRendererProps = {\n    ...treeProps,\n    rootNodes,\n    onNodeClick,\n    onNodeKeyDown,\n    expandNode: reportingExpandNode,\n    onFilterClick: reportingOnFilterClicked,\n    getLabel,\n    size: density === \"enlarged\" ? \"default\" : \"small\",\n  };\n\n  return (\n    <div style={{ position: \"relative\", height, overflow: \"hidden\" }}>\n      <div id=\"tw-tree-renderer-container\" style={{ overflow: \"auto\", height: \"100%\" }}>\n        {treeRenderer(treeRendererProps)}\n        {filteringDialog}\n      </div>\n      <Delayed show={isLoading}>\n        <ProgressOverlay />\n      </Delayed>\n    </div>\n  );\n}\n"]}

package/lib/cjs/components/trees/common/components/TreeNodeCheckbox.d.ts

@@ -1,20 +1,27 @@
 import { Checkbox } from "@itwin/itwinui-react";
 import type { PresentationHierarchyNode, RenderedTreeNode } from "@itwin/presentation-hierarchies-react";
 import type { ComponentPropsWithoutRef } from "react";
-/** @internal */
-export interface TreeNodeCheckboxState {
+/**
+ * Data structure that describes tree node checkbox state.
+ * @beta
+ */
+interface TreeNodeCheckboxState {
     state: "on" | "off" | "partial";
     isDisabled?: boolean;
     tooltip?: string;
 }
-interface TreeNodeCheckboxOwnProps {
-    node: RenderedTreeNode;
+/** @beta */
+export interface TreeCheckboxProps {
+    /** Callback that should be invoked when checkbox is clicked. */
     onCheckboxClicked: (node: PresentationHierarchyNode, checked: boolean) => void;
+    /** Callback that should be used to determine current checkbox state. */
     getCheckboxState: (node: PresentationHierarchyNode) => TreeNodeCheckboxState;
 }
-type CheckboxProps = ComponentPropsWithoutRef<typeof Checkbox>;
-type TreeNodeCheckboxProps = TreeNodeCheckboxOwnProps & Omit<CheckboxProps, "onClick" | "checked" | "onChange" | "indeterminate" | "disabled" | "title">;
 /** @internal */
-export declare function TreeNodeCheckbox({ node, onCheckboxClicked, getCheckboxState, ...props }: TreeNodeCheckboxProps): JSX.Element | null;
+type TreeNodeCheckboxProps = TreeCheckboxProps & Omit<ComponentPropsWithoutRef<typeof Checkbox>, "onClick" | "checked" | "onChange" | "indeterminate" | "disabled" | "title">;
+/** @internal */
+export declare function TreeNodeCheckbox({ node, onCheckboxClicked, getCheckboxState, ...props }: TreeNodeCheckboxProps & {
+    node: RenderedTreeNode;
+}): JSX.Element | null;
 export {};
 //# sourceMappingURL=TreeNodeCheckbox.d.ts.map

package/lib/cjs/components/trees/common/components/TreeNodeCheckbox.js.map

@@ -1 +1 @@
-{"version":3,"file":"TreeNodeCheckbox.js","sourceRoot":"","sources":["../../../../../../src/components/trees/common/components/TreeNodeCheckbox.tsx"],"names":[],"mappings":";;;;;;;AAAA;;;gGAGgG;AAEhG,4DAA4B;AAC5B,wDAAgD;AAChD,0FAAoF;AAqBpF,gBAAgB;AAChB,SAAgB,gBAAgB,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,GAAG,KAAK,EAAyB;IAC7G,IAAI,MAAM,IAAI,IAAI,IAAI,CAAC,IAAA,4DAA2B,EAAC,IAAI,CAAC,EAAE;QACxD,OAAO,IAAI,CAAC;KACb;IAED,MAAM,aAAa,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC7C,OAAO,CACL,uBAAC,wBAAQ,OACH,KAAK,EACT,SAAS,EAAE,IAAA,oBAAE,EAAC,uBAAuB,EAAE,KAAK,CAAC,SAAS,CAAC,EACvD,OAAO,EAAE,aAAa,CAAC,KAAK,KAAK,IAAI,EACrC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;YACb,CAAC,CAAC,eAAe,EAAE,CAAC;QACtB,CAAC,EACD,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE;YACd,iBAAiB,CAAC,IAAI,EAAE,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QACnD,CAAC,EACD,aAAa,EAAE,aAAa,CAAC,KAAK,KAAK,SAAS,EAChD,QAAQ,EAAE,aAAa,CAAC,UAAU,EAClC,KAAK,EAAE,aAAa,CAAC,OAAO,GAC5B,CACH,CAAC;AACJ,CAAC;AAtBD,4CAsBC","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 cx from \"classnames\";\nimport { Checkbox } from \"@itwin/itwinui-react\";\nimport { isPresentationHierarchyNode } from \"@itwin/presentation-hierarchies-react\";\n\nimport type { PresentationHierarchyNode, RenderedTreeNode } from \"@itwin/presentation-hierarchies-react\";\nimport type { ComponentPropsWithoutRef } from \"react\";\n\n/** @internal */\nexport interface TreeNodeCheckboxState {\n  state: \"on\" | \"off\" | \"partial\";\n  isDisabled?: boolean;\n  tooltip?: string;\n}\n\ninterface TreeNodeCheckboxOwnProps {\n  node: RenderedTreeNode;\n  onCheckboxClicked: (node: PresentationHierarchyNode, checked: boolean) => void;\n  getCheckboxState: (node: PresentationHierarchyNode) => TreeNodeCheckboxState;\n}\n\ntype CheckboxProps = ComponentPropsWithoutRef<typeof Checkbox>;\ntype TreeNodeCheckboxProps = TreeNodeCheckboxOwnProps & Omit<CheckboxProps, \"onClick\" | \"checked\" | \"onChange\" | \"indeterminate\" | \"disabled\" | \"title\">;\n\n/** @internal */\nexport function TreeNodeCheckbox({ node, onCheckboxClicked, getCheckboxState, ...props }: TreeNodeCheckboxProps) {\n  if (\"type\" in node || !isPresentationHierarchyNode(node)) {\n    return null;\n  }\n\n  const checkboxState = getCheckboxState(node);\n  return (\n    <Checkbox\n      {...props}\n      className={cx(\"tw-tree-node-checkbox\", props.className)}\n      checked={checkboxState.state === \"on\"}\n      onClick={(e) => {\n        e.stopPropagation();\n      }}\n      onChange={(e) => {\n        onCheckboxClicked(node, e.currentTarget.checked);\n      }}\n      indeterminate={checkboxState.state === \"partial\"}\n      disabled={checkboxState.isDisabled}\n      title={checkboxState.tooltip}\n    />\n  );\n}\n"]}
+{"version":3,"file":"TreeNodeCheckbox.js","sourceRoot":"","sources":["../../../../../../src/components/trees/common/components/TreeNodeCheckbox.tsx"],"names":[],"mappings":";;;;;;;AAAA;;;gGAGgG;AAEhG,4DAA4B;AAC5B,wDAAgD;AAChD,0FAAoF;AA2BpF,gBAAgB;AAChB,SAAgB,gBAAgB,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,GAAG,KAAK,EAAsD;IAC1I,IAAI,MAAM,IAAI,IAAI,IAAI,CAAC,IAAA,4DAA2B,EAAC,IAAI,CAAC,EAAE;QACxD,OAAO,IAAI,CAAC;KACb;IAED,MAAM,aAAa,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC7C,OAAO,CACL,uBAAC,wBAAQ,OACH,KAAK,EACT,SAAS,EAAE,IAAA,oBAAE,EAAC,uBAAuB,EAAE,KAAK,CAAC,SAAS,CAAC,EACvD,OAAO,EAAE,aAAa,CAAC,KAAK,KAAK,IAAI,EACrC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;YACb,CAAC,CAAC,eAAe,EAAE,CAAC;QACtB,CAAC,EACD,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE;YACd,iBAAiB,CAAC,IAAI,EAAE,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QACnD,CAAC,EACD,aAAa,EAAE,aAAa,CAAC,KAAK,KAAK,SAAS,EAChD,QAAQ,EAAE,aAAa,CAAC,UAAU,EAClC,KAAK,EAAE,aAAa,CAAC,OAAO,GAC5B,CACH,CAAC;AACJ,CAAC;AAtBD,4CAsBC","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 cx from \"classnames\";\nimport { Checkbox } from \"@itwin/itwinui-react\";\nimport { isPresentationHierarchyNode } from \"@itwin/presentation-hierarchies-react\";\n\nimport type { PresentationHierarchyNode, RenderedTreeNode } from \"@itwin/presentation-hierarchies-react\";\nimport type { ComponentPropsWithoutRef } from \"react\";\n\n/**\n * Data structure that describes tree node checkbox state.\n * @beta\n */\ninterface TreeNodeCheckboxState {\n  state: \"on\" | \"off\" | \"partial\";\n  isDisabled?: boolean;\n  tooltip?: string;\n}\n\n/** @beta */\nexport interface TreeCheckboxProps {\n  /** Callback that should be invoked when checkbox is clicked. */\n  onCheckboxClicked: (node: PresentationHierarchyNode, checked: boolean) => void;\n  /** Callback that should be used to determine current checkbox state. */\n  getCheckboxState: (node: PresentationHierarchyNode) => TreeNodeCheckboxState;\n}\n\n/** @internal */\ntype TreeNodeCheckboxProps = TreeCheckboxProps &\n  Omit<ComponentPropsWithoutRef<typeof Checkbox>, \"onClick\" | \"checked\" | \"onChange\" | \"indeterminate\" | \"disabled\" | \"title\">;\n\n/** @internal */\nexport function TreeNodeCheckbox({ node, onCheckboxClicked, getCheckboxState, ...props }: TreeNodeCheckboxProps & { node: RenderedTreeNode }) {\n  if (\"type\" in node || !isPresentationHierarchyNode(node)) {\n    return null;\n  }\n\n  const checkboxState = getCheckboxState(node);\n  return (\n    <Checkbox\n      {...props}\n      className={cx(\"tw-tree-node-checkbox\", props.className)}\n      checked={checkboxState.state === \"on\"}\n      onClick={(e) => {\n        e.stopPropagation();\n      }}\n      onChange={(e) => {\n        onCheckboxClicked(node, e.currentTarget.checked);\n      }}\n      indeterminate={checkboxState.state === \"partial\"}\n      disabled={checkboxState.isDisabled}\n      title={checkboxState.tooltip}\n    />\n  );\n}\n"]}

package/lib/cjs/components/trees/common/components/TreeNodeRenderer.d.ts

@@ -1,13 +1,14 @@
 import { TreeNodeRenderer as CoreTreeNodeRenderer } from "@itwin/presentation-hierarchies-react";
-import { TreeNodeCheckbox } from "./TreeNodeCheckbox";
 import type { ComponentPropsWithoutRef } from "react";
-type TreeNodeCheckboxProps = ComponentPropsWithoutRef<typeof TreeNodeCheckbox>;
+import type { TreeCheckboxProps } from "./TreeNodeCheckbox";
+/** @beta */
 interface TreeNodeRendererOwnProps {
-    checkboxProps?: Omit<TreeNodeCheckboxProps, "node">;
+    /** Props for rendering tree node checkbox. If not provided, checkbox is not rendered. */
+    checkboxProps?: TreeCheckboxProps;
 }
-type CoreTreeNodeRendererProps = ComponentPropsWithoutRef<typeof CoreTreeNodeRenderer>;
-type TreeNodeRendererProps = CoreTreeNodeRendererProps & TreeNodeRendererOwnProps;
-/** @internal */
+/** @beta */
+type TreeNodeRendererProps = ComponentPropsWithoutRef<typeof CoreTreeNodeRenderer> & TreeNodeRendererOwnProps;
+/** @beta */
 export declare function TreeNodeRenderer({ checkboxProps, ...props }: TreeNodeRendererProps): JSX.Element;
 export {};
 //# sourceMappingURL=TreeNodeRenderer.d.ts.map

package/lib/cjs/components/trees/common/components/TreeNodeRenderer.js

@@ -12,7 +12,7 @@ const jsx_runtime_1 = require("react/jsx-runtime");
 const classnames_1 = __importDefault(require("classnames"));
 const presentation_hierarchies_react_1 = require("@itwin/presentation-hierarchies-react");
 const TreeNodeCheckbox_1 = require("./TreeNodeCheckbox");
-/** @internal */
+/** @beta */
 function TreeNodeRenderer({ checkboxProps, ...props }) {
     return ((0, jsx_runtime_1.jsx)(presentation_hierarchies_react_1.TreeNodeRenderer, { ...props, nodeProps: { className: (0, classnames_1.default)("tw-tree-node", props.isSelected && "selected", props.className) }, actionButtonsClassName: "tw-tree-node-action-buttons", checkbox: checkboxProps ? (0, jsx_runtime_1.jsx)(TreeNodeCheckbox_1.TreeNodeCheckbox, { ...checkboxProps, node: props.node }) : null, contentProps: { className: "tw-tree-node-content" }, checkboxProps: { className: "tw-tree-node-checkbox-container" } }));
 }

package/lib/cjs/components/trees/common/components/TreeNodeRenderer.js.map

@@ -1 +1 @@
-{"version":3,"file":"TreeNodeRenderer.js","sourceRoot":"","sources":["../../../../../../src/components/trees/common/components/TreeNodeRenderer.tsx"],"names":[],"mappings":";;;;;;;AAAA;;;gGAGgG;AAEhG,4DAA4B;AAC5B,0FAAiG;AACjG,yDAAsD;AAatD,gBAAgB;AAChB,SAAgB,gBAAgB,CAAC,EAAE,aAAa,EAAE,GAAG,KAAK,EAAyB;IACjF,OAAO,CACL,uBAAC,iDAAoB,OACf,KAAK,EACT,SAAS,EAAE,EAAE,SAAS,EAAE,IAAA,oBAAE,EAAC,cAAc,EAAE,KAAK,CAAC,UAAU,IAAI,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,EAAE,EAC7F,sBAAsB,EAAC,6BAA6B,EACpD,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,uBAAC,mCAAgB,OAAK,aAAa,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,GAAI,CAAC,CAAC,CAAC,IAAI,EAC1F,YAAY,EAAE,EAAE,SAAS,EAAE,sBAAsB,EAAE,EACnD,aAAa,EAAE,EAAE,SAAS,EAAE,iCAAiC,EAAE,GAC/D,CACH,CAAC;AACJ,CAAC;AAXD,4CAWC","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 cx from \"classnames\";\nimport { TreeNodeRenderer as CoreTreeNodeRenderer } from \"@itwin/presentation-hierarchies-react\";\nimport { TreeNodeCheckbox } from \"./TreeNodeCheckbox\";\n\nimport type { ComponentPropsWithoutRef } from \"react\";\n\ntype TreeNodeCheckboxProps = ComponentPropsWithoutRef<typeof TreeNodeCheckbox>;\n\ninterface TreeNodeRendererOwnProps {\n  checkboxProps?: Omit<TreeNodeCheckboxProps, \"node\">;\n}\n\ntype CoreTreeNodeRendererProps = ComponentPropsWithoutRef<typeof CoreTreeNodeRenderer>;\ntype TreeNodeRendererProps = CoreTreeNodeRendererProps & TreeNodeRendererOwnProps;\n\n/** @internal */\nexport function TreeNodeRenderer({ checkboxProps, ...props }: TreeNodeRendererProps) {\n  return (\n    <CoreTreeNodeRenderer\n      {...props}\n      nodeProps={{ className: cx(\"tw-tree-node\", props.isSelected && \"selected\", props.className) }}\n      actionButtonsClassName=\"tw-tree-node-action-buttons\"\n      checkbox={checkboxProps ? <TreeNodeCheckbox {...checkboxProps} node={props.node} /> : null}\n      contentProps={{ className: \"tw-tree-node-content\" }}\n      checkboxProps={{ className: \"tw-tree-node-checkbox-container\" }}\n    />\n  );\n}\n"]}
+{"version":3,"file":"TreeNodeRenderer.js","sourceRoot":"","sources":["../../../../../../src/components/trees/common/components/TreeNodeRenderer.tsx"],"names":[],"mappings":";;;;;;;AAAA;;;gGAGgG;AAEhG,4DAA4B;AAC5B,0FAAiG;AACjG,yDAAsD;AActD,YAAY;AACZ,SAAgB,gBAAgB,CAAC,EAAE,aAAa,EAAE,GAAG,KAAK,EAAyB;IACjF,OAAO,CACL,uBAAC,iDAAoB,OACf,KAAK,EACT,SAAS,EAAE,EAAE,SAAS,EAAE,IAAA,oBAAE,EAAC,cAAc,EAAE,KAAK,CAAC,UAAU,IAAI,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,EAAE,EAC7F,sBAAsB,EAAC,6BAA6B,EACpD,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,uBAAC,mCAAgB,OAAK,aAAa,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,GAAI,CAAC,CAAC,CAAC,IAAI,EAC1F,YAAY,EAAE,EAAE,SAAS,EAAE,sBAAsB,EAAE,EACnD,aAAa,EAAE,EAAE,SAAS,EAAE,iCAAiC,EAAE,GAC/D,CACH,CAAC;AACJ,CAAC;AAXD,4CAWC","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 cx from \"classnames\";\nimport { TreeNodeRenderer as CoreTreeNodeRenderer } from \"@itwin/presentation-hierarchies-react\";\nimport { TreeNodeCheckbox } from \"./TreeNodeCheckbox\";\n\nimport type { ComponentPropsWithoutRef } from \"react\";\nimport type { TreeCheckboxProps } from \"./TreeNodeCheckbox\";\n\n/** @beta */\ninterface TreeNodeRendererOwnProps {\n  /** Props for rendering tree node checkbox. If not provided, checkbox is not rendered. */\n  checkboxProps?: TreeCheckboxProps;\n}\n\n/** @beta */\ntype TreeNodeRendererProps = ComponentPropsWithoutRef<typeof CoreTreeNodeRenderer> & TreeNodeRendererOwnProps;\n\n/** @beta */\nexport function TreeNodeRenderer({ checkboxProps, ...props }: TreeNodeRendererProps) {\n  return (\n    <CoreTreeNodeRenderer\n      {...props}\n      nodeProps={{ className: cx(\"tw-tree-node\", props.isSelected && \"selected\", props.className) }}\n      actionButtonsClassName=\"tw-tree-node-action-buttons\"\n      checkbox={checkboxProps ? <TreeNodeCheckbox {...checkboxProps} node={props.node} /> : null}\n      contentProps={{ className: \"tw-tree-node-content\" }}\n      checkboxProps={{ className: \"tw-tree-node-checkbox-container\" }}\n    />\n  );\n}\n"]}

package/lib/cjs/components/trees/common/components/TreeRenderer.d.ts

@@ -1,19 +1,27 @@
 import "./TreeRenderer.scss";
 import { Tree } from "@itwin/itwinui-react";
-import { LocalizationContextProvider } from "@itwin/presentation-hierarchies-react";
 import { TreeNodeRenderer } from "./TreeNodeRenderer";
 import type { ComponentPropsWithoutRef } from "react";
 import type { PresentationHierarchyNode, PresentationTreeNode, RenderedTreeNode } from "@itwin/presentation-hierarchies-react";
+/** @beta */
 interface TreeRendererOwnProps {
+    /** Tree nodes to render. */
     rootNodes: PresentationTreeNode[];
+    /** Callback to check if specific node is selected. */
     isNodeSelected: (nodeId: string) => boolean;
+    /** Callback that is invoked when node is double clicked. */
     onNodeDoubleClick?: (node: PresentationHierarchyNode, isSelected: boolean) => void;
 }
-type TreeRendererProps = Pick<TreeNodeRendererProps, "expandNode" | "onNodeClick" | "onNodeKeyDown" | "onFilterClick" | "getIcon" | "getLabel" | "getSublabel" | "getHierarchyLevelDetails" | "checkboxProps"> & Omit<TreeProps<RenderedTreeNode>, "data" | "nodeRenderer" | "getNode"> & Pick<LocalizationContextProviderProps, "localizedStrings"> & TreeRendererOwnProps;
-/** @internal */
-export declare function TreeRenderer({ rootNodes, expandNode, onNodeClick, onNodeKeyDown, onNodeDoubleClick, isNodeSelected, onFilterClick, getIcon, getLabel, getSublabel, getHierarchyLevelDetails, checkboxProps, localizedStrings, ...props }: TreeRendererProps): JSX.Element;
+/** @beta */
+type TreeRendererProps = Pick<TreeNodeRendererProps, "expandNode" | "onNodeClick" | "onNodeKeyDown" | "onFilterClick" | "getIcon" | "getLabel" | "getSublabel" | "getHierarchyLevelDetails" | "checkboxProps" | "reloadTree"> & Omit<TreeProps<RenderedTreeNode>, "data" | "nodeRenderer" | "getNode"> & TreeRendererOwnProps;
+/**
+ * Default renderer for rendering tree data.
+ * @beta
+ */
+export declare function TreeRenderer({ rootNodes, expandNode, onNodeClick, onNodeKeyDown, onNodeDoubleClick, isNodeSelected, onFilterClick, getIcon, getLabel, getSublabel, getHierarchyLevelDetails, checkboxProps, reloadTree, ...props }: TreeRendererProps): JSX.Element;
+/** @beta */
 type TreeProps<T> = ComponentPropsWithoutRef<typeof Tree<T>>;
+/** @beta */
 type TreeNodeRendererProps = ComponentPropsWithoutRef<typeof TreeNodeRenderer>;
-type LocalizationContextProviderProps = ComponentPropsWithoutRef<typeof LocalizationContextProvider>;
 export {};
 //# sourceMappingURL=TreeRenderer.d.ts.map

package/lib/cjs/components/trees/common/components/TreeRenderer.js

@@ -10,9 +10,14 @@ require("./TreeRenderer.scss");
 const react_1 = require("react");
 const itwinui_react_1 = require("@itwin/itwinui-react");
 const presentation_hierarchies_react_1 = require("@itwin/presentation-hierarchies-react");
+const UseHierarchiesLocalization_1 = require("../UseHierarchiesLocalization");
 const TreeNodeRenderer_1 = require("./TreeNodeRenderer");
-/** @internal */
-function TreeRenderer({ rootNodes, expandNode, onNodeClick, onNodeKeyDown, onNodeDoubleClick, isNodeSelected, onFilterClick, getIcon, getLabel, getSublabel, getHierarchyLevelDetails, checkboxProps, localizedStrings, ...props }) {
+/**
+ * Default renderer for rendering tree data.
+ * @beta
+ */
+function TreeRenderer({ rootNodes, expandNode, onNodeClick, onNodeKeyDown, onNodeDoubleClick, isNodeSelected, onFilterClick, getIcon, getLabel, getSublabel, getHierarchyLevelDetails, checkboxProps, reloadTree, ...props }) {
+    const localizedStrings = (0, UseHierarchiesLocalization_1.useHierarchiesLocalization)();
     const nodeRenderer = (0, react_1.useCallback)((nodeProps) => {
         return ((0, jsx_runtime_1.jsx)(TreeNodeRenderer_1.TreeNodeRenderer, { ...nodeProps, onNodeClick: (node, isSelected, event) => {
                 if (onNodeDoubleClick && event.detail === 2) {
@@ -21,8 +26,20 @@ function TreeRenderer({ rootNodes, expandNode, onNodeClick, onNodeKeyDown, onNod
                     return onNodeClick?.(node, true, event);
                 }
                 onNodeClick?.(node, isSelected, event);
-            }, expandNode: expandNode, onNodeKeyDown: onNodeKeyDown, getIcon: getIcon, getLabel: getLabel, getSublabel: getSublabel, onFilterClick: onFilterClick, getHierarchyLevelDetails: getHierarchyLevelDetails, checkboxProps: checkboxProps, className: getSublabel ? "with-description" : "without-description" }));
-    }, [expandNode, onNodeClick, onNodeKeyDown, onNodeDoubleClick, getHierarchyLevelDetails, getIcon, getLabel, getSublabel, onFilterClick, checkboxProps]);
+            }, expandNode: expandNode, onNodeKeyDown: onNodeKeyDown, getIcon: getIcon, getLabel: getLabel, getSublabel: getSublabel, onFilterClick: onFilterClick, getHierarchyLevelDetails: getHierarchyLevelDetails, checkboxProps: checkboxProps, reloadTree: reloadTree, className: getSublabel ? "with-description" : "without-description" }));
+    }, [
+        expandNode,
+        onNodeClick,
+        onNodeKeyDown,
+        onNodeDoubleClick,
+        getHierarchyLevelDetails,
+        getIcon,
+        getLabel,
+        getSublabel,
+        onFilterClick,
+        checkboxProps,
+        reloadTree,
+    ]);
     const getNode = (0, react_1.useCallback)((node) => (0, presentation_hierarchies_react_1.createRenderedTreeNodeData)(node, isNodeSelected), [isNodeSelected]);
     return ((0, jsx_runtime_1.jsx)(presentation_hierarchies_react_1.LocalizationContextProvider, { localizedStrings: localizedStrings, children: (0, jsx_runtime_1.jsx)(itwinui_react_1.Tree, { ...props, className: "tw-tree-renderer", data: rootNodes, nodeRenderer: nodeRenderer, getNode: getNode, enableVirtualization: true }) }));
 }

package/lib/cjs/components/trees/common/components/TreeRenderer.js.map

@@ -1 +1 @@
-{"version":3,"file":"TreeRenderer.js","sourceRoot":"","sources":["../../../../../../src/components/trees/common/components/TreeRenderer.tsx"],"names":[],"mappings":";;;;AAAA;;;gGAGgG;AAEhG,+BAA6B;AAC7B,iCAAoC;AACpC,wDAA4C;AAC5C,0FAAgH;AAChH,yDAAsD;AAmBtD,gBAAgB;AAChB,SAAgB,YAAY,CAAC,EAC3B,SAAS,EACT,UAAU,EACV,WAAW,EACX,aAAa,EACb,iBAAiB,EACjB,cAAc,EACd,aAAa,EACb,OAAO,EACP,QAAQ,EACR,WAAW,EACX,wBAAwB,EACxB,aAAa,EACb,gBAAgB,EAChB,GAAG,KAAK,EACU;IAClB,MAAM,YAAY,GAAG,IAAA,mBAAW,EAC9B,CAAC,SAAS,EAAE,EAAE;QACZ,OAAO,CACL,uBAAC,mCAAgB,OACX,SAAS,EACb,WAAW,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE;gBACvC,IAAI,iBAAiB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;oBAC3C,iBAAiB,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;oBAClD,mCAAmC;oBACnC,OAAO,WAAW,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;iBACzC;gBACD,WAAW,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;YACzC,CAAC,EACD,UAAU,EAAE,UAAU,EACtB,aAAa,EAAE,aAAa,EAC5B,OAAO,EAAE,OAAO,EAChB,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,WAAW,EACxB,aAAa,EAAE,aAAa,EAC5B,wBAAwB,EAAE,wBAAwB,EAClD,aAAa,EAAE,aAAa,EAC5B,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,qBAAqB,GACnE,CACH,CAAC;IACJ,CAAC,EACD,CAAC,UAAU,EAAE,WAAW,EAAE,aAAa,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,CAAC,CACpJ,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,mBAAW,EAAyC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,2DAA0B,EAAC,IAAI,EAAE,cAAc,CAAC,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC;IAElJ,OAAO,CACL,uBAAC,4DAA2B,IAAC,gBAAgB,EAAE,gBAAgB,YAC7D,uBAAC,oBAAI,OACC,KAAK,EACT,SAAS,EAAC,kBAAkB,EAC5B,IAAI,EAAE,SAAS,EACf,YAAY,EAAE,YAAY,EAC1B,OAAO,EAAE,OAAO,EAChB,oBAAoB,EAAE,IAAI,GAC1B,GAC0B,CAC/B,CAAC;AACJ,CAAC;AA1DD,oCA0DC","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 \"./TreeRenderer.scss\";\nimport { useCallback } from \"react\";\nimport { Tree } from \"@itwin/itwinui-react\";\nimport { createRenderedTreeNodeData, LocalizationContextProvider } from \"@itwin/presentation-hierarchies-react\";\nimport { TreeNodeRenderer } from \"./TreeNodeRenderer\";\n\nimport type { ComponentPropsWithoutRef } from \"react\";\nimport type { PresentationHierarchyNode, PresentationTreeNode, RenderedTreeNode } from \"@itwin/presentation-hierarchies-react\";\n\ninterface TreeRendererOwnProps {\n  rootNodes: PresentationTreeNode[];\n  isNodeSelected: (nodeId: string) => boolean;\n  onNodeDoubleClick?: (node: PresentationHierarchyNode, isSelected: boolean) => void;\n}\n\ntype TreeRendererProps = Pick<\n  TreeNodeRendererProps,\n  \"expandNode\" | \"onNodeClick\" | \"onNodeKeyDown\" | \"onFilterClick\" | \"getIcon\" | \"getLabel\" | \"getSublabel\" | \"getHierarchyLevelDetails\" | \"checkboxProps\"\n> &\n  Omit<TreeProps<RenderedTreeNode>, \"data\" | \"nodeRenderer\" | \"getNode\"> &\n  Pick<LocalizationContextProviderProps, \"localizedStrings\"> &\n  TreeRendererOwnProps;\n\n/** @internal */\nexport function TreeRenderer({\n  rootNodes,\n  expandNode,\n  onNodeClick,\n  onNodeKeyDown,\n  onNodeDoubleClick,\n  isNodeSelected,\n  onFilterClick,\n  getIcon,\n  getLabel,\n  getSublabel,\n  getHierarchyLevelDetails,\n  checkboxProps,\n  localizedStrings,\n  ...props\n}: TreeRendererProps) {\n  const nodeRenderer = useCallback<TreeProps<RenderedTreeNode>[\"nodeRenderer\"]>(\n    (nodeProps) => {\n      return (\n        <TreeNodeRenderer\n          {...nodeProps}\n          onNodeClick={(node, isSelected, event) => {\n            if (onNodeDoubleClick && event.detail === 2) {\n              onNodeDoubleClick?.(node, !!nodeProps.isSelected);\n              // Click node to not lose selection\n              return onNodeClick?.(node, true, event);\n            }\n            onNodeClick?.(node, isSelected, event);\n          }}\n          expandNode={expandNode}\n          onNodeKeyDown={onNodeKeyDown}\n          getIcon={getIcon}\n          getLabel={getLabel}\n          getSublabel={getSublabel}\n          onFilterClick={onFilterClick}\n          getHierarchyLevelDetails={getHierarchyLevelDetails}\n          checkboxProps={checkboxProps}\n          className={getSublabel ? \"with-description\" : \"without-description\"}\n        />\n      );\n    },\n    [expandNode, onNodeClick, onNodeKeyDown, onNodeDoubleClick, getHierarchyLevelDetails, getIcon, getLabel, getSublabel, onFilterClick, checkboxProps],\n  );\n\n  const getNode = useCallback<TreeProps<RenderedTreeNode>[\"getNode\"]>((node) => createRenderedTreeNodeData(node, isNodeSelected), [isNodeSelected]);\n\n  return (\n    <LocalizationContextProvider localizedStrings={localizedStrings}>\n      <Tree<RenderedTreeNode>\n        {...props}\n        className=\"tw-tree-renderer\"\n        data={rootNodes}\n        nodeRenderer={nodeRenderer}\n        getNode={getNode}\n        enableVirtualization={true}\n      />\n    </LocalizationContextProvider>\n  );\n}\n\ntype TreeProps<T> = ComponentPropsWithoutRef<typeof Tree<T>>;\ntype TreeNodeRendererProps = ComponentPropsWithoutRef<typeof TreeNodeRenderer>;\ntype LocalizationContextProviderProps = ComponentPropsWithoutRef<typeof LocalizationContextProvider>;\n"]}
+{"version":3,"file":"TreeRenderer.js","sourceRoot":"","sources":["../../../../../../src/components/trees/common/components/TreeRenderer.tsx"],"names":[],"mappings":";;;;AAAA;;;gGAGgG;AAEhG,+BAA6B;AAC7B,iCAAoC;AACpC,wDAA4C;AAC5C,0FAAgH;AAChH,8EAA2E;AAC3E,yDAAsD;AAgCtD;;;GAGG;AACH,SAAgB,YAAY,CAAC,EAC3B,SAAS,EACT,UAAU,EACV,WAAW,EACX,aAAa,EACb,iBAAiB,EACjB,cAAc,EACd,aAAa,EACb,OAAO,EACP,QAAQ,EACR,WAAW,EACX,wBAAwB,EACxB,aAAa,EACb,UAAU,EACV,GAAG,KAAK,EACU;IAClB,MAAM,gBAAgB,GAAG,IAAA,uDAA0B,GAAE,CAAC;IACtD,MAAM,YAAY,GAAG,IAAA,mBAAW,EAC9B,CAAC,SAAS,EAAE,EAAE;QACZ,OAAO,CACL,uBAAC,mCAAgB,OACX,SAAS,EACb,WAAW,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE;gBACvC,IAAI,iBAAiB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;oBAC3C,iBAAiB,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;oBAClD,mCAAmC;oBACnC,OAAO,WAAW,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;iBACzC;gBACD,WAAW,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;YACzC,CAAC,EACD,UAAU,EAAE,UAAU,EACtB,aAAa,EAAE,aAAa,EAC5B,OAAO,EAAE,OAAO,EAChB,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,WAAW,EACxB,aAAa,EAAE,aAAa,EAC5B,wBAAwB,EAAE,wBAAwB,EAClD,aAAa,EAAE,aAAa,EAC5B,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,qBAAqB,GACnE,CACH,CAAC;IACJ,CAAC,EACD;QACE,UAAU;QACV,WAAW;QACX,aAAa;QACb,iBAAiB;QACjB,wBAAwB;QACxB,OAAO;QACP,QAAQ;QACR,WAAW;QACX,aAAa;QACb,aAAa;QACb,UAAU;KACX,CACF,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,mBAAW,EAAyC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,2DAA0B,EAAC,IAAI,EAAE,cAAc,CAAC,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC;IAElJ,OAAO,CACL,uBAAC,4DAA2B,IAAC,gBAAgB,EAAE,gBAAgB,YAC7D,uBAAC,oBAAI,OACC,KAAK,EACT,SAAS,EAAC,kBAAkB,EAC5B,IAAI,EAAE,SAAS,EACf,YAAY,EAAE,YAAY,EAC1B,OAAO,EAAE,OAAO,EAChB,oBAAoB,EAAE,IAAI,GAC1B,GAC0B,CAC/B,CAAC;AACJ,CAAC;AAxED,oCAwEC","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 \"./TreeRenderer.scss\";\nimport { useCallback } from \"react\";\nimport { Tree } from \"@itwin/itwinui-react\";\nimport { createRenderedTreeNodeData, LocalizationContextProvider } from \"@itwin/presentation-hierarchies-react\";\nimport { useHierarchiesLocalization } from \"../UseHierarchiesLocalization\";\nimport { TreeNodeRenderer } from \"./TreeNodeRenderer\";\n\nimport type { ComponentPropsWithoutRef } from \"react\";\nimport type { PresentationHierarchyNode, PresentationTreeNode, RenderedTreeNode } from \"@itwin/presentation-hierarchies-react\";\n\n/** @beta */\ninterface TreeRendererOwnProps {\n  /** Tree nodes to render. */\n  rootNodes: PresentationTreeNode[];\n  /** Callback to check if specific node is selected. */\n  isNodeSelected: (nodeId: string) => boolean;\n  /** Callback that is invoked when node is double clicked. */\n  onNodeDoubleClick?: (node: PresentationHierarchyNode, isSelected: boolean) => void;\n}\n\n/** @beta */\ntype TreeRendererProps = Pick<\n  TreeNodeRendererProps,\n  | \"expandNode\"\n  | \"onNodeClick\"\n  | \"onNodeKeyDown\"\n  | \"onFilterClick\"\n  | \"getIcon\"\n  | \"getLabel\"\n  | \"getSublabel\"\n  | \"getHierarchyLevelDetails\"\n  | \"checkboxProps\"\n  | \"reloadTree\"\n> &\n  Omit<TreeProps<RenderedTreeNode>, \"data\" | \"nodeRenderer\" | \"getNode\"> &\n  TreeRendererOwnProps;\n\n/**\n * Default renderer for rendering tree data.\n * @beta\n */\nexport function TreeRenderer({\n  rootNodes,\n  expandNode,\n  onNodeClick,\n  onNodeKeyDown,\n  onNodeDoubleClick,\n  isNodeSelected,\n  onFilterClick,\n  getIcon,\n  getLabel,\n  getSublabel,\n  getHierarchyLevelDetails,\n  checkboxProps,\n  reloadTree,\n  ...props\n}: TreeRendererProps) {\n  const localizedStrings = useHierarchiesLocalization();\n  const nodeRenderer = useCallback<TreeProps<RenderedTreeNode>[\"nodeRenderer\"]>(\n    (nodeProps) => {\n      return (\n        <TreeNodeRenderer\n          {...nodeProps}\n          onNodeClick={(node, isSelected, event) => {\n            if (onNodeDoubleClick && event.detail === 2) {\n              onNodeDoubleClick?.(node, !!nodeProps.isSelected);\n              // Click node to not lose selection\n              return onNodeClick?.(node, true, event);\n            }\n            onNodeClick?.(node, isSelected, event);\n          }}\n          expandNode={expandNode}\n          onNodeKeyDown={onNodeKeyDown}\n          getIcon={getIcon}\n          getLabel={getLabel}\n          getSublabel={getSublabel}\n          onFilterClick={onFilterClick}\n          getHierarchyLevelDetails={getHierarchyLevelDetails}\n          checkboxProps={checkboxProps}\n          reloadTree={reloadTree}\n          className={getSublabel ? \"with-description\" : \"without-description\"}\n        />\n      );\n    },\n    [\n      expandNode,\n      onNodeClick,\n      onNodeKeyDown,\n      onNodeDoubleClick,\n      getHierarchyLevelDetails,\n      getIcon,\n      getLabel,\n      getSublabel,\n      onFilterClick,\n      checkboxProps,\n      reloadTree,\n    ],\n  );\n\n  const getNode = useCallback<TreeProps<RenderedTreeNode>[\"getNode\"]>((node) => createRenderedTreeNodeData(node, isNodeSelected), [isNodeSelected]);\n\n  return (\n    <LocalizationContextProvider localizedStrings={localizedStrings}>\n      <Tree<RenderedTreeNode>\n        {...props}\n        className=\"tw-tree-renderer\"\n        data={rootNodes}\n        nodeRenderer={nodeRenderer}\n        getNode={getNode}\n        enableVirtualization={true}\n      />\n    </LocalizationContextProvider>\n  );\n}\n\n/** @beta */\ntype TreeProps<T> = ComponentPropsWithoutRef<typeof Tree<T>>;\n/** @beta */\ntype TreeNodeRendererProps = ComponentPropsWithoutRef<typeof TreeNodeRenderer>;\n"]}

package/lib/cjs/components/trees/common/components/VisibilityTree.d.ts

@@ -1,14 +1,32 @@
-import { useHierarchyVisibility } from "../UseHierarchyVisibility";
-import { BaseTree } from "./BaseTree";
+import { Tree } from "./Tree";
+import type React from "react";
+import type { VisibilityTreeRenderer } from "./VisibilityTreeRenderer";
+import type { TreeRendererProps } from "./Tree";
 import type { ECClassHierarchyInspector } from "@itwin/presentation-shared";
 import type { HierarchyVisibilityHandler } from "../UseHierarchyVisibility";
 import type { ComponentPropsWithoutRef } from "react";
-type BaseTreeProps = ComponentPropsWithoutRef<typeof BaseTree>;
-type UseHierarchyVisibilityProps = Parameters<typeof useHierarchyVisibility>[0];
-type VisibilityTreeProps = Omit<BaseTreeProps, "treeRenderer" | "imodelAccess"> & Omit<UseHierarchyVisibilityProps, "visibilityHandlerFactory"> & {
-    visibilityHandlerFactory: (imodelAccess: ECClassHierarchyInspector) => HierarchyVisibilityHandler;
-};
-/** @internal */
-export declare function VisibilityTree({ visibilityHandlerFactory, onPerformanceMeasured, ...props }: VisibilityTreeProps): JSX.Element;
+/** @beta */
+type TreeProps = ComponentPropsWithoutRef<typeof Tree>;
+/**
+ * Properties that are passed to `treeRenderer` from `VisibilityTree` component.
+ * @beta
+ */
+export type VisibilityTreeRendererProps = TreeRendererProps & Pick<ComponentPropsWithoutRef<typeof VisibilityTreeRenderer>, "getCheckboxState" | "onCheckboxClicked">;
+/** @beta */
+interface VisibilityTreeOwnProps {
+    /** Callback for creating visibility handler used to control visibility of instances represented by tree nodes. */
+    visibilityHandlerFactory: (props: {
+        imodelAccess: ECClassHierarchyInspector;
+    }) => HierarchyVisibilityHandler;
+    /** Tree renderer that should be used to render tree data. */
+    treeRenderer: (treeProps: VisibilityTreeRendererProps) => React.ReactNode;
+}
+/** @beta */
+type VisibilityTreeProps = VisibilityTreeOwnProps & Omit<TreeProps, "treeRenderer" | "imodelAccess">;
+/**
+ * Tree component that can control visibility of instances represented by tree nodes.
+ * @beta
+ */
+export declare function VisibilityTree({ visibilityHandlerFactory, treeRenderer, ...props }: VisibilityTreeProps): JSX.Element;
 export {};
 //# sourceMappingURL=VisibilityTree.d.ts.map

package/lib/cjs/components/trees/common/components/VisibilityTree.js

@@ -7,35 +7,20 @@ const jsx_runtime_1 = require("react/jsx-runtime");
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
 const react_1 = require("react");
-const UseFeatureReporting_1 = require("../UseFeatureReporting");
 const UseHierarchyVisibility_1 = require("../UseHierarchyVisibility");
-const UseMultiCheckboxHandler_1 = require("../UseMultiCheckboxHandler");
 const Utils_1 = require("../Utils");
-const BaseTree_1 = require("./BaseTree");
-const TreeRenderer_1 = require("./TreeRenderer");
-/** @internal */
-function VisibilityTree({ visibilityHandlerFactory, onPerformanceMeasured, ...props }) {
+const Tree_1 = require("./Tree");
+/**
+ * Tree component that can control visibility of instances represented by tree nodes.
+ * @beta
+ */
+function VisibilityTree({ visibilityHandlerFactory, treeRenderer, ...props }) {
     const { imodel, getSchemaContext } = props;
     const imodelAccess = (0, react_1.useMemo)(() => (0, Utils_1.createIModelAccess)({ imodel, getSchemaContext }), [imodel, getSchemaContext]);
     const { getCheckboxState, onCheckboxClicked, triggerRefresh } = (0, UseHierarchyVisibility_1.useHierarchyVisibility)({
-        visibilityHandlerFactory: (0, react_1.useCallback)(() => visibilityHandlerFactory(imodelAccess), [visibilityHandlerFactory, imodelAccess]),
+        visibilityHandlerFactory: (0, react_1.useCallback)(() => visibilityHandlerFactory({ imodelAccess }), [visibilityHandlerFactory, imodelAccess]),
     });
-    return ((0, jsx_runtime_1.jsx)(BaseTree_1.BaseTree, { ...props, onPerformanceMeasured: (action, duration) => {
-            onPerformanceMeasured?.(action, duration);
-            if (action === "reload") {
-                triggerRefresh();
-            }
-        }, imodelAccess: imodelAccess, treeRenderer: (treeProps) => (0, jsx_runtime_1.jsx)(VisibilityTreeRenderer, { ...treeProps, getCheckboxState: getCheckboxState, onCheckboxClicked: onCheckboxClicked }) }));
+    return ((0, jsx_runtime_1.jsx)(Tree_1.Tree, { ...props, onReload: triggerRefresh, imodelAccess: imodelAccess, treeRenderer: (treeProps) => treeRenderer({ ...treeProps, getCheckboxState, onCheckboxClicked }) }));
 }
 exports.VisibilityTree = VisibilityTree;
-function VisibilityTreeRenderer({ getCheckboxState, onCheckboxClicked: onClick, reportUsage, ...props }) {
-    const { onCheckboxClicked } = (0, UseMultiCheckboxHandler_1.useMultiCheckboxHandler)({ rootNodes: props.rootNodes, isNodeSelected: props.isNodeSelected, onClick });
-    const reportingOnCheckboxClicked = (0, UseFeatureReporting_1.useReportingAction)({ featureId: "visibility-change", action: onCheckboxClicked, reportUsage });
-    const checkboxProps = (0, react_1.useMemo)(() => ({
-        variant: "eyeball",
-        getCheckboxState,
-        onCheckboxClicked: reportingOnCheckboxClicked,
-    }), [getCheckboxState, reportingOnCheckboxClicked]);
-    return (0, jsx_runtime_1.jsx)(TreeRenderer_1.TreeRenderer, { ...props, checkboxProps: checkboxProps });
-}
 //# sourceMappingURL=VisibilityTree.js.map

package/lib/cjs/components/trees/common/components/VisibilityTree.js.map

@@ -1 +1 @@
-{"version":3,"file":"VisibilityTree.js","sourceRoot":"","sources":["../../../../../../src/components/trees/common/components/VisibilityTree.tsx"],"names":[],"mappings":";;;;AAAA;;;gGAGgG;AAEhG,iCAA6C;AAC7C,gEAA4D;AAC5D,sEAAmE;AACnE,wEAAqE;AACrE,oCAA8C;AAC9C,yCAAsC;AACtC,iDAA8C;AAa9C,gBAAgB;AAChB,SAAgB,cAAc,CAAC,EAAE,wBAAwB,EAAE,qBAAqB,EAAE,GAAG,KAAK,EAAuB;IAC/G,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,GAAG,KAAK,CAAC;IAC3C,MAAM,YAAY,GAAG,IAAA,eAAO,EAAC,GAAG,EAAE,CAAC,IAAA,0BAAkB,EAAC,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC;IACjH,MAAM,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAA,+CAAsB,EAAC;QACrF,wBAAwB,EAAE,IAAA,mBAAW,EAAC,GAAG,EAAE,CAAC,wBAAwB,CAAC,YAAY,CAAC,EAAE,CAAC,wBAAwB,EAAE,YAAY,CAAC,CAAC;KAC9H,CAAC,CAAC;IAEH,OAAO,CACL,uBAAC,mBAAQ,OACH,KAAK,EACT,qBAAqB,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE;YAC1C,qBAAqB,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YAC1C,IAAI,MAAM,KAAK,QAAQ,EAAE;gBACvB,cAAc,EAAE,CAAC;aAClB;QACH,CAAC,EACD,YAAY,EAAE,YAAY,EAC1B,YAAY,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,uBAAC,sBAAsB,OAAK,SAAS,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,iBAAiB,GAAI,GAChJ,CACH,CAAC;AACJ,CAAC;AApBD,wCAoBC;AAID,SAAS,sBAAsB,CAAC,EAC9B,gBAAgB,EAChB,iBAAiB,EAAE,OAAO,EAC1B,WAAW,EACX,GAAG,KAAK,EAC2I;IACnJ,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAA,iDAAuB,EAAC,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,cAAc,EAAE,KAAK,CAAC,cAAc,EAAE,OAAO,EAAE,CAAC,CAAC;IACrI,MAAM,0BAA0B,GAAG,IAAA,wCAAkB,EAAC,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,EAAE,iBAAiB,EAAE,WAAW,EAAE,CAAC,CAAC;IAElI,MAAM,aAAa,GAAuC,IAAA,eAAO,EAC/D,GAAG,EAAE,CAAC,CAAC;QACL,OAAO,EAAE,SAAS;QAClB,gBAAgB;QAChB,iBAAiB,EAAE,0BAA0B;KAC9C,CAAC,EACF,CAAC,gBAAgB,EAAE,0BAA0B,CAAC,CAC/C,CAAC;IAEF,OAAO,uBAAC,2BAAY,OAAK,KAAK,EAAE,aAAa,EAAE,aAAa,GAAI,CAAC;AACnE,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 { useCallback, useMemo } from \"react\";\nimport { useReportingAction } from \"../UseFeatureReporting\";\nimport { useHierarchyVisibility } from \"../UseHierarchyVisibility\";\nimport { useMultiCheckboxHandler } from \"../UseMultiCheckboxHandler\";\nimport { createIModelAccess } from \"../Utils\";\nimport { BaseTree } from \"./BaseTree\";\nimport { TreeRenderer } from \"./TreeRenderer\";\n\nimport type { ECClassHierarchyInspector } from \"@itwin/presentation-shared\";\nimport type { HierarchyVisibilityHandler } from \"../UseHierarchyVisibility\";\nimport type { ComponentPropsWithoutRef } from \"react\";\n\ntype BaseTreeProps = ComponentPropsWithoutRef<typeof BaseTree>;\ntype UseHierarchyVisibilityProps = Parameters<typeof useHierarchyVisibility>[0];\ntype VisibilityTreeProps = Omit<BaseTreeProps, \"treeRenderer\" | \"imodelAccess\"> &\n  Omit<UseHierarchyVisibilityProps, \"visibilityHandlerFactory\"> & {\n    visibilityHandlerFactory: (imodelAccess: ECClassHierarchyInspector) => HierarchyVisibilityHandler;\n  };\n\n/** @internal */\nexport function VisibilityTree({ visibilityHandlerFactory, onPerformanceMeasured, ...props }: VisibilityTreeProps) {\n  const { imodel, getSchemaContext } = props;\n  const imodelAccess = useMemo(() => createIModelAccess({ imodel, getSchemaContext }), [imodel, getSchemaContext]);\n  const { getCheckboxState, onCheckboxClicked, triggerRefresh } = useHierarchyVisibility({\n    visibilityHandlerFactory: useCallback(() => visibilityHandlerFactory(imodelAccess), [visibilityHandlerFactory, imodelAccess]),\n  });\n\n  return (\n    <BaseTree\n      {...props}\n      onPerformanceMeasured={(action, duration) => {\n        onPerformanceMeasured?.(action, duration);\n        if (action === \"reload\") {\n          triggerRefresh();\n        }\n      }}\n      imodelAccess={imodelAccess}\n      treeRenderer={(treeProps) => <VisibilityTreeRenderer {...treeProps} getCheckboxState={getCheckboxState} onCheckboxClicked={onCheckboxClicked} />}\n    />\n  );\n}\n\ntype TreeRendererProps = ComponentPropsWithoutRef<typeof TreeRenderer>;\n\nfunction VisibilityTreeRenderer({\n  getCheckboxState,\n  onCheckboxClicked: onClick,\n  reportUsage,\n  ...props\n}: TreeRendererProps & Pick<ReturnType<typeof useHierarchyVisibility>, \"getCheckboxState\" | \"onCheckboxClicked\"> & Pick<BaseTreeProps, \"reportUsage\">) {\n  const { onCheckboxClicked } = useMultiCheckboxHandler({ rootNodes: props.rootNodes, isNodeSelected: props.isNodeSelected, onClick });\n  const reportingOnCheckboxClicked = useReportingAction({ featureId: \"visibility-change\", action: onCheckboxClicked, reportUsage });\n\n  const checkboxProps: TreeRendererProps[\"checkboxProps\"] = useMemo(\n    () => ({\n      variant: \"eyeball\",\n      getCheckboxState,\n      onCheckboxClicked: reportingOnCheckboxClicked,\n    }),\n    [getCheckboxState, reportingOnCheckboxClicked],\n  );\n\n  return <TreeRenderer {...props} checkboxProps={checkboxProps} />;\n}\n"]}
+{"version":3,"file":"VisibilityTree.js","sourceRoot":"","sources":["../../../../../../src/components/trees/common/components/VisibilityTree.tsx"],"names":[],"mappings":";;;;AAAA;;;gGAGgG;AAEhG,iCAA6C;AAC7C,sEAAmE;AACnE,oCAA8C;AAC9C,iCAA8B;AA8B9B;;;GAGG;AACH,SAAgB,cAAc,CAAC,EAAE,wBAAwB,EAAE,YAAY,EAAE,GAAG,KAAK,EAAuB;IACtG,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,GAAG,KAAK,CAAC;IAC3C,MAAM,YAAY,GAAG,IAAA,eAAO,EAAC,GAAG,EAAE,CAAC,IAAA,0BAAkB,EAAC,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC;IACjH,MAAM,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAA,+CAAsB,EAAC;QACrF,wBAAwB,EAAE,IAAA,mBAAW,EAAC,GAAG,EAAE,CAAC,wBAAwB,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,CAAC,wBAAwB,EAAE,YAAY,CAAC,CAAC;KAClI,CAAC,CAAC;IAEH,OAAO,CACL,uBAAC,WAAI,OACC,KAAK,EACT,QAAQ,EAAE,cAAc,EACxB,YAAY,EAAE,YAAY,EAC1B,YAAY,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,YAAY,CAAC,EAAE,GAAG,SAAS,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,CAAC,GAChG,CACH,CAAC;AACJ,CAAC;AAfD,wCAeC","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 { useCallback, useMemo } from \"react\";\nimport { useHierarchyVisibility } from \"../UseHierarchyVisibility\";\nimport { createIModelAccess } from \"../Utils\";\nimport { Tree } from \"./Tree\";\n\nimport type React from \"react\";\nimport type { VisibilityTreeRenderer } from \"./VisibilityTreeRenderer\";\nimport type { TreeRendererProps } from \"./Tree\";\nimport type { ECClassHierarchyInspector } from \"@itwin/presentation-shared\";\nimport type { HierarchyVisibilityHandler } from \"../UseHierarchyVisibility\";\nimport type { ComponentPropsWithoutRef } from \"react\";\n\n/** @beta */\ntype TreeProps = ComponentPropsWithoutRef<typeof Tree>;\n\n/**\n * Properties that are passed to `treeRenderer` from `VisibilityTree` component.\n * @beta\n */\nexport type VisibilityTreeRendererProps = TreeRendererProps &\n  Pick<ComponentPropsWithoutRef<typeof VisibilityTreeRenderer>, \"getCheckboxState\" | \"onCheckboxClicked\">;\n\n/** @beta */\ninterface VisibilityTreeOwnProps {\n  /** Callback for creating visibility handler used to control visibility of instances represented by tree nodes. */\n  visibilityHandlerFactory: (props: { imodelAccess: ECClassHierarchyInspector }) => HierarchyVisibilityHandler;\n  /** Tree renderer that should be used to render tree data. */\n  treeRenderer: (treeProps: VisibilityTreeRendererProps) => React.ReactNode;\n}\n\n/** @beta */\ntype VisibilityTreeProps = VisibilityTreeOwnProps & Omit<TreeProps, \"treeRenderer\" | \"imodelAccess\">;\n\n/**\n * Tree component that can control visibility of instances represented by tree nodes.\n * @beta\n */\nexport function VisibilityTree({ visibilityHandlerFactory, treeRenderer, ...props }: VisibilityTreeProps) {\n  const { imodel, getSchemaContext } = props;\n  const imodelAccess = useMemo(() => createIModelAccess({ imodel, getSchemaContext }), [imodel, getSchemaContext]);\n  const { getCheckboxState, onCheckboxClicked, triggerRefresh } = useHierarchyVisibility({\n    visibilityHandlerFactory: useCallback(() => visibilityHandlerFactory({ imodelAccess }), [visibilityHandlerFactory, imodelAccess]),\n  });\n\n  return (\n    <Tree\n      {...props}\n      onReload={triggerRefresh}\n      imodelAccess={imodelAccess}\n      treeRenderer={(treeProps) => treeRenderer({ ...treeProps, getCheckboxState, onCheckboxClicked })}\n    />\n  );\n}\n"]}

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

@@ -0,0 +1,12 @@
+import { TreeRenderer } from "./TreeRenderer";
+import type { ComponentPropsWithoutRef } from "react";
+import type { TreeCheckboxProps } from "./TreeNodeCheckbox";
+/** @beta */
+type TreeRendererProps = ComponentPropsWithoutRef<typeof TreeRenderer>;
+/**
+ * Tree renderer that renders tree nodes with eye checkboxes for controlling visibility of instances represented by tree nodes.
+ * @beta
+ */
+export declare function VisibilityTreeRenderer({ getCheckboxState, onCheckboxClicked: onClick, ...props }: TreeRendererProps & TreeCheckboxProps): JSX.Element;
+export {};
+//# sourceMappingURL=VisibilityTreeRenderer.d.ts.map

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

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VisibilityTreeRenderer = 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 react_1 = require("react");
+const UseMultiCheckboxHandler_1 = require("../UseMultiCheckboxHandler");
+const TreeRenderer_1 = require("./TreeRenderer");
+/**
+ * Tree renderer that renders tree nodes with eye checkboxes for controlling visibility of instances represented by tree nodes.
+ * @beta
+ */
+function VisibilityTreeRenderer({ getCheckboxState, onCheckboxClicked: onClick, ...props }) {
+    const { onCheckboxClicked } = (0, UseMultiCheckboxHandler_1.useMultiCheckboxHandler)({ rootNodes: props.rootNodes, isNodeSelected: props.isNodeSelected, onClick });
+    const checkboxProps = (0, react_1.useMemo)(() => ({
+        variant: "eyeball",
+        getCheckboxState,
+        onCheckboxClicked,
+    }), [getCheckboxState, onCheckboxClicked]);
+    return (0, jsx_runtime_1.jsx)(TreeRenderer_1.TreeRenderer, { ...props, checkboxProps: checkboxProps });
+}
+exports.VisibilityTreeRenderer = VisibilityTreeRenderer;
+//# sourceMappingURL=VisibilityTreeRenderer.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"VisibilityTreeRenderer.js","sourceRoot":"","sources":["../../../../../../src/components/trees/common/components/VisibilityTreeRenderer.tsx"],"names":[],"mappings":";;;;AAAA;;;gGAGgG;AAEhG,iCAAgC;AAChC,wEAAqE;AACrE,iDAA8C;AAQ9C;;;GAGG;AACH,SAAgB,sBAAsB,CAAC,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,OAAO,EAAE,GAAG,KAAK,EAAyC;IACtI,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAA,iDAAuB,EAAC,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,cAAc,EAAE,KAAK,CAAC,cAAc,EAAE,OAAO,EAAE,CAAC,CAAC;IAErI,MAAM,aAAa,GAAuC,IAAA,eAAO,EAC/D,GAAG,EAAE,CAAC,CAAC;QACL,OAAO,EAAE,SAAS;QAClB,gBAAgB;QAChB,iBAAiB;KAClB,CAAC,EACF,CAAC,gBAAgB,EAAE,iBAAiB,CAAC,CACtC,CAAC;IAEF,OAAO,uBAAC,2BAAY,OAAK,KAAK,EAAE,aAAa,EAAE,aAAa,GAAI,CAAC;AACnE,CAAC;AAbD,wDAaC","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 { useMemo } from \"react\";\nimport { useMultiCheckboxHandler } from \"../UseMultiCheckboxHandler\";\nimport { TreeRenderer } from \"./TreeRenderer\";\n\nimport type { ComponentPropsWithoutRef } from \"react\";\nimport type { TreeCheckboxProps } from \"./TreeNodeCheckbox\";\n\n/** @beta */\ntype TreeRendererProps = ComponentPropsWithoutRef<typeof TreeRenderer>;\n\n/**\n * Tree renderer that renders tree nodes with eye checkboxes for controlling visibility of instances represented by tree nodes.\n * @beta\n */\nexport function VisibilityTreeRenderer({ getCheckboxState, onCheckboxClicked: onClick, ...props }: TreeRendererProps & TreeCheckboxProps) {\n  const { onCheckboxClicked } = useMultiCheckboxHandler({ rootNodes: props.rootNodes, isNodeSelected: props.isNodeSelected, onClick });\n\n  const checkboxProps: TreeRendererProps[\"checkboxProps\"] = useMemo(\n    () => ({\n      variant: \"eyeball\",\n      getCheckboxState,\n      onCheckboxClicked,\n    }),\n    [getCheckboxState, onCheckboxClicked],\n  );\n\n  return <TreeRenderer {...props} checkboxProps={checkboxProps} />;\n}\n"]}

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

@@ -1,15 +1,16 @@
 /// <reference types="react" />
-import { BaseTree } from "../common/components/BaseTree";
+import { Tree } from "../common/components/Tree";
+/** @beta */
 interface ExternalSourcesTreeOwnProps {
     hierarchyLevelConfig?: {
         sizeLimit?: number;
     };
-    onPerformanceMeasured?: (featureId: string, duration: number) => void;
-    onFeatureUsed?: (feature: string) => void;
 }
-type BaseTreeProps = Parameters<typeof BaseTree>[0];
-type ExternalSourcesTreeProps = ExternalSourcesTreeOwnProps & Pick<BaseTreeProps, "imodel" | "getSchemaContext" | "height" | "width" | "density" | "selectionMode">;
-/** @internal */
-export declare function ExternalSourcesTree({ onPerformanceMeasured, onFeatureUsed, ...props }: ExternalSourcesTreeProps): JSX.Element;
+/** @beta */
+type TreeProps = Parameters<typeof Tree>[0];
+/** @beta */
+type ExternalSourcesTreeProps = ExternalSourcesTreeOwnProps & Pick<TreeProps, "imodel" | "getSchemaContext" | "selectionStorage" | "height" | "width" | "density" | "selectionMode">;
+/** @beta */
+export declare function ExternalSourcesTree(props: ExternalSourcesTreeProps): JSX.Element;
 export {};
 //# sourceMappingURL=ExternalSourcesTree.d.ts.map