@itwin/components-react 3.6.0-dev.36 → 3.6.0-dev.40

package/lib/esm/components-react/tree/controlled/TreeEvents.d.ts

@@ -1,109 +1,109 @@
-/** @packageDocumentation
- * @module Tree
- */
-import { CheckBoxState } from "@itwin/core-react";
-import { TreeNodeItem } from "../TreeDataProvider";
-import { Observable, Subscription } from "./Observable";
-/**
- * Tree events that can occur while interacting with tree.
- *
- * **Note:** Selection and checkbox state change events payload is an Observable.
- * Observable is a stream of data over time (e.g. in case of selection replaced event
- * it is a stream of selected node items arrays). To access data inside stream `subscribe()` method
- * should be called. This method accepts any subset of 'next', 'error' and 'complete' callbacks.
- * Once subscribe is called observable will start emitting data and calls 'next' callback each time new
- * data is emitted. If some selected nodes are not loaded yet they will be loaded and observable will
- * emit loaded node items. When all selected node items are emitted observable completes and calls
- * 'complete' callback if supplied.
- *
- * @public
- */
-export interface TreeEvents {
-    /** Called when tree node is expanded. */
-    onNodeExpanded?(event: TreeNodeEventArgs): void;
-    /** Called when tree node is collapsed. */
-    onNodeCollapsed?(event: TreeNodeEventArgs): void;
-    /** Called when selected tree node is clicked. */
-    onDelayedNodeClick?(event: TreeNodeEventArgs): void;
-    /** Called when selected tree node editor is activated. */
-    onNodeEditorActivated?(event: TreeNodeEventArgs): void;
-    /**
-     * Called when tree selection is modified.
-     * If Subscription is returned it can be used to stop event handling by calling `unsubscribe()`.
-     */
-    onSelectionModified?(event: TreeSelectionModificationEventArgs): Subscription | undefined;
-    /**
-     * Called when tree selection is replaced.
-     * If Subscription is returned it can be used to stop event handling by calling `unsubscribe()`.
-     */
-    onSelectionReplaced?(event: TreeSelectionReplacementEventArgs): Subscription | undefined;
-    /**
-     * Called when checkbox states for nodes are changed.
-     * If Subscription is returned it can be used to stop event handling by calling `unsubscribe()`.
-     */
-    onCheckboxStateChanged?(event: TreeCheckboxStateChangeEventArgs): Subscription | undefined;
-}
-/**
- * Data structure that describes tree node event payload.
- * @public
- */
-export interface TreeNodeEventArgs {
-    /** Id of node that is affected by event. */
-    nodeId: string;
-}
-/**
- * Data structure that describes tree selection modification event payload.
- * @public
- */
-export interface TreeSelectionModificationEventArgs {
-    /**
-     * An observable that emits tree selection changes.
-     * It starts emitting values when '.subscribe()' is called.
-     */
-    modifications: Observable<TreeSelectionChange>;
-}
-/**
- * Data structure that describes tree selection change.
- * @public
- */
-export interface TreeSelectionChange {
-    /** Tree node items that where selected. */
-    selectedNodeItems: TreeNodeItem[];
-    /** Tree node items that where deselected. */
-    deselectedNodeItems: TreeNodeItem[];
-}
-/**
- * Data structure that describes tree selection replacement event payload.
- * @public
- */
-export interface TreeSelectionReplacementEventArgs {
-    /**
-     * An observable that emits tree selection replacements containing selected tree node items.
-     * It starts emitting values when '.subscribe()' is called.
-     */
-    replacements: Observable<{
-        selectedNodeItems: TreeNodeItem[];
-    }>;
-}
-/**
- * Data structure that describes tree checkbox state change event payload.
- * @public
- */
-export interface TreeCheckboxStateChangeEventArgs {
-    /**
-     * An observable that emits checkbox state changes.
-     * It starts emitting values when '.subscribe()' is called.
-     */
-    stateChanges: Observable<CheckboxStateChange[]>;
-}
-/**
- * Data structure that describes checkbox state change.
- * @public
- */
-export interface CheckboxStateChange {
-    /** Tree node item that was affected by checkbox state change. */
-    nodeItem: TreeNodeItem;
-    /** New state of the checkbox. */
-    newState: CheckBoxState;
-}
+/** @packageDocumentation
+ * @module Tree
+ */
+import { CheckBoxState } from "@itwin/core-react";
+import { TreeNodeItem } from "../TreeDataProvider";
+import { Observable, Subscription } from "./Observable";
+/**
+ * Tree events that can occur while interacting with tree.
+ *
+ * **Note:** Selection and checkbox state change events payload is an Observable.
+ * Observable is a stream of data over time (e.g. in case of selection replaced event
+ * it is a stream of selected node items arrays). To access data inside stream `subscribe()` method
+ * should be called. This method accepts any subset of 'next', 'error' and 'complete' callbacks.
+ * Once subscribe is called observable will start emitting data and calls 'next' callback each time new
+ * data is emitted. If some selected nodes are not loaded yet they will be loaded and observable will
+ * emit loaded node items. When all selected node items are emitted observable completes and calls
+ * 'complete' callback if supplied.
+ *
+ * @public
+ */
+export interface TreeEvents {
+    /** Called when tree node is expanded. */
+    onNodeExpanded?(event: TreeNodeEventArgs): void;
+    /** Called when tree node is collapsed. */
+    onNodeCollapsed?(event: TreeNodeEventArgs): void;
+    /** Called when selected tree node is clicked. */
+    onDelayedNodeClick?(event: TreeNodeEventArgs): void;
+    /** Called when selected tree node editor is activated. */
+    onNodeEditorActivated?(event: TreeNodeEventArgs): void;
+    /**
+     * Called when tree selection is modified.
+     * If Subscription is returned it can be used to stop event handling by calling `unsubscribe()`.
+     */
+    onSelectionModified?(event: TreeSelectionModificationEventArgs): Subscription | undefined;
+    /**
+     * Called when tree selection is replaced.
+     * If Subscription is returned it can be used to stop event handling by calling `unsubscribe()`.
+     */
+    onSelectionReplaced?(event: TreeSelectionReplacementEventArgs): Subscription | undefined;
+    /**
+     * Called when checkbox states for nodes are changed.
+     * If Subscription is returned it can be used to stop event handling by calling `unsubscribe()`.
+     */
+    onCheckboxStateChanged?(event: TreeCheckboxStateChangeEventArgs): Subscription | undefined;
+}
+/**
+ * Data structure that describes tree node event payload.
+ * @public
+ */
+export interface TreeNodeEventArgs {
+    /** Id of node that is affected by event. */
+    nodeId: string;
+}
+/**
+ * Data structure that describes tree selection modification event payload.
+ * @public
+ */
+export interface TreeSelectionModificationEventArgs {
+    /**
+     * An observable that emits tree selection changes.
+     * It starts emitting values when '.subscribe()' is called.
+     */
+    modifications: Observable<TreeSelectionChange>;
+}
+/**
+ * Data structure that describes tree selection change.
+ * @public
+ */
+export interface TreeSelectionChange {
+    /** Tree node items that where selected. */
+    selectedNodeItems: TreeNodeItem[];
+    /** Tree node items that where deselected. */
+    deselectedNodeItems: TreeNodeItem[];
+}
+/**
+ * Data structure that describes tree selection replacement event payload.
+ * @public
+ */
+export interface TreeSelectionReplacementEventArgs {
+    /**
+     * An observable that emits tree selection replacements containing selected tree node items.
+     * It starts emitting values when '.subscribe()' is called.
+     */
+    replacements: Observable<{
+        selectedNodeItems: TreeNodeItem[];
+    }>;
+}
+/**
+ * Data structure that describes tree checkbox state change event payload.
+ * @public
+ */
+export interface TreeCheckboxStateChangeEventArgs {
+    /**
+     * An observable that emits checkbox state changes.
+     * It starts emitting values when '.subscribe()' is called.
+     */
+    stateChanges: Observable<CheckboxStateChange[]>;
+}
+/**
+ * Data structure that describes checkbox state change.
+ * @public
+ */
+export interface CheckboxStateChange {
+    /** Tree node item that was affected by checkbox state change. */
+    nodeItem: TreeNodeItem;
+    /** New state of the checkbox. */
+    newState: CheckBoxState;
+}
 //# sourceMappingURL=TreeEvents.d.ts.map

package/lib/esm/components-react/tree/controlled/TreeEvents.js

@@ -1,9 +1,9 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Tree
- */
-export {};
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Tree
+ */
+export {};
 //# sourceMappingURL=TreeEvents.js.map

package/lib/esm/components-react/tree/controlled/TreeEvents.js.map

@@ -1 +1 @@
-{"version":3,"file":"TreeEvents.js","sourceRoot":"","sources":["../../../../../src/components-react/tree/controlled/TreeEvents.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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/** @packageDocumentation\n * @module Tree\n */\n\nimport { CheckBoxState } from \"@itwin/core-react\";\nimport { TreeNodeItem } from \"../TreeDataProvider\";\nimport { Observable, Subscription } from \"./Observable\";\n\n/**\n * Tree events that can occur while interacting with tree.\n *\n * **Note:** Selection and checkbox state change events payload is an Observable.\n * Observable is a stream of data over time (e.g. in case of selection replaced event\n * it is a stream of selected node items arrays). To access data inside stream `subscribe()` method\n * should be called. This method accepts any subset of 'next', 'error' and 'complete' callbacks.\n * Once subscribe is called observable will start emitting data and calls 'next' callback each time new\n * data is emitted. If some selected nodes are not loaded yet they will be loaded and observable will\n * emit loaded node items. When all selected node items are emitted observable completes and calls\n * 'complete' callback if supplied.\n *\n * @public\n */\nexport interface TreeEvents {\n  /** Called when tree node is expanded. */\n  onNodeExpanded?(event: TreeNodeEventArgs): void;\n  /** Called when tree node is collapsed. */\n  onNodeCollapsed?(event: TreeNodeEventArgs): void;\n\n  /** Called when selected tree node is clicked. */\n  onDelayedNodeClick?(event: TreeNodeEventArgs): void;\n  /** Called when selected tree node editor is activated. */\n  onNodeEditorActivated?(event: TreeNodeEventArgs): void;\n\n  /**\n   * Called when tree selection is modified.\n   * If Subscription is returned it can be used to stop event handling by calling `unsubscribe()`.\n   */\n  onSelectionModified?(event: TreeSelectionModificationEventArgs): Subscription | undefined;\n  /**\n   * Called when tree selection is replaced.\n   * If Subscription is returned it can be used to stop event handling by calling `unsubscribe()`.\n   */\n  onSelectionReplaced?(event: TreeSelectionReplacementEventArgs): Subscription | undefined;\n\n  /**\n   * Called when checkbox states for nodes are changed.\n   * If Subscription is returned it can be used to stop event handling by calling `unsubscribe()`.\n   */\n  onCheckboxStateChanged?(event: TreeCheckboxStateChangeEventArgs): Subscription | undefined;\n}\n\n/**\n * Data structure that describes tree node event payload.\n * @public\n */\nexport interface TreeNodeEventArgs {\n  /** Id of node that is affected by event. */\n  nodeId: string;\n}\n\n/**\n * Data structure that describes tree selection modification event payload.\n * @public\n */\nexport interface TreeSelectionModificationEventArgs {\n  /**\n   * An observable that emits tree selection changes.\n   * It starts emitting values when '.subscribe()' is called.\n   */\n  modifications: Observable<TreeSelectionChange>;\n}\n\n/**\n * Data structure that describes tree selection change.\n * @public\n */\nexport interface TreeSelectionChange {\n  /** Tree node items that where selected. */\n  selectedNodeItems: TreeNodeItem[];\n  /** Tree node items that where deselected. */\n  deselectedNodeItems: TreeNodeItem[];\n}\n\n/**\n * Data structure that describes tree selection replacement event payload.\n * @public\n */\nexport interface TreeSelectionReplacementEventArgs {\n  /**\n   * An observable that emits tree selection replacements containing selected tree node items.\n   * It starts emitting values when '.subscribe()' is called.\n   */\n  replacements: Observable<{ selectedNodeItems: TreeNodeItem[] }>;\n}\n\n/**\n * Data structure that describes tree checkbox state change event payload.\n * @public\n */\nexport interface TreeCheckboxStateChangeEventArgs {\n  /**\n   * An observable that emits checkbox state changes.\n   * It starts emitting values when '.subscribe()' is called.\n   */\n  stateChanges: Observable<CheckboxStateChange[]>;\n}\n\n/**\n * Data structure that describes checkbox state change.\n * @public\n */\nexport interface CheckboxStateChange {\n  /** Tree node item that was affected by checkbox state change. */\n  nodeItem: TreeNodeItem;\n  /** New state of the checkbox. */\n  newState: CheckBoxState;\n}\n"]}
+{"version":3,"file":"TreeEvents.js","sourceRoot":"","sources":["../../../../../src/components-react/tree/controlled/TreeEvents.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Tree\r\n */\r\n\r\nimport { CheckBoxState } from \"@itwin/core-react\";\r\nimport { TreeNodeItem } from \"../TreeDataProvider\";\r\nimport { Observable, Subscription } from \"./Observable\";\r\n\r\n/**\r\n * Tree events that can occur while interacting with tree.\r\n *\r\n * **Note:** Selection and checkbox state change events payload is an Observable.\r\n * Observable is a stream of data over time (e.g. in case of selection replaced event\r\n * it is a stream of selected node items arrays). To access data inside stream `subscribe()` method\r\n * should be called. This method accepts any subset of 'next', 'error' and 'complete' callbacks.\r\n * Once subscribe is called observable will start emitting data and calls 'next' callback each time new\r\n * data is emitted. If some selected nodes are not loaded yet they will be loaded and observable will\r\n * emit loaded node items. When all selected node items are emitted observable completes and calls\r\n * 'complete' callback if supplied.\r\n *\r\n * @public\r\n */\r\nexport interface TreeEvents {\r\n  /** Called when tree node is expanded. */\r\n  onNodeExpanded?(event: TreeNodeEventArgs): void;\r\n  /** Called when tree node is collapsed. */\r\n  onNodeCollapsed?(event: TreeNodeEventArgs): void;\r\n\r\n  /** Called when selected tree node is clicked. */\r\n  onDelayedNodeClick?(event: TreeNodeEventArgs): void;\r\n  /** Called when selected tree node editor is activated. */\r\n  onNodeEditorActivated?(event: TreeNodeEventArgs): void;\r\n\r\n  /**\r\n   * Called when tree selection is modified.\r\n   * If Subscription is returned it can be used to stop event handling by calling `unsubscribe()`.\r\n   */\r\n  onSelectionModified?(event: TreeSelectionModificationEventArgs): Subscription | undefined;\r\n  /**\r\n   * Called when tree selection is replaced.\r\n   * If Subscription is returned it can be used to stop event handling by calling `unsubscribe()`.\r\n   */\r\n  onSelectionReplaced?(event: TreeSelectionReplacementEventArgs): Subscription | undefined;\r\n\r\n  /**\r\n   * Called when checkbox states for nodes are changed.\r\n   * If Subscription is returned it can be used to stop event handling by calling `unsubscribe()`.\r\n   */\r\n  onCheckboxStateChanged?(event: TreeCheckboxStateChangeEventArgs): Subscription | undefined;\r\n}\r\n\r\n/**\r\n * Data structure that describes tree node event payload.\r\n * @public\r\n */\r\nexport interface TreeNodeEventArgs {\r\n  /** Id of node that is affected by event. */\r\n  nodeId: string;\r\n}\r\n\r\n/**\r\n * Data structure that describes tree selection modification event payload.\r\n * @public\r\n */\r\nexport interface TreeSelectionModificationEventArgs {\r\n  /**\r\n   * An observable that emits tree selection changes.\r\n   * It starts emitting values when '.subscribe()' is called.\r\n   */\r\n  modifications: Observable<TreeSelectionChange>;\r\n}\r\n\r\n/**\r\n * Data structure that describes tree selection change.\r\n * @public\r\n */\r\nexport interface TreeSelectionChange {\r\n  /** Tree node items that where selected. */\r\n  selectedNodeItems: TreeNodeItem[];\r\n  /** Tree node items that where deselected. */\r\n  deselectedNodeItems: TreeNodeItem[];\r\n}\r\n\r\n/**\r\n * Data structure that describes tree selection replacement event payload.\r\n * @public\r\n */\r\nexport interface TreeSelectionReplacementEventArgs {\r\n  /**\r\n   * An observable that emits tree selection replacements containing selected tree node items.\r\n   * It starts emitting values when '.subscribe()' is called.\r\n   */\r\n  replacements: Observable<{ selectedNodeItems: TreeNodeItem[] }>;\r\n}\r\n\r\n/**\r\n * Data structure that describes tree checkbox state change event payload.\r\n * @public\r\n */\r\nexport interface TreeCheckboxStateChangeEventArgs {\r\n  /**\r\n   * An observable that emits checkbox state changes.\r\n   * It starts emitting values when '.subscribe()' is called.\r\n   */\r\n  stateChanges: Observable<CheckboxStateChange[]>;\r\n}\r\n\r\n/**\r\n * Data structure that describes checkbox state change.\r\n * @public\r\n */\r\nexport interface CheckboxStateChange {\r\n  /** Tree node item that was affected by checkbox state change. */\r\n  nodeItem: TreeNodeItem;\r\n  /** New state of the checkbox. */\r\n  newState: CheckBoxState;\r\n}\r\n"]}

package/lib/esm/components-react/tree/controlled/TreeHooks.d.ts

@@ -1,48 +1,48 @@
-/** @packageDocumentation
- * @module Tree
- */
-import { TreeDataProvider } from "../TreeDataProvider";
-import { TreeEventHandler, TreeEventHandlerParams } from "./TreeEventHandler";
-import { TreeModel } from "./TreeModel";
-import { TreeModelSource } from "./TreeModelSource";
-import { PagedTreeNodeLoader, TreeNodeLoader } from "./TreeNodeLoader";
-/**
- * React hook that returns an immutable `TreeModel` whenever it changes in the given
- * `TreeModelSource`.
- *
- * @public
- */
-export declare function useTreeModel(modelSource: TreeModelSource): TreeModel;
-/**
- * Custom hook which creates a nodes' loader using the supplied data provider and model source. The
- * loader pulls nodes from the data provider and puts them into the model source.
- *
- * @public
- */
-export declare function useTreeNodeLoader<TDataProvider extends TreeDataProvider>(dataProvider: TDataProvider, modelSource: TreeModelSource): TreeNodeLoader<TDataProvider>;
-/**
- * Custom hook which creates a paging nodes' loader using the supplied data provider and model source. The loader pulls
- * nodes from the data provider and puts them into the model source.
- * @public
- */
-export declare function usePagedTreeNodeLoader<TDataProvider extends TreeDataProvider>(dataProvider: TDataProvider, pageSize: number, modelSource: TreeModelSource): PagedTreeNodeLoader<TDataProvider>;
-/**
- * Custom hook which creates a `TreeModelSource`.
- *
- * @note The model source has no direct dependency on the data provider, but we want a fresh model
- * source whenever the data provider changes - that's the reason the hook takes a data provider.
- *
- * @public
- */
-export declare function useTreeModelSource(dataProvider: TreeDataProvider): TreeModelSource;
-/**
- * Custom hook which creates and takes care of disposing a TreeEventsHandler. The input is either a factory method
- * for a custom `TreeEventHandler` implementation or parameters for the default implementation.
- *
- * @note Caller must ensure `factoryOrParams` changes only when a new handler needs to be created. `useCallback` or `useMemo` can
- * be used for that purpose based on whether the input is a factory function or params object.
- *
- * @public
- */
-export declare function useTreeEventsHandler<TEventsHandler extends TreeEventHandler>(factoryOrParams: (() => TEventsHandler) | TreeEventHandlerParams): TreeEventHandler;
+/** @packageDocumentation
+ * @module Tree
+ */
+import { TreeDataProvider } from "../TreeDataProvider";
+import { TreeEventHandler, TreeEventHandlerParams } from "./TreeEventHandler";
+import { TreeModel } from "./TreeModel";
+import { TreeModelSource } from "./TreeModelSource";
+import { PagedTreeNodeLoader, TreeNodeLoader } from "./TreeNodeLoader";
+/**
+ * React hook that returns an immutable `TreeModel` whenever it changes in the given
+ * `TreeModelSource`.
+ *
+ * @public
+ */
+export declare function useTreeModel(modelSource: TreeModelSource): TreeModel;
+/**
+ * Custom hook which creates a nodes' loader using the supplied data provider and model source. The
+ * loader pulls nodes from the data provider and puts them into the model source.
+ *
+ * @public
+ */
+export declare function useTreeNodeLoader<TDataProvider extends TreeDataProvider>(dataProvider: TDataProvider, modelSource: TreeModelSource): TreeNodeLoader<TDataProvider>;
+/**
+ * Custom hook which creates a paging nodes' loader using the supplied data provider and model source. The loader pulls
+ * nodes from the data provider and puts them into the model source.
+ * @public
+ */
+export declare function usePagedTreeNodeLoader<TDataProvider extends TreeDataProvider>(dataProvider: TDataProvider, pageSize: number, modelSource: TreeModelSource): PagedTreeNodeLoader<TDataProvider>;
+/**
+ * Custom hook which creates a `TreeModelSource`.
+ *
+ * @note The model source has no direct dependency on the data provider, but we want a fresh model
+ * source whenever the data provider changes - that's the reason the hook takes a data provider.
+ *
+ * @public
+ */
+export declare function useTreeModelSource(dataProvider: TreeDataProvider): TreeModelSource;
+/**
+ * Custom hook which creates and takes care of disposing a TreeEventsHandler. The input is either a factory method
+ * for a custom `TreeEventHandler` implementation or parameters for the default implementation.
+ *
+ * @note Caller must ensure `factoryOrParams` changes only when a new handler needs to be created. `useCallback` or `useMemo` can
+ * be used for that purpose based on whether the input is a factory function or params object.
+ *
+ * @public
+ */
+export declare function useTreeEventsHandler<TEventsHandler extends TreeEventHandler>(factoryOrParams: (() => TEventsHandler) | TreeEventHandlerParams): TreeEventHandler;
 //# sourceMappingURL=TreeHooks.d.ts.map

package/lib/esm/components-react/tree/controlled/TreeHooks.js

@@ -1,75 +1,75 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Tree
- */
-import { useCallback, useEffect, useMemo } from "react";
-import { useDisposable } from "@itwin/core-react";
-import { useRerender } from "../../common/UseRerender";
-import { TreeEventHandler } from "./TreeEventHandler";
-import { TreeModelSource } from "./TreeModelSource";
-import { PagedTreeNodeLoader, TreeNodeLoader } from "./TreeNodeLoader";
-/**
- * React hook that returns an immutable `TreeModel` whenever it changes in the given
- * `TreeModelSource`.
- *
- * @public
- */
-export function useTreeModel(modelSource) {
-    const { rerender } = useRerender();
-    useEffect(() => {
-        return modelSource.onModelChanged.addListener(rerender);
-    }, [modelSource, rerender]);
-    return modelSource.getModel();
-}
-/**
- * Custom hook which creates a nodes' loader using the supplied data provider and model source. The
- * loader pulls nodes from the data provider and puts them into the model source.
- *
- * @public
- */
-export function useTreeNodeLoader(dataProvider, modelSource) {
-    const createLoader = useCallback(() => new TreeNodeLoader(dataProvider, modelSource), [dataProvider, modelSource]);
-    return useDisposable(createLoader);
-}
-/**
- * Custom hook which creates a paging nodes' loader using the supplied data provider and model source. The loader pulls
- * nodes from the data provider and puts them into the model source.
- * @public
- */
-export function usePagedTreeNodeLoader(dataProvider, pageSize, modelSource) {
-    const createLoader = useCallback(() => new PagedTreeNodeLoader(dataProvider, modelSource, pageSize), [dataProvider, modelSource, pageSize]);
-    return useDisposable(createLoader);
-}
-/**
- * Custom hook which creates a `TreeModelSource`.
- *
- * @note The model source has no direct dependency on the data provider, but we want a fresh model
- * source whenever the data provider changes - that's the reason the hook takes a data provider.
- *
- * @public
- */
-export function useTreeModelSource(dataProvider) {
-    // need to create new model source every time data provider changes although it does not need data provider to be created.
-    return useMemo(() => new TreeModelSource(), [dataProvider]); // eslint-disable-line react-hooks/exhaustive-deps
-}
-/**
- * Custom hook which creates and takes care of disposing a TreeEventsHandler. The input is either a factory method
- * for a custom `TreeEventHandler` implementation or parameters for the default implementation.
- *
- * @note Caller must ensure `factoryOrParams` changes only when a new handler needs to be created. `useCallback` or `useMemo` can
- * be used for that purpose based on whether the input is a factory function or params object.
- *
- * @public
- */
-export function useTreeEventsHandler(factoryOrParams) {
-    const factory = useCallback(() => {
-        if (typeof factoryOrParams === "function")
-            return factoryOrParams();
-        return new TreeEventHandler(factoryOrParams);
-    }, [factoryOrParams]);
-    return useDisposable(factory);
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Tree
+ */
+import { useCallback, useEffect, useMemo } from "react";
+import { useDisposable } from "@itwin/core-react";
+import { useRerender } from "../../common/UseRerender";
+import { TreeEventHandler } from "./TreeEventHandler";
+import { TreeModelSource } from "./TreeModelSource";
+import { PagedTreeNodeLoader, TreeNodeLoader } from "./TreeNodeLoader";
+/**
+ * React hook that returns an immutable `TreeModel` whenever it changes in the given
+ * `TreeModelSource`.
+ *
+ * @public
+ */
+export function useTreeModel(modelSource) {
+    const { rerender } = useRerender();
+    useEffect(() => {
+        return modelSource.onModelChanged.addListener(rerender);
+    }, [modelSource, rerender]);
+    return modelSource.getModel();
+}
+/**
+ * Custom hook which creates a nodes' loader using the supplied data provider and model source. The
+ * loader pulls nodes from the data provider and puts them into the model source.
+ *
+ * @public
+ */
+export function useTreeNodeLoader(dataProvider, modelSource) {
+    const createLoader = useCallback(() => new TreeNodeLoader(dataProvider, modelSource), [dataProvider, modelSource]);
+    return useDisposable(createLoader);
+}
+/**
+ * Custom hook which creates a paging nodes' loader using the supplied data provider and model source. The loader pulls
+ * nodes from the data provider and puts them into the model source.
+ * @public
+ */
+export function usePagedTreeNodeLoader(dataProvider, pageSize, modelSource) {
+    const createLoader = useCallback(() => new PagedTreeNodeLoader(dataProvider, modelSource, pageSize), [dataProvider, modelSource, pageSize]);
+    return useDisposable(createLoader);
+}
+/**
+ * Custom hook which creates a `TreeModelSource`.
+ *
+ * @note The model source has no direct dependency on the data provider, but we want a fresh model
+ * source whenever the data provider changes - that's the reason the hook takes a data provider.
+ *
+ * @public
+ */
+export function useTreeModelSource(dataProvider) {
+    // need to create new model source every time data provider changes although it does not need data provider to be created.
+    return useMemo(() => new TreeModelSource(), [dataProvider]); // eslint-disable-line react-hooks/exhaustive-deps
+}
+/**
+ * Custom hook which creates and takes care of disposing a TreeEventsHandler. The input is either a factory method
+ * for a custom `TreeEventHandler` implementation or parameters for the default implementation.
+ *
+ * @note Caller must ensure `factoryOrParams` changes only when a new handler needs to be created. `useCallback` or `useMemo` can
+ * be used for that purpose based on whether the input is a factory function or params object.
+ *
+ * @public
+ */
+export function useTreeEventsHandler(factoryOrParams) {
+    const factory = useCallback(() => {
+        if (typeof factoryOrParams === "function")
+            return factoryOrParams();
+        return new TreeEventHandler(factoryOrParams);
+    }, [factoryOrParams]);
+    return useDisposable(factory);
+}
 //# sourceMappingURL=TreeHooks.js.map

package/lib/esm/components-react/tree/controlled/TreeHooks.js.map

@@ -1 +1 @@
-{"version":3,"file":"TreeHooks.js","sourceRoot":"","sources":["../../../../../src/components-react/tree/controlled/TreeHooks.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,OAAO,EAAE,gBAAgB,EAA0B,MAAM,oBAAoB,CAAC;AAE9E,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvE;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,WAA4B;IACvD,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,EAAE,CAAC;IACnC,SAAS,CAAC,GAAG,EAAE;QACb,OAAO,WAAW,CAAC,cAAc,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC1D,CAAC,EAAE,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC5B,OAAO,WAAW,CAAC,QAAQ,EAAE,CAAC;AAChC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAyC,YAA2B,EAAE,WAA4B;IACjI,MAAM,YAAY,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,cAAc,CAAC,YAAY,EAAE,WAAW,CAAC,EAAE,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC,CAAC;IACnH,OAAO,aAAa,CAAC,YAAY,CAAC,CAAC;AACrC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CAAyC,YAA2B,EAAE,QAAgB,EAAE,WAA4B;IACxJ,MAAM,YAAY,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,mBAAmB,CAAC,YAAY,EAAE,WAAW,EAAE,QAAQ,CAAC,EAAE,CAAC,YAAY,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC5I,OAAO,aAAa,CAAC,YAAY,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAAC,YAA8B;IAC/D,0HAA0H;IAC1H,OAAO,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,eAAe,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,kDAAkD;AACjH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,oBAAoB,CAA0C,eAAgE;IAC5I,MAAM,OAAO,GAAG,WAAW,CAAC,GAAqB,EAAE;QACjD,IAAI,OAAO,eAAe,KAAK,UAAU;YACvC,OAAO,eAAe,EAAE,CAAC;QAC3B,OAAO,IAAI,gBAAgB,CAAC,eAAe,CAAC,CAAC;IAC/C,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC;IACtB,OAAO,aAAa,CAAC,OAAO,CAAC,CAAC;AAChC,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/** @packageDocumentation\n * @module Tree\n */\n\nimport { useCallback, useEffect, useMemo } from \"react\";\nimport { useDisposable } from \"@itwin/core-react\";\nimport { useRerender } from \"../../common/UseRerender\";\nimport { TreeDataProvider } from \"../TreeDataProvider\";\nimport { TreeEventHandler, TreeEventHandlerParams } from \"./TreeEventHandler\";\nimport { TreeModel } from \"./TreeModel\";\nimport { TreeModelSource } from \"./TreeModelSource\";\nimport { PagedTreeNodeLoader, TreeNodeLoader } from \"./TreeNodeLoader\";\n\n/**\n * React hook that returns an immutable `TreeModel` whenever it changes in the given\n * `TreeModelSource`.\n *\n * @public\n */\nexport function useTreeModel(modelSource: TreeModelSource): TreeModel {\n  const { rerender } = useRerender();\n  useEffect(() => {\n    return modelSource.onModelChanged.addListener(rerender);\n  }, [modelSource, rerender]);\n  return modelSource.getModel();\n}\n\n/**\n * Custom hook which creates a nodes' loader using the supplied data provider and model source. The\n * loader pulls nodes from the data provider and puts them into the model source.\n *\n * @public\n */\nexport function useTreeNodeLoader<TDataProvider extends TreeDataProvider>(dataProvider: TDataProvider, modelSource: TreeModelSource) {\n  const createLoader = useCallback(() => new TreeNodeLoader(dataProvider, modelSource), [dataProvider, modelSource]);\n  return useDisposable(createLoader);\n}\n\n/**\n * Custom hook which creates a paging nodes' loader using the supplied data provider and model source. The loader pulls\n * nodes from the data provider and puts them into the model source.\n * @public\n */\nexport function usePagedTreeNodeLoader<TDataProvider extends TreeDataProvider>(dataProvider: TDataProvider, pageSize: number, modelSource: TreeModelSource) {\n  const createLoader = useCallback(() => new PagedTreeNodeLoader(dataProvider, modelSource, pageSize), [dataProvider, modelSource, pageSize]);\n  return useDisposable(createLoader);\n}\n\n/**\n * Custom hook which creates a `TreeModelSource`.\n *\n * @note The model source has no direct dependency on the data provider, but we want a fresh model\n * source whenever the data provider changes - that's the reason the hook takes a data provider.\n *\n * @public\n */\nexport function useTreeModelSource(dataProvider: TreeDataProvider) {\n  // need to create new model source every time data provider changes although it does not need data provider to be created.\n  return useMemo(() => new TreeModelSource(), [dataProvider]); // eslint-disable-line react-hooks/exhaustive-deps\n}\n\n/**\n * Custom hook which creates and takes care of disposing a TreeEventsHandler. The input is either a factory method\n * for a custom `TreeEventHandler` implementation or parameters for the default implementation.\n *\n * @note Caller must ensure `factoryOrParams` changes only when a new handler needs to be created. `useCallback` or `useMemo` can\n * be used for that purpose based on whether the input is a factory function or params object.\n *\n * @public\n */\nexport function useTreeEventsHandler<TEventsHandler extends TreeEventHandler>(factoryOrParams: (() => TEventsHandler) | TreeEventHandlerParams) {\n  const factory = useCallback((): TreeEventHandler => {\n    if (typeof factoryOrParams === \"function\")\n      return factoryOrParams();\n    return new TreeEventHandler(factoryOrParams);\n  }, [factoryOrParams]);\n  return useDisposable(factory);\n}\n"]}
+{"version":3,"file":"TreeHooks.js","sourceRoot":"","sources":["../../../../../src/components-react/tree/controlled/TreeHooks.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,OAAO,EAAE,gBAAgB,EAA0B,MAAM,oBAAoB,CAAC;AAE9E,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvE;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,WAA4B;IACvD,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,EAAE,CAAC;IACnC,SAAS,CAAC,GAAG,EAAE;QACb,OAAO,WAAW,CAAC,cAAc,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC1D,CAAC,EAAE,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC5B,OAAO,WAAW,CAAC,QAAQ,EAAE,CAAC;AAChC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAyC,YAA2B,EAAE,WAA4B;IACjI,MAAM,YAAY,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,cAAc,CAAC,YAAY,EAAE,WAAW,CAAC,EAAE,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC,CAAC;IACnH,OAAO,aAAa,CAAC,YAAY,CAAC,CAAC;AACrC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CAAyC,YAA2B,EAAE,QAAgB,EAAE,WAA4B;IACxJ,MAAM,YAAY,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,mBAAmB,CAAC,YAAY,EAAE,WAAW,EAAE,QAAQ,CAAC,EAAE,CAAC,YAAY,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC5I,OAAO,aAAa,CAAC,YAAY,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAAC,YAA8B;IAC/D,0HAA0H;IAC1H,OAAO,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,eAAe,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,kDAAkD;AACjH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,oBAAoB,CAA0C,eAAgE;IAC5I,MAAM,OAAO,GAAG,WAAW,CAAC,GAAqB,EAAE;QACjD,IAAI,OAAO,eAAe,KAAK,UAAU;YACvC,OAAO,eAAe,EAAE,CAAC;QAC3B,OAAO,IAAI,gBAAgB,CAAC,eAAe,CAAC,CAAC;IAC/C,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC;IACtB,OAAO,aAAa,CAAC,OAAO,CAAC,CAAC;AAChC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Tree\r\n */\r\n\r\nimport { useCallback, useEffect, useMemo } from \"react\";\r\nimport { useDisposable } from \"@itwin/core-react\";\r\nimport { useRerender } from \"../../common/UseRerender\";\r\nimport { TreeDataProvider } from \"../TreeDataProvider\";\r\nimport { TreeEventHandler, TreeEventHandlerParams } from \"./TreeEventHandler\";\r\nimport { TreeModel } from \"./TreeModel\";\r\nimport { TreeModelSource } from \"./TreeModelSource\";\r\nimport { PagedTreeNodeLoader, TreeNodeLoader } from \"./TreeNodeLoader\";\r\n\r\n/**\r\n * React hook that returns an immutable `TreeModel` whenever it changes in the given\r\n * `TreeModelSource`.\r\n *\r\n * @public\r\n */\r\nexport function useTreeModel(modelSource: TreeModelSource): TreeModel {\r\n  const { rerender } = useRerender();\r\n  useEffect(() => {\r\n    return modelSource.onModelChanged.addListener(rerender);\r\n  }, [modelSource, rerender]);\r\n  return modelSource.getModel();\r\n}\r\n\r\n/**\r\n * Custom hook which creates a nodes' loader using the supplied data provider and model source. The\r\n * loader pulls nodes from the data provider and puts them into the model source.\r\n *\r\n * @public\r\n */\r\nexport function useTreeNodeLoader<TDataProvider extends TreeDataProvider>(dataProvider: TDataProvider, modelSource: TreeModelSource) {\r\n  const createLoader = useCallback(() => new TreeNodeLoader(dataProvider, modelSource), [dataProvider, modelSource]);\r\n  return useDisposable(createLoader);\r\n}\r\n\r\n/**\r\n * Custom hook which creates a paging nodes' loader using the supplied data provider and model source. The loader pulls\r\n * nodes from the data provider and puts them into the model source.\r\n * @public\r\n */\r\nexport function usePagedTreeNodeLoader<TDataProvider extends TreeDataProvider>(dataProvider: TDataProvider, pageSize: number, modelSource: TreeModelSource) {\r\n  const createLoader = useCallback(() => new PagedTreeNodeLoader(dataProvider, modelSource, pageSize), [dataProvider, modelSource, pageSize]);\r\n  return useDisposable(createLoader);\r\n}\r\n\r\n/**\r\n * Custom hook which creates a `TreeModelSource`.\r\n *\r\n * @note The model source has no direct dependency on the data provider, but we want a fresh model\r\n * source whenever the data provider changes - that's the reason the hook takes a data provider.\r\n *\r\n * @public\r\n */\r\nexport function useTreeModelSource(dataProvider: TreeDataProvider) {\r\n  // need to create new model source every time data provider changes although it does not need data provider to be created.\r\n  return useMemo(() => new TreeModelSource(), [dataProvider]); // eslint-disable-line react-hooks/exhaustive-deps\r\n}\r\n\r\n/**\r\n * Custom hook which creates and takes care of disposing a TreeEventsHandler. The input is either a factory method\r\n * for a custom `TreeEventHandler` implementation or parameters for the default implementation.\r\n *\r\n * @note Caller must ensure `factoryOrParams` changes only when a new handler needs to be created. `useCallback` or `useMemo` can\r\n * be used for that purpose based on whether the input is a factory function or params object.\r\n *\r\n * @public\r\n */\r\nexport function useTreeEventsHandler<TEventsHandler extends TreeEventHandler>(factoryOrParams: (() => TEventsHandler) | TreeEventHandlerParams) {\r\n  const factory = useCallback((): TreeEventHandler => {\r\n    if (typeof factoryOrParams === \"function\")\r\n      return factoryOrParams();\r\n    return new TreeEventHandler(factoryOrParams);\r\n  }, [factoryOrParams]);\r\n  return useDisposable(factory);\r\n}\r\n"]}