@itwin/presentation-hierarchies-react 2.0.0-alpha.52 → 2.0.0-alpha.54

package/lib/esm/presentation-hierarchies-react/UseTree.d.ts

@@ -1,8 +1,10 @@
+import { TreeNode } from "./TreeNode.js";
+import { RootErrorRendererProps, TreeRendererProps } from "./Renderers.js";
+import { UseUnifiedTreeSelectionProps } from "./internal/UseUnifiedSelection.js";
 import { GenericInstanceFilter, HierarchyProvider, HierarchySearchPath } from "@itwin/presentation-hierarchies";
 import { IPrimitiveValueFormatter } from "@itwin/presentation-shared";
-import { UseUnifiedTreeSelectionProps } from "./internal/UseUnifiedSelection.js";
-import { RootErrorRendererProps, TreeRendererProps } from "./Renderers.js";
-import { TreeNode } from "./TreeNode.js";
+
+//#region src/presentation-hierarchies-react/UseTree.d.ts
 /**
  * A React hook that creates state for a tree component.
  *
@@ -15,7 +17,7 @@ import { TreeNode } from "./TreeNode.js";
  * @see `useIModelTree`
  * @public
  */
-export declare function useTree(props: UseTreeProps): UseTreeResult;
+declare function useTree(props: UseTreeProps): UseTreeResult;
 /**
  * A React hook that creates state for a tree component, that is integrated with unified selection
  * through the given selection storage (previously the storage was provided through the, now
@@ -31,64 +33,75 @@ export declare function useTree(props: UseTreeProps): UseTreeResult;
  * @see `UnifiedSelectionProvider`
  * @public
  */
-export declare function useUnifiedSelectionTree({ sourceName, selectionStorage, createSelectableForGenericNode, ...props }: UseTreeProps & UseUnifiedTreeSelectionProps): UseTreeResult;
+declare function useUnifiedSelectionTree({
+  sourceName,
+  selectionStorage,
+  createSelectableForGenericNode,
+  ...props
+}: UseTreeProps & UseUnifiedTreeSelectionProps): UseTreeResult;
 /** @public */
-export interface UseTreeProps {
-    /** Provides the hierarchy provider for the tree. */
-    getHierarchyProvider: () => HierarchyProvider;
-    /** Provides paths to search nodes. */
-    getSearchPaths?: ({ abortSignal }: {
-        abortSignal: AbortSignal;
-    }) => Promise<HierarchySearchPath[] | undefined>;
-    /**
-     * Callback that is called just after a certain action is finished.
-     * Can be used for performance tracking.
-     */
-    onPerformanceMeasured?: (action: "initial-load" | "hierarchy-level-load" | "reload", duration: number) => void;
-    /** Action to perform when hierarchy level contains more items that the specified limit. */
-    onHierarchyLimitExceeded?: (props: {
-        parentId?: string;
-        filter?: GenericInstanceFilter;
-        limit?: number | "unbounded";
-    }) => void;
-    /** Action to perform when an error occurs while loading hierarchy. */
-    onHierarchyLoadError?: (props: {
-        parentId?: string;
-        type: "timeout" | "unknown";
-        error: unknown;
-    }) => void;
+interface UseTreeProps {
+  /** Provides the hierarchy provider for the tree. */
+  getHierarchyProvider: () => HierarchyProvider;
+  /** Provides paths to search nodes. */
+  getSearchPaths?: ({
+    abortSignal
+  }: {
+    abortSignal: AbortSignal;
+  }) => Promise<HierarchySearchPath[] | undefined>;
+  /**
+   * Callback that is called just after a certain action is finished.
+   * Can be used for performance tracking.
+   */
+  onPerformanceMeasured?: (action: "initial-load" | "hierarchy-level-load" | "reload", duration: number) => void;
+  /** Action to perform when hierarchy level contains more items that the specified limit. */
+  onHierarchyLimitExceeded?: (props: {
+    parentId?: string;
+    filter?: GenericInstanceFilter;
+    limit?: number | "unbounded";
+  }) => void;
+  /** Action to perform when an error occurs while loading hierarchy. */
+  onHierarchyLoadError?: (props: {
+    parentId?: string;
+    type: "timeout" | "unknown";
+    error: unknown;
+  }) => void;
 }
 /** @public */
-export type UseTreeResult = {
-    /**
-     * Specifies whether tree is reloading or not. It is set to `false` when initial tree load is in progress to check if
-     * or tree is reloading.
-     */
-    isReloading: boolean;
-    /** Get a tree node by id */
-    getNode: (nodeId: string) => TreeNode | undefined;
-    /** Sets a formatter for the primitive values that are displayed in the hierarchy. */
-    setFormatter: (formatter: IPrimitiveValueFormatter | undefined) => void;
+type UseTreeResult = {
+  /**
+   * Specifies whether tree is reloading or not. It is set to `false` when initial tree load is in progress to check if
+   * or tree is reloading.
+   */
+  isReloading: boolean;
+  /**
+   * Get a tree node by id
+   */
+  getNode: (nodeId: string) => TreeNode | undefined;
+  /**
+   * Sets a formatter for the primitive values that are displayed in the hierarchy.
+   */
+  setFormatter: (formatter: IPrimitiveValueFormatter | undefined) => void;
 } & RendererProps;
 /**.
  * @alpha
  */
 type RendererProps = {
-    /**
-     * An object containing information used to render root error handling UI.
-     * Use in combination with `RootErrorRenderer` or your custom implementation.
-     * Defined when root nodes fail to load.
-     */
-    rootErrorRendererProps: RootErrorRendererProps;
+  /**
+   * An object containing information used to render root error handling UI.
+   * Use in combination with `RootErrorRenderer` or your custom implementation.
+   * Defined when root nodes fail to load.
+   */
+  rootErrorRendererProps: RootErrorRendererProps;
 } | {
-    /** Is undefined when rootNodes where successfully loaded or are in initial loading process */
-    rootErrorRendererProps: undefined;
-    /**
-     * An object containing information used to render tree.
-     * Use with `TreeRenderer` or your custom implementation.
-     * Is undefined on initial loading process.
-     */
-    treeRendererProps?: TreeRendererProps;
+  /** Is undefined when rootNodes where successfully loaded or are in initial loading process */rootErrorRendererProps: undefined;
+  /**
+   * An object containing information used to render tree.
+   * Use with `TreeRenderer` or your custom implementation.
+   * Is undefined on initial loading process.
+   */
+  treeRendererProps?: TreeRendererProps;
 };
-export {};
+//#endregion
+export { UseTreeProps, UseTreeResult, useTree, useUnifiedSelectionTree };
 //# sourceMappingURL=UseTree.d.ts.map

package/lib/esm/presentation-hierarchies-react/UseTree.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UseTree.d.ts","sourceRoot":"","sources":["../../../src/presentation-hierarchies-react/UseTree.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,qBAAqB,EAAiB,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAC/H,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAGtE,OAAO,EAA2B,4BAA4B,EAAE,MAAM,mCAAmC,CAAC;AAE1G,OAAO,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAC3E,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAIzC;;;;;;;;;;;GAWG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,YAAY,GAAG,aAAa,CAG1D;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,uBAAuB,CAAC,EACtC,UAAU,EACV,gBAAgB,EAChB,8BAA8B,EAC9B,GAAG,KAAK,EACT,EAAE,YAAY,GAAG,4BAA4B,GAAG,aAAa,CAa7D;AAED,cAAc;AACd,MAAM,WAAW,YAAY;IAC3B,oDAAoD;IACpD,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;IAC9C,sCAAsC;IACtC,cAAc,CAAC,EAAE,CAAC,EAAE,WAAW,EAAE,EAAE;QAAE,WAAW,EAAE,WAAW,CAAA;KAAE,KAAK,OAAO,CAAC,mBAAmB,EAAE,GAAG,SAAS,CAAC,CAAC;IAC/G;;;OAGG;IACH,qBAAqB,CAAC,EAAE,CAAC,MAAM,EAAE,cAAc,GAAG,sBAAsB,GAAG,QAAQ,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/G,2FAA2F;IAC3F,wBAAwB,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,qBAAqB,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;KAAE,KAAK,IAAI,CAAC;IAChI,sEAAsE;IACtE,oBAAoB,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,SAAS,GAAG,SAAS,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAE,KAAK,IAAI,CAAC;CAC5G;AAED,cAAc;AACd,MAAM,MAAM,aAAa,GAAG;IAC1B;;;OAGG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB,4BAA4B;IAC5B,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,QAAQ,GAAG,SAAS,CAAC;IAClD,qFAAqF;IACrF,YAAY,EAAE,CAAC,SAAS,EAAE,wBAAwB,GAAG,SAAS,KAAK,IAAI,CAAC;CACzE,GAAG,aAAa,CAAC;AAElB;;GAEG;AACH,KAAK,aAAa,GACd;IACE;;;;OAIG;IACH,sBAAsB,EAAE,sBAAsB,CAAC;CAChD,GACD;IACE,8FAA8F;IAC9F,sBAAsB,EAAE,SAAS,CAAC;IAClC;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;CACvC,CAAC"}
+{"version":3,"file":"UseTree.d.ts","names":[],"sources":["../../../src/presentation-hierarchies-react/UseTree.ts"],"mappings":";;;;;;;;;AAiCA;;;;;;;;;AAoBA;iBApBgB,OAAA,CAAQ,KAAA,EAAO,YAAA,GAAe,aAAA;;;;;;;;;;;;;;;;iBAoB9B,uBAAA,CAAA;EACd,UAAA;EACA,gBAAA;EACA,8BAAA;EAAA,GACG;AAAA,GACF,YAAA,GAAe,4BAAA,GAA+B,aAAA;;UAgBhC,YAAA;EAhBgC;EAkB/C,oBAAA,QAA4B,iBAAA;EAlBgC;EAoB5D,cAAA;IAAoB;EAAA;IAAiB,WAAA,EAAa,WAAA;EAAA,MAAkB,OAAA,CAAQ,mBAAA;EAFhD;;;;EAO5B,qBAAA,IAAyB,MAAA,sDAA4D,QAAA;EAEpB;EAAjE,wBAAA,IAA4B,KAAA;IAAS,QAAA;IAAmB,MAAA,GAAS,qBAAA;IAAuB,KAAA;EAAA;EAPpE;EASpB,oBAAA,IAAwB,KAAA;IAAS,QAAA;IAAmB,IAAA;IAA6B,KAAA;EAAA;AAAA;;KAIvE,aAAA;EANV;;;;EAWA,WAAA;EAX4B;;;EAe5B,OAAA,GAAU,MAAA,aAAmB,QAAA;EAboD;;;EAiBjF,YAAA,GAAe,SAAA,EAAW,wBAAA;AAAA,IACxB,aAAA;;;;KAKC,aAAA;EALD;;;;;EAYE,sBAAA,EAAwB,sBAAA;AAAA;EAb5B,8FAiBI,sBAAA;EAjBW;;;;AACC;EAsBZ,iBAAA,GAAoB,iBAAA;AAAA"}