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

package/lib/esm/components/trees/common/UseTelemetryContext.js

@@ -0,0 +1,43 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { createContext, useCallback, useContext, useMemo } from "react";
+import { useLatest } from "./Utils";
+const telemetryContext = createContext(undefined);
+/** @beta */
+export function TelemetryContextProvider({ children, onPerformanceMeasured, onFeatureUsed, componentIdentifier, }) {
+    const onPerformanceMeasuredRef = useLatest(onPerformanceMeasured);
+    const onFeatureUsedRef = useLatest(onFeatureUsed);
+    const contextValue = useMemo(() => {
+        return {
+            onPerformanceMeasured: (featureId, duration) => onPerformanceMeasuredRef.current?.(`${componentIdentifier}-${featureId}`, duration),
+            onFeatureUsed: ({ featureId, reportInteraction }) => {
+                if (reportInteraction !== false) {
+                    onFeatureUsedRef.current?.(`use-${componentIdentifier}`);
+                }
+                if (featureId) {
+                    onFeatureUsedRef.current?.(`${componentIdentifier}-${featureId}`);
+                }
+            },
+        };
+    }, [componentIdentifier, onPerformanceMeasuredRef, onFeatureUsedRef]);
+    return _jsx(telemetryContext.Provider, { value: contextValue, children: children });
+}
+const defaultContextValue = {
+    onPerformanceMeasured: () => { },
+    onFeatureUsed: () => { },
+};
+export function useTelemetryContext() {
+    return useContext(telemetryContext) ?? defaultContextValue;
+}
+/** @internal */
+export function useReportingAction({ action, featureId }) {
+    const { onFeatureUsed } = useTelemetryContext();
+    return useCallback((...args) => {
+        onFeatureUsed({ featureId, reportInteraction: true });
+        action(...args);
+    }, [action, featureId, onFeatureUsed]);
+}
+//# sourceMappingURL=UseTelemetryContext.js.map

package/lib/esm/components/trees/common/UseTelemetryContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UseTelemetryContext.js","sourceRoot":"","sources":["../../../../../src/components/trees/common/UseTelemetryContext.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AACxE,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAkBpC,MAAM,gBAAgB,GAAG,aAAa,CAA+B,SAAS,CAAC,CAAC;AAYhF,YAAY;AACZ,MAAM,UAAU,wBAAwB,CAAC,EACvC,QAAQ,EACR,qBAAqB,EACrB,aAAa,EACb,mBAAmB,GAC8B;IACjD,MAAM,wBAAwB,GAAG,SAAS,CAAC,qBAAqB,CAAC,CAAC;IAClE,MAAM,gBAAgB,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;IAElD,MAAM,YAAY,GAAG,OAAO,CAAmB,GAAG,EAAE;QAClD,OAAO;YACL,qBAAqB,EAAE,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE,CAAC,wBAAwB,CAAC,OAAO,EAAE,CAAC,GAAG,mBAAmB,IAAI,SAAS,EAAE,EAAE,QAAQ,CAAC;YACnI,aAAa,EAAE,CAAC,EAAE,SAAS,EAAE,iBAAiB,EAAE,EAAE,EAAE;gBAClD,IAAI,iBAAiB,KAAK,KAAK,EAAE;oBAC/B,gBAAgB,CAAC,OAAO,EAAE,CAAC,OAAO,mBAAmB,EAAE,CAAC,CAAC;iBAC1D;gBACD,IAAI,SAAS,EAAE;oBACb,gBAAgB,CAAC,OAAO,EAAE,CAAC,GAAG,mBAAmB,IAAI,SAAS,EAAE,CAAC,CAAC;iBACnE;YACH,CAAC;SACF,CAAC;IACJ,CAAC,EAAE,CAAC,mBAAmB,EAAE,wBAAwB,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAEtE,OAAO,KAAC,gBAAgB,CAAC,QAAQ,IAAC,KAAK,EAAE,YAAY,YAAG,QAAQ,GAA6B,CAAC;AAChG,CAAC;AAED,MAAM,mBAAmB,GAAqB;IAC5C,qBAAqB,EAAE,GAAG,EAAE,GAAE,CAAC;IAC/B,aAAa,EAAE,GAAG,EAAE,GAAE,CAAC;CACxB,CAAC;AAEF,MAAM,UAAU,mBAAmB;IACjC,OAAO,UAAU,CAAC,gBAAgB,CAAC,IAAI,mBAAmB,CAAC;AAC7D,CAAC;AAOD,gBAAgB;AAChB,MAAM,UAAU,kBAAkB,CAA2C,EAAE,MAAM,EAAE,SAAS,EAAoC;IAClI,MAAM,EAAE,aAAa,EAAE,GAAG,mBAAmB,EAAE,CAAC;IAChD,OAAO,WAAW,CAChB,CAAC,GAAG,IAAI,EAAE,EAAE;QACV,aAAa,CAAC,EAAE,SAAS,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;QACtD,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAClB,CAAC,EACD,CAAC,MAAM,EAAE,SAAS,EAAE,aAAa,CAAC,CACnC,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 { createContext, useCallback, useContext, useMemo } from \"react\";\nimport { useLatest } from \"./Utils\";\n\nimport type { PropsWithChildren } from \"react\";\n\ntype TrackedFeatures =\n  | \"visibility-change\"\n  | \"hierarchy-level-filtering\"\n  | \"filtering\"\n  | \"hierarchy-level-size-limit-hit\"\n  | \"zoom-to-node\"\n  | \"error-timeout\"\n  | \"error-unknown\";\n\ninterface TelemetryContext {\n  onPerformanceMeasured: (featureId: string, duration: number) => void;\n  onFeatureUsed: (props: { featureId?: TrackedFeatures; reportInteraction: boolean }) => void;\n}\n\nconst telemetryContext = createContext<TelemetryContext | undefined>(undefined);\n\n/** @beta */\nexport interface TelemetryContextProviderProps {\n  /** Callback that is invoked when performance of tracked feature is measured. */\n  onPerformanceMeasured?: (featureId: string, duration: number) => void;\n  /** Callback that is invoked when a tracked feature is used. */\n  onFeatureUsed?: (featureId: string) => void;\n  /** Unique identifier that is appended to feature id to help track which component used that feature. */\n  componentIdentifier: string;\n}\n\n/** @beta */\nexport function TelemetryContextProvider({\n  children,\n  onPerformanceMeasured,\n  onFeatureUsed,\n  componentIdentifier,\n}: PropsWithChildren<TelemetryContextProviderProps>) {\n  const onPerformanceMeasuredRef = useLatest(onPerformanceMeasured);\n  const onFeatureUsedRef = useLatest(onFeatureUsed);\n\n  const contextValue = useMemo<TelemetryContext>(() => {\n    return {\n      onPerformanceMeasured: (featureId, duration) => onPerformanceMeasuredRef.current?.(`${componentIdentifier}-${featureId}`, duration),\n      onFeatureUsed: ({ featureId, reportInteraction }) => {\n        if (reportInteraction !== false) {\n          onFeatureUsedRef.current?.(`use-${componentIdentifier}`);\n        }\n        if (featureId) {\n          onFeatureUsedRef.current?.(`${componentIdentifier}-${featureId}`);\n        }\n      },\n    };\n  }, [componentIdentifier, onPerformanceMeasuredRef, onFeatureUsedRef]);\n\n  return <telemetryContext.Provider value={contextValue}>{children}</telemetryContext.Provider>;\n}\n\nconst defaultContextValue: TelemetryContext = {\n  onPerformanceMeasured: () => {},\n  onFeatureUsed: () => {},\n};\n\nexport function useTelemetryContext() {\n  return useContext(telemetryContext) ?? defaultContextValue;\n}\n\ninterface UseReportingActionProps<TAction> {\n  action: TAction;\n  featureId?: TrackedFeatures;\n}\n\n/** @internal */\nexport function useReportingAction<TAction extends (...args: any[]) => void>({ action, featureId }: UseReportingActionProps<TAction>) {\n  const { onFeatureUsed } = useTelemetryContext();\n  return useCallback<(...args: Parameters<TAction>) => void>(\n    (...args) => {\n      onFeatureUsed({ featureId, reportInteraction: true });\n      action(...args);\n    },\n    [action, featureId, onFeatureUsed],\n  );\n}\n"]}

package/lib/esm/components/trees/common/Utils.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="react" />
 import type { Id64Array } from "@itwin/core-bentley";
 import type { IModelConnection } from "@itwin/core-frontend";
 import type { SchemaContext } from "@itwin/ecschema-metadata";
@@ -18,4 +19,6 @@ export declare function createIModelAccess({ imodel, getSchemaContext }: {
     classDerivesFrom(derivedClassFullName: string, candidateBaseClassFullName: string): boolean | Promise<boolean>;
     getSchema(schemaName: string): Promise<import("@itwin/presentation-shared").EC.Schema | undefined>;
 };
+/** @internal */
+export declare function useLatest<T>(value: T): import("react").MutableRefObject<T>;
 //# sourceMappingURL=Utils.d.ts.map

package/lib/esm/components/trees/common/Utils.js

@@ -2,6 +2,7 @@
  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
+import { useEffect, useRef } from "react";
 import { createECSchemaProvider, createECSqlQueryExecutor } from "@itwin/presentation-core-interop";
 import { createLimitingECSqlQueryExecutor } from "@itwin/presentation-hierarchies";
 import { createCachingECClassHierarchyInspector } from "@itwin/presentation-shared";
@@ -45,4 +46,12 @@ export function createIModelAccess({ imodel, getSchemaContext }) {
         ...createLimitingECSqlQueryExecutor(createECSqlQueryExecutor(imodel), 1000),
     };
 }
+/** @internal */
+export function useLatest(value) {
+    const ref = useRef(value);
+    useEffect(() => {
+        ref.current = value;
+    }, [value]);
+    return ref;
+}
 //# sourceMappingURL=Utils.js.map

package/lib/esm/components/trees/common/Utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"Utils.js","sourceRoot":"","sources":["../../../../../src/components/trees/common/Utils.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AACpG,OAAO,EAAE,gCAAgC,EAAE,MAAM,iCAAiC,CAAC;AACnF,OAAO,EAAE,sCAAsC,EAAE,MAAM,4BAA4B,CAAC;AAMpF,gBAAgB;AAChB,MAAM,UAAU,iBAAiB,CAAC,GAAc;IAC9C,sHAAsH;IACtH,oCAAoC;IACpC,MAAM,MAAM,GAAG,IAAI,KAAK,EAAgB,CAAC;IACzC,KAAK,IAAI,eAAe,GAAG,CAAC,EAAE,eAAe,GAAG,GAAG,CAAC,MAAM,EAAE,eAAe,IAAI,GAAG,EAAE;QAClF,IAAI,aAAa,GAAuB,eAAe,GAAG,GAAG,CAAC;QAC9D,IAAI,aAAa,GAAG,GAAG,CAAC,MAAM,EAAE;YAC9B,aAAa,GAAG,SAAS,CAAC;SAC3B;QACD,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC,CAAC;KACxD;IACD,OAAO,cAAc,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,cAAc,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;AACzH,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,sBAAsB,CAAC,cAAmB;IACxD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE;QAClC,OAAO,EAAE,CAAC;KACX;IACD,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAA8B,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,EAAc,CAAC,CAAC;AAClJ,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,SAAS,CAAe,SAAiC,EAAE,GAAS,EAAE,KAAa;IACjG,IAAI,GAAG,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7B,IAAI,CAAC,GAAG,EAAE;QACR,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;QAChB,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;KACzB;IACD,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AACjB,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,kBAAkB,CAAC,EAAE,MAAM,EAAE,gBAAgB,EAA+F;IAC1J,MAAM,OAAO,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACzC,MAAM,cAAc,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAC;IACvD,OAAO;QACL,GAAG,cAAc;QACjB,GAAG,sCAAsC,CAAC,EAAE,cAAc,EAAE,CAAC;QAC7D,GAAG,gCAAgC,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC;KAC5E,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 { createECSchemaProvider, createECSqlQueryExecutor } from \"@itwin/presentation-core-interop\";\nimport { createLimitingECSqlQueryExecutor } from \"@itwin/presentation-hierarchies\";\nimport { createCachingECClassHierarchyInspector } from \"@itwin/presentation-shared\";\n\nimport type { Id64Array, Id64String } from \"@itwin/core-bentley\";\nimport type { IModelConnection } from \"@itwin/core-frontend\";\nimport type { SchemaContext } from \"@itwin/ecschema-metadata\";\n\n/** @internal */\nexport function createIdsSelector(ids: Id64Array): string {\n  // Note: `json_array` function only accepts up to 127 arguments and we may have more `ids` than that. As a workaround,\n  // we're creating an array of arrays\n  const slices = new Array<Id64String[]>();\n  for (let sliceStartIndex = 0; sliceStartIndex < ids.length; sliceStartIndex += 127) {\n    let sliceEndIndex: number | undefined = sliceStartIndex + 127;\n    if (sliceEndIndex > ids.length) {\n      sliceEndIndex = undefined;\n    }\n    slices.push(ids.slice(sliceStartIndex, sliceEndIndex));\n  }\n  return `json_array(${slices.map((sliceIds) => `json_array(${sliceIds.map((id) => `'${id}'`).join(\",\")})`).join(\",\")})`;\n}\n\n/** @internal */\nexport function parseIdsSelectorResult(selectorResult: any): Id64Array {\n  if (!Array.isArray(selectorResult)) {\n    return [];\n  }\n  return selectorResult.reduce((arr, ids: Id64String | Id64String[]) => [...arr, ...(Array.isArray(ids) ? ids : [ids])], new Array<Id64String>());\n}\n\n/** @internal */\nexport function pushToMap<TKey, TValue>(targetMap: Map<TKey, Set<TValue>>, key: TKey, value: TValue) {\n  let set = targetMap.get(key);\n  if (!set) {\n    set = new Set();\n    targetMap.set(key, set);\n  }\n  set.add(value);\n}\n\n/** @internal */\nexport function createIModelAccess({ imodel, getSchemaContext }: { imodel: IModelConnection; getSchemaContext: (imodel: IModelConnection) => SchemaContext }) {\n  const schemas = getSchemaContext(imodel);\n  const schemaProvider = createECSchemaProvider(schemas);\n  return {\n    ...schemaProvider,\n    ...createCachingECClassHierarchyInspector({ schemaProvider }),\n    ...createLimitingECSqlQueryExecutor(createECSqlQueryExecutor(imodel), 1000),\n  };\n}\n"]}
+{"version":3,"file":"Utils.js","sourceRoot":"","sources":["../../../../../src/components/trees/common/Utils.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAC1C,OAAO,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AACpG,OAAO,EAAE,gCAAgC,EAAE,MAAM,iCAAiC,CAAC;AACnF,OAAO,EAAE,sCAAsC,EAAE,MAAM,4BAA4B,CAAC;AAMpF,gBAAgB;AAChB,MAAM,UAAU,iBAAiB,CAAC,GAAc;IAC9C,sHAAsH;IACtH,oCAAoC;IACpC,MAAM,MAAM,GAAG,IAAI,KAAK,EAAgB,CAAC;IACzC,KAAK,IAAI,eAAe,GAAG,CAAC,EAAE,eAAe,GAAG,GAAG,CAAC,MAAM,EAAE,eAAe,IAAI,GAAG,EAAE;QAClF,IAAI,aAAa,GAAuB,eAAe,GAAG,GAAG,CAAC;QAC9D,IAAI,aAAa,GAAG,GAAG,CAAC,MAAM,EAAE;YAC9B,aAAa,GAAG,SAAS,CAAC;SAC3B;QACD,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC,CAAC;KACxD;IACD,OAAO,cAAc,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,cAAc,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;AACzH,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,sBAAsB,CAAC,cAAmB;IACxD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE;QAClC,OAAO,EAAE,CAAC;KACX;IACD,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAA8B,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,EAAc,CAAC,CAAC;AAClJ,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,SAAS,CAAe,SAAiC,EAAE,GAAS,EAAE,KAAa;IACjG,IAAI,GAAG,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7B,IAAI,CAAC,GAAG,EAAE;QACR,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;QAChB,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;KACzB;IACD,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AACjB,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,kBAAkB,CAAC,EAAE,MAAM,EAAE,gBAAgB,EAA+F;IAC1J,MAAM,OAAO,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACzC,MAAM,cAAc,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAC;IACvD,OAAO;QACL,GAAG,cAAc;QACjB,GAAG,sCAAsC,CAAC,EAAE,cAAc,EAAE,CAAC;QAC7D,GAAG,gCAAgC,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC;KAC5E,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,SAAS,CAAI,KAAQ;IACnC,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1B,SAAS,CAAC,GAAG,EAAE;QACb,GAAG,CAAC,OAAO,GAAG,KAAK,CAAC;IACtB,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IACZ,OAAO,GAAG,CAAC;AACb,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 { useEffect, useRef } from \"react\";\nimport { createECSchemaProvider, createECSqlQueryExecutor } from \"@itwin/presentation-core-interop\";\nimport { createLimitingECSqlQueryExecutor } from \"@itwin/presentation-hierarchies\";\nimport { createCachingECClassHierarchyInspector } from \"@itwin/presentation-shared\";\n\nimport type { Id64Array, Id64String } from \"@itwin/core-bentley\";\nimport type { IModelConnection } from \"@itwin/core-frontend\";\nimport type { SchemaContext } from \"@itwin/ecschema-metadata\";\n\n/** @internal */\nexport function createIdsSelector(ids: Id64Array): string {\n  // Note: `json_array` function only accepts up to 127 arguments and we may have more `ids` than that. As a workaround,\n  // we're creating an array of arrays\n  const slices = new Array<Id64String[]>();\n  for (let sliceStartIndex = 0; sliceStartIndex < ids.length; sliceStartIndex += 127) {\n    let sliceEndIndex: number | undefined = sliceStartIndex + 127;\n    if (sliceEndIndex > ids.length) {\n      sliceEndIndex = undefined;\n    }\n    slices.push(ids.slice(sliceStartIndex, sliceEndIndex));\n  }\n  return `json_array(${slices.map((sliceIds) => `json_array(${sliceIds.map((id) => `'${id}'`).join(\",\")})`).join(\",\")})`;\n}\n\n/** @internal */\nexport function parseIdsSelectorResult(selectorResult: any): Id64Array {\n  if (!Array.isArray(selectorResult)) {\n    return [];\n  }\n  return selectorResult.reduce((arr, ids: Id64String | Id64String[]) => [...arr, ...(Array.isArray(ids) ? ids : [ids])], new Array<Id64String>());\n}\n\n/** @internal */\nexport function pushToMap<TKey, TValue>(targetMap: Map<TKey, Set<TValue>>, key: TKey, value: TValue) {\n  let set = targetMap.get(key);\n  if (!set) {\n    set = new Set();\n    targetMap.set(key, set);\n  }\n  set.add(value);\n}\n\n/** @internal */\nexport function createIModelAccess({ imodel, getSchemaContext }: { imodel: IModelConnection; getSchemaContext: (imodel: IModelConnection) => SchemaContext }) {\n  const schemas = getSchemaContext(imodel);\n  const schemaProvider = createECSchemaProvider(schemas);\n  return {\n    ...schemaProvider,\n    ...createCachingECClassHierarchyInspector({ schemaProvider }),\n    ...createLimitingECSqlQueryExecutor(createECSqlQueryExecutor(imodel), 1000),\n  };\n}\n\n/** @internal */\nexport function useLatest<T>(value: T) {\n  const ref = useRef(value);\n  useEffect(() => {\n    ref.current = value;\n  }, [value]);\n  return ref;\n}\n"]}

package/lib/esm/components/trees/common/components/Delayed.d.ts

@@ -1,5 +1,4 @@
 import type { PropsWithChildren } from "react";
-/** @internal */
 export declare function Delayed({ show, children }: PropsWithChildren<{
     show: boolean;
 }>): JSX.Element | null;

package/lib/esm/components/trees/common/components/Delayed.js

@@ -4,7 +4,6 @@ import { Fragment as _Fragment, jsx as _jsx } from "react/jsx-runtime";
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
 import { useLayoutEffect, useState } from "react";
-/** @internal */
 export function Delayed({ show, children }) {
     const [visible, setVisible] = useState(false);
     useLayoutEffect(() => {

package/lib/esm/components/trees/common/components/Delayed.js.map

@@ -1 +1 @@
-{"version":3,"file":"Delayed.js","sourceRoot":"","sources":["../../../../../../src/components/trees/common/components/Delayed.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAIlD,gBAAgB;AAChB,MAAM,UAAU,OAAO,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAwC;IAC9E,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAE9C,eAAe,CAAC,GAAG,EAAE;QACnB,IAAI,CAAC,IAAI,EAAE;YACT,UAAU,CAAC,KAAK,CAAC,CAAC;YAClB,OAAO;SACR;QAED,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;YAC5B,UAAU,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC,EAAE,GAAG,CAAC,CAAC;QACR,OAAO,GAAG,EAAE;YACV,YAAY,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IAEX,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,IAAI,CAAC;KACb;IAED,OAAO,4BAAG,QAAQ,GAAI,CAAC;AACzB,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 { useLayoutEffect, useState } from \"react\";\n\nimport type { PropsWithChildren } from \"react\";\n\n/** @internal */\nexport function Delayed({ show, children }: PropsWithChildren<{ show: boolean }>) {\n  const [visible, setVisible] = useState(false);\n\n  useLayoutEffect(() => {\n    if (!show) {\n      setVisible(false);\n      return;\n    }\n\n    const timer = setTimeout(() => {\n      setVisible(show);\n    }, 250);\n    return () => {\n      clearTimeout(timer);\n    };\n  }, [show]);\n\n  if (!visible) {\n    return null;\n  }\n\n  return <>{children}</>;\n}\n"]}
+{"version":3,"file":"Delayed.js","sourceRoot":"","sources":["../../../../../../src/components/trees/common/components/Delayed.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAIlD,MAAM,UAAU,OAAO,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAwC;IAC9E,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAE9C,eAAe,CAAC,GAAG,EAAE;QACnB,IAAI,CAAC,IAAI,EAAE;YACT,UAAU,CAAC,KAAK,CAAC,CAAC;YAClB,OAAO;SACR;QAED,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;YAC5B,UAAU,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC,EAAE,GAAG,CAAC,CAAC;QACR,OAAO,GAAG,EAAE;YACV,YAAY,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IAEX,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,IAAI,CAAC;KACb;IAED,OAAO,4BAAG,QAAQ,GAAI,CAAC;AACzB,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 { useLayoutEffect, useState } from \"react\";\n\nimport type { PropsWithChildren } from \"react\";\n\nexport function Delayed({ show, children }: PropsWithChildren<{ show: boolean }>) {\n  const [visible, setVisible] = useState(false);\n\n  useLayoutEffect(() => {\n    if (!show) {\n      setVisible(false);\n      return;\n    }\n\n    const timer = setTimeout(() => {\n      setVisible(show);\n    }, 250);\n    return () => {\n      clearTimeout(timer);\n    };\n  }, [show]);\n\n  if (!visible) {\n    return null;\n  }\n\n  return <>{children}</>;\n}\n"]}

package/lib/esm/components/trees/common/components/ProgressOverlay.d.ts

@@ -1,5 +1,4 @@
 /// <reference types="react" />
 import "./ProgressOverlay.scss";
-/** @internal */
 export declare function ProgressOverlay(): JSX.Element;
 //# sourceMappingURL=ProgressOverlay.d.ts.map

package/lib/esm/components/trees/common/components/ProgressOverlay.js

@@ -5,7 +5,6 @@ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
  *--------------------------------------------------------------------------------------------*/
 import "./ProgressOverlay.scss";
 import { ProgressLinear } from "@itwin/itwinui-react";
-/** @internal */
 export function ProgressOverlay() {
     return (_jsxs("div", { className: "tw-progress-overlay-container", children: [_jsx(ProgressLinear, { indeterminate: true }), _jsx("div", { className: "tw-progress-overlay-backdrop" })] }));
 }

package/lib/esm/components/trees/common/components/ProgressOverlay.js.map

@@ -1 +1 @@
-{"version":3,"file":"ProgressOverlay.js","sourceRoot":"","sources":["../../../../../../src/components/trees/common/components/ProgressOverlay.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAEhG,OAAO,wBAAwB,CAAC;AAChC,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD,gBAAgB;AAChB,MAAM,UAAU,eAAe;IAC7B,OAAO,CACL,eAAK,SAAS,EAAC,+BAA+B,aAC5C,KAAC,cAAc,IAAC,aAAa,SAAG,EAChC,cAAK,SAAS,EAAC,8BAA8B,GAAG,IAC5C,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 \"./ProgressOverlay.scss\";\nimport { ProgressLinear } from \"@itwin/itwinui-react\";\n\n/** @internal */\nexport function ProgressOverlay() {\n  return (\n    <div className=\"tw-progress-overlay-container\">\n      <ProgressLinear indeterminate />\n      <div className=\"tw-progress-overlay-backdrop\" />\n    </div>\n  );\n}\n"]}
+{"version":3,"file":"ProgressOverlay.js","sourceRoot":"","sources":["../../../../../../src/components/trees/common/components/ProgressOverlay.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAEhG,OAAO,wBAAwB,CAAC;AAChC,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD,MAAM,UAAU,eAAe;IAC7B,OAAO,CACL,eAAK,SAAS,EAAC,+BAA+B,aAC5C,KAAC,cAAc,IAAC,aAAa,SAAG,EAChC,cAAK,SAAS,EAAC,8BAA8B,GAAG,IAC5C,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 \"./ProgressOverlay.scss\";\nimport { ProgressLinear } from \"@itwin/itwinui-react\";\n\nexport function ProgressOverlay() {\n  return (\n    <div className=\"tw-progress-overlay-container\">\n      <ProgressLinear indeterminate />\n      <div className=\"tw-progress-overlay-backdrop\" />\n    </div>\n  );\n}\n"]}

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

@@ -0,0 +1,52 @@
+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 {
+    /** 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/esm/components/trees/common/components/{BaseTree.js → Tree.js}

@@ -6,28 +6,30 @@ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import { useCallback, useMemo } from "react";
 import { Flex, ProgressRadial, Text } from "@itwin/itwinui-react";
 import { SchemaMetadataContextProvider } from "@itwin/presentation-components";
-import { useSelectionHandler, useUnifiedSelectionTree } from "@itwin/presentation-hierarchies-react";
+import { UnifiedSelectionProvider, useSelectionHandler, useUnifiedSelectionTree } from "@itwin/presentation-hierarchies-react";
 import { TreeWidget } from "../../../../TreeWidget";
-import { useReportingAction } from "../UseFeatureReporting";
 import { useHierarchiesLocalization } from "../UseHierarchiesLocalization";
 import { useHierarchyLevelFiltering } from "../UseHierarchyFiltering";
 import { useIModelChangeListener } from "../UseIModelChangeListener";
 import { useNodeHighlighting } from "../UseNodeHighlighting";
+import { useReportingAction, useTelemetryContext } from "../UseTelemetryContext";
 import { createIModelAccess } from "../Utils";
 import { Delayed } from "./Delayed";
 import { ProgressOverlay } from "./ProgressOverlay";
-import { TreeRenderer } from "./TreeRenderer";
-/** @internal */
-export function BaseTree({ getSchemaContext, hierarchyLevelSizeLimit, imodelAccess: providedIModelAccess, ...props }) {
+/**
+ * Default tree component that manages tree state and renders using supplied `treeRenderer`.
+ * @Beta
+ */
+export function Tree({ getSchemaContext, hierarchyLevelSizeLimit, selectionStorage, imodelAccess: providedIModelAccess, ...props }) {
     const defaultHierarchyLevelSizeLimit = hierarchyLevelSizeLimit ?? 1000;
     const imodelAccess = useMemo(() => {
         return providedIModelAccess ?? createIModelAccess({ getSchemaContext, imodel: props.imodel });
     }, [providedIModelAccess, getSchemaContext, props.imodel]);
-    return (_jsx(SchemaMetadataContextProvider, { imodel: props.imodel, schemaContextProvider: getSchemaContext, children: _jsx(BaseTreeRenderer, { ...props, imodelAccess: imodelAccess, defaultHierarchyLevelSizeLimit: defaultHierarchyLevelSizeLimit }) }));
+    return (_jsx(SchemaMetadataContextProvider, { imodel: props.imodel, schemaContextProvider: getSchemaContext, children: _jsx(UnifiedSelectionProvider, { storage: selectionStorage, children: _jsx(TreeImpl, { ...props, imodelAccess: imodelAccess, defaultHierarchyLevelSizeLimit: defaultHierarchyLevelSizeLimit }) }) }));
 }
-/** @internal */
-function BaseTreeRenderer({ imodel, imodelAccess, height, width, treeName, noDataMessage, getFilteredPaths, defaultHierarchyLevelSizeLimit, getHierarchyDefinition, selectionMode, onPerformanceMeasured, reportUsage, treeRenderer, density, getIcon, getSublabel, onNodeDoubleClick, searchText, }) {
+function TreeImpl({ imodel, imodelAccess, treeName, noDataMessage, getFilteredPaths, defaultHierarchyLevelSizeLimit, getHierarchyDefinition, selectionMode, onReload, treeRenderer, density, highlight, }) {
     const localizedStrings = useHierarchiesLocalization();
+    const { onFeatureUsed, onPerformanceMeasured } = useTelemetryContext();
     const { rootNodes, isLoading, selectNodes, setFormatter: _setFormatter, expandNode, ...treeProps } = useUnifiedSelectionTree({
         imodelAccess,
         getHierarchyDefinition,
@@ -35,26 +37,31 @@ function BaseTreeRenderer({ imodel, imodelAccess, height, width, treeName, noDat
         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 }),
+        onHierarchyLoadError: ({ type }) => onFeatureUsed({ featureId: `error-${type}`, reportInteraction: false }),
     });
     const reloadTree = treeProps.reloadTree;
     useIModelChangeListener({ imodel, action: useCallback(() => reloadTree({ dataSourceChanged: true }), [reloadTree]) });
-    const reportingSelectNodes = useReportingAction({ action: selectNodes, reportUsage });
+    const reportingSelectNodes = useReportingAction({ action: selectNodes });
     const { onNodeClick, onNodeKeyDown } = useSelectionHandler({ rootNodes, selectNodes: reportingSelectNodes, selectionMode: selectionMode ?? "single" });
     const { filteringDialog, onFilterClick } = useHierarchyLevelFiltering({
         imodel,
         defaultHierarchyLevelSizeLimit,
-        reportUsage,
     });
-    const reportingExpandNode = useReportingAction({ action: expandNode, reportUsage });
-    const reportingOnFilterClicked = useReportingAction({ action: onFilterClick, reportUsage });
-    const { getLabel } = useNodeHighlighting({ rootNodes, searchText });
+    const reportingExpandNode = useReportingAction({ action: expandNode });
+    const reportingOnFilterClicked = useReportingAction({ action: onFilterClick });
+    const { getLabel } = useNodeHighlighting({ rootNodes, highlight });
     if (rootNodes === undefined) {
-        return (_jsx(Flex, { alignItems: "center", justifyContent: "center", flexDirection: "column", style: { width, height }, children: _jsx(Delayed, { show: true, children: _jsx(ProgressRadial, { size: "large" }) }) }));
+        return (_jsx(Flex, { alignItems: "center", justifyContent: "center", flexDirection: "column", style: { width: "100%", height: "100%" }, children: _jsx(Delayed, { show: true, children: _jsx(ProgressRadial, { size: "large" }) }) }));
     }
     if (rootNodes.length === 0 && !isLoading) {
-        return (_jsx(Flex, { alignItems: "center", justifyContent: "center", flexDirection: "column", style: { width, height }, children: noDataMessage ? noDataMessage : _jsx(Text, { children: TreeWidget.translate("baseTree.dataIsNotAvailable") }) }));
+        return (_jsx(Flex, { alignItems: "center", justifyContent: "center", flexDirection: "column", style: { width: "100%", height: "100%" }, children: noDataMessage ? noDataMessage : _jsx(Text, { children: TreeWidget.translate("baseTree.dataIsNotAvailable") }) }));
     }
     const treeRendererProps = {
         ...treeProps,
@@ -63,12 +70,9 @@ function BaseTreeRenderer({ imodel, imodelAccess, height, width, treeName, noDat
         onNodeKeyDown,
         expandNode: reportingExpandNode,
         onFilterClick: reportingOnFilterClicked,
-        getIcon,
         getLabel,
-        getSublabel,
-        onNodeDoubleClick,
         size: density === "enlarged" ? "default" : "small",
     };
-    return (_jsxs("div", { style: { position: "relative", height, overflow: "hidden" }, children: [_jsxs("div", { id: "tw-tree-renderer-container", style: { overflow: "auto", height: "100%" }, children: [treeRenderer ? treeRenderer(treeRendererProps) : _jsx(TreeRenderer, { ...treeRendererProps }), filteringDialog] }), _jsx(Delayed, { show: isLoading, children: _jsx(ProgressOverlay, {}) })] }));
+    return (_jsxs("div", { style: { position: "relative", height: "100%", overflow: "hidden" }, children: [_jsxs("div", { id: "tw-tree-renderer-container", style: { overflow: "auto", height: "100%" }, children: [treeRenderer(treeRendererProps), filteringDialog] }), _jsx(Delayed, { show: isLoading, children: _jsx(ProgressOverlay, {}) })] }));
 }
-//# sourceMappingURL=BaseTree.js.map
+//# sourceMappingURL=Tree.js.map

package/lib/esm/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,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAC7C,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAClE,OAAO,EAAE,6BAA6B,EAAE,MAAM,gCAAgC,CAAC;AAC/E,OAAO,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAC/H,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,0BAA0B,EAAE,MAAM,0BAA0B,CAAC;AACtE,OAAO,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AACjF,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AA2DpD;;;GAGG;AACH,MAAM,UAAU,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,OAAO,CAAC,GAAG,EAAE;QAChC,OAAO,oBAAoB,IAAI,kBAAkB,CAAC,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,KAAC,6BAA6B,IAAC,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,qBAAqB,EAAE,gBAAgB,YAC1F,KAAC,wBAAwB,IAAC,OAAO,EAAE,gBAAgB,YACjD,KAAC,QAAQ,OAAK,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,8BAA8B,EAAE,8BAA8B,GAAI,GAC1F,GACG,CACjC,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CAAC,EAChB,MAAM,EACN,YAAY,EACZ,QAAQ,EACR,aAAa,EACb,gBAAgB,EAChB,8BAA8B,EAC9B,sBAAsB,EACtB,aAAa,EACb,QAAQ,EACR,YAAY,EACZ,OAAO,EACP,SAAS,GAC2H;IACpI,MAAM,gBAAgB,GAAG,0BAA0B,EAAE,CAAC;IACtD,MAAM,EAAE,aAAa,EAAE,qBAAqB,EAAE,GAAG,mBAAmB,EAAE,CAAC;IACvE,MAAM,EACJ,SAAS,EACT,SAAS,EACT,WAAW,EACX,YAAY,EAAE,aAAa,EAC3B,UAAU,EACV,GAAG,SAAS,EACb,GAAG,uBAAuB,CAAC;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;QACxH,oBAAoB,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,aAAa,CAAC,EAAE,SAAS,EAAE,SAAS,IAAI,EAAE,EAAE,iBAAiB,EAAE,KAAK,EAAE,CAAC;KAC5G,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,SAAS,CAAC,UAAU,CAAC;IACxC,uBAAuB,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC;IACtH,MAAM,oBAAoB,GAAG,kBAAkB,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;IACzE,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,GAAG,mBAAmB,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,oBAAoB,EAAE,aAAa,EAAE,aAAa,IAAI,QAAQ,EAAE,CAAC,CAAC;IACvJ,MAAM,EAAE,eAAe,EAAE,aAAa,EAAE,GAAG,0BAA0B,CAAC;QACpE,MAAM;QACN,8BAA8B;KAC/B,CAAC,CAAC;IACH,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;IACvE,MAAM,wBAAwB,GAAG,kBAAkB,CAAC,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;IAC/E,MAAM,EAAE,QAAQ,EAAE,GAAG,mBAAmB,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC;IAEnE,IAAI,SAAS,KAAK,SAAS,EAAE;QAC3B,OAAO,CACL,KAAC,IAAI,IAAC,UAAU,EAAC,QAAQ,EAAC,cAAc,EAAC,QAAQ,EAAC,aAAa,EAAC,QAAQ,EAAC,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,YAC/G,KAAC,OAAO,IAAC,IAAI,EAAE,IAAI,YACjB,KAAC,cAAc,IAAC,IAAI,EAAC,OAAO,GAAG,GACvB,GACL,CACR,CAAC;KACH;IAED,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE;QACxC,OAAO,CACL,KAAC,IAAI,IAAC,UAAU,EAAC,QAAQ,EAAC,cAAc,EAAC,QAAQ,EAAC,aAAa,EAAC,QAAQ,EAAC,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,YAC9G,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,KAAC,IAAI,cAAE,UAAU,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,eAAK,KAAK,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,aACtE,eAAK,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,KAAC,OAAO,IAAC,IAAI,EAAE,SAAS,YACtB,KAAC,eAAe,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  /** 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  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    onHierarchyLoadError: ({ type }) => onFeatureUsed({ featureId: `error-${type}`, 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: \"100%\", height: \"100%\" }}>\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: \"100%\", height: \"100%\" }}>\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: \"100%\", 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/esm/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/esm/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,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,2BAA2B,EAAE,MAAM,uCAAuC,CAAC;AAqBpF,gBAAgB;AAChB,MAAM,UAAU,gBAAgB,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,GAAG,KAAK,EAAyB;IAC7G,IAAI,MAAM,IAAI,IAAI,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,EAAE;QACxD,OAAO,IAAI,CAAC;KACb;IAED,MAAM,aAAa,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC7C,OAAO,CACL,KAAC,QAAQ,OACH,KAAK,EACT,SAAS,EAAE,EAAE,CAAC,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","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,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,2BAA2B,EAAE,MAAM,uCAAuC,CAAC;AA2BpF,gBAAgB;AAChB,MAAM,UAAU,gBAAgB,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,GAAG,KAAK,EAAsD;IAC1I,IAAI,MAAM,IAAI,IAAI,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,EAAE;QACxD,OAAO,IAAI,CAAC;KACb;IAED,MAAM,aAAa,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC7C,OAAO,CACL,KAAC,QAAQ,OACH,KAAK,EACT,SAAS,EAAE,EAAE,CAAC,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","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/esm/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/esm/components/trees/common/components/TreeNodeRenderer.js

@@ -6,7 +6,7 @@ import { jsx as _jsx } from "react/jsx-runtime";
 import cx from "classnames";
 import { TreeNodeRenderer as CoreTreeNodeRenderer } from "@itwin/presentation-hierarchies-react";
 import { TreeNodeCheckbox } from "./TreeNodeCheckbox";
-/** @internal */
+/** @beta */
 export function TreeNodeRenderer({ checkboxProps, ...props }) {
     return (_jsx(CoreTreeNodeRenderer, { ...props, nodeProps: { className: cx("tw-tree-node", props.isSelected && "selected", props.className) }, actionButtonsClassName: "tw-tree-node-action-buttons", checkbox: checkboxProps ? _jsx(TreeNodeCheckbox, { ...checkboxProps, node: props.node }) : null, contentProps: { className: "tw-tree-node-content" }, checkboxProps: { className: "tw-tree-node-checkbox-container" } }));
 }

package/lib/esm/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,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,gBAAgB,IAAI,oBAAoB,EAAE,MAAM,uCAAuC,CAAC;AACjG,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAatD,gBAAgB;AAChB,MAAM,UAAU,gBAAgB,CAAC,EAAE,aAAa,EAAE,GAAG,KAAK,EAAyB;IACjF,OAAO,CACL,KAAC,oBAAoB,OACf,KAAK,EACT,SAAS,EAAE,EAAE,SAAS,EAAE,EAAE,CAAC,cAAc,EAAE,KAAK,CAAC,UAAU,IAAI,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,EAAE,EAC7F,sBAAsB,EAAC,6BAA6B,EACpD,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,KAAC,gBAAgB,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","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,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,gBAAgB,IAAI,oBAAoB,EAAE,MAAM,uCAAuC,CAAC;AACjG,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AActD,YAAY;AACZ,MAAM,UAAU,gBAAgB,CAAC,EAAE,aAAa,EAAE,GAAG,KAAK,EAAyB;IACjF,OAAO,CACL,KAAC,oBAAoB,OACf,KAAK,EACT,SAAS,EAAE,EAAE,SAAS,EAAE,EAAE,CAAC,cAAc,EAAE,KAAK,CAAC,UAAU,IAAI,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,EAAE,EAC7F,sBAAsB,EAAC,6BAA6B,EACpD,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,KAAC,gBAAgB,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","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/esm/components/trees/common/components/TreeRenderer.d.ts

@@ -3,15 +3,25 @@ import { Tree } from "@itwin/itwinui-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;
 }
+/** @beta */
 type TreeRendererProps = Pick<TreeNodeRendererProps, "expandNode" | "onNodeClick" | "onNodeKeyDown" | "onFilterClick" | "getIcon" | "getLabel" | "getSublabel" | "getHierarchyLevelDetails" | "checkboxProps" | "reloadTree"> & Omit<TreeProps<RenderedTreeNode>, "data" | "nodeRenderer" | "getNode"> & TreeRendererOwnProps;
-/** @internal */
+/**
+ * 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>;
 export {};
 //# sourceMappingURL=TreeRenderer.d.ts.map

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

@@ -9,7 +9,10 @@ import { Tree } from "@itwin/itwinui-react";
 import { createRenderedTreeNodeData, LocalizationContextProvider } from "@itwin/presentation-hierarchies-react";
 import { useHierarchiesLocalization } from "../UseHierarchiesLocalization";
 import { TreeNodeRenderer } from "./TreeNodeRenderer";
-/** @internal */
+/**
+ * Default renderer for rendering tree data.
+ * @beta
+ */
 export function TreeRenderer({ rootNodes, expandNode, onNodeClick, onNodeKeyDown, onNodeDoubleClick, isNodeSelected, onFilterClick, getIcon, getLabel, getSublabel, getHierarchyLevelDetails, checkboxProps, reloadTree, ...props }) {
     const localizedStrings = useHierarchiesLocalization();
     const nodeRenderer = useCallback((nodeProps) => {

package/lib/esm/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,OAAO,qBAAqB,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAC5C,OAAO,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,MAAM,uCAAuC,CAAC;AAChH,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AA0BtD,gBAAgB;AAChB,MAAM,UAAU,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,0BAA0B,EAAE,CAAC;IACtD,MAAM,YAAY,GAAG,WAAW,CAC9B,CAAC,SAAS,EAAE,EAAE;QACZ,OAAO,CACL,KAAC,gBAAgB,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,WAAW,CAAyC,CAAC,IAAI,EAAE,EAAE,CAAC,0BAA0B,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC;IAElJ,OAAO,CACL,KAAC,2BAA2B,IAAC,gBAAgB,EAAE,gBAAgB,YAC7D,KAAC,IAAI,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","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\";\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\"\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/** @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  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\ntype TreeProps<T> = ComponentPropsWithoutRef<typeof Tree<T>>;\ntype TreeNodeRendererProps = ComponentPropsWithoutRef<typeof TreeNodeRenderer>;\n"]}
+{"version":3,"file":"TreeRenderer.js","sourceRoot":"","sources":["../../../../../../src/components/trees/common/components/TreeRenderer.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAEhG,OAAO,qBAAqB,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAC5C,OAAO,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,MAAM,uCAAuC,CAAC;AAChH,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAgCtD;;;GAGG;AACH,MAAM,UAAU,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,0BAA0B,EAAE,CAAC;IACtD,MAAM,YAAY,GAAG,WAAW,CAC9B,CAAC,SAAS,EAAE,EAAE;QACZ,OAAO,CACL,KAAC,gBAAgB,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,WAAW,CAAyC,CAAC,IAAI,EAAE,EAAE,CAAC,0BAA0B,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC;IAElJ,OAAO,CACL,KAAC,2BAA2B,IAAC,gBAAgB,EAAE,gBAAgB,YAC7D,KAAC,IAAI,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","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/esm/components/trees/common/components/VisibilityTree.d.ts

@@ -1,14 +1,31 @@
-import { useHierarchyVisibility } from "../UseHierarchyVisibility";
-import { BaseTree } from "./BaseTree";
+import { Tree } from "./Tree";
+import type { ComponentPropsWithoutRef, ReactNode } 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) => 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