@itwin/core-react 4.0.0-dev.12 → 4.0.0-dev.14

package/lib/cjs/core-react/utils/hooks/useDisposable.d.ts

@@ -1,18 +1,18 @@
-/** @packageDocumentation
- * @module Utilities
- */
-import { IDisposable } from "@itwin/core-bentley";
-/**
- * A custom hook which creates a disposable object and manages its disposal on unmount
- * or factory method change.
- * @public
- */
-export declare function useDisposable<TDisposable extends IDisposable>(createDisposable: () => TDisposable): TDisposable;
-/**
- * A custom hook which calls the factory method to create a disposable object
- * which might as well be undefined. If the result was a disposable object, the
- * hook takes care of disposing it when necessary.
- * @public
- */
-export declare function useOptionalDisposable<TDisposable extends IDisposable>(createDisposable: () => TDisposable | undefined): TDisposable | undefined;
+/** @packageDocumentation
+ * @module Utilities
+ */
+import { IDisposable } from "@itwin/core-bentley";
+/**
+ * A custom hook which creates a disposable object and manages its disposal on unmount
+ * or factory method change.
+ * @public
+ */
+export declare function useDisposable<TDisposable extends IDisposable>(createDisposable: () => TDisposable): TDisposable;
+/**
+ * A custom hook which calls the factory method to create a disposable object
+ * which might as well be undefined. If the result was a disposable object, the
+ * hook takes care of disposing it when necessary.
+ * @public
+ */
+export declare function useOptionalDisposable<TDisposable extends IDisposable>(createDisposable: () => TDisposable | undefined): TDisposable | undefined;
 //# sourceMappingURL=useDisposable.d.ts.map

package/lib/cjs/core-react/utils/hooks/useDisposable.js

@@ -1,39 +1,39 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Utilities
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useOptionalDisposable = exports.useDisposable = void 0;
-const react_1 = require("react");
-/**
- * A custom hook which creates a disposable object and manages its disposal on unmount
- * or factory method change.
- * @public
- */
-function useDisposable(createDisposable) {
-    return useOptionalDisposable(createDisposable);
-}
-exports.useDisposable = useDisposable;
-/**
- * A custom hook which calls the factory method to create a disposable object
- * which might as well be undefined. If the result was a disposable object, the
- * hook takes care of disposing it when necessary.
- * @public
- */
-function useOptionalDisposable(createDisposable) {
-    const previous = (0, react_1.useRef)();
-    const value = (0, react_1.useMemo)(() => {
-        if (previous.current)
-            previous.current.dispose();
-        previous.current = createDisposable();
-        return previous.current;
-    }, [createDisposable]);
-    (0, react_1.useEffect)(() => () => previous.current && previous.current.dispose(), []);
-    return value;
-}
-exports.useOptionalDisposable = useOptionalDisposable;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Utilities
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useOptionalDisposable = exports.useDisposable = void 0;
+const react_1 = require("react");
+/**
+ * A custom hook which creates a disposable object and manages its disposal on unmount
+ * or factory method change.
+ * @public
+ */
+function useDisposable(createDisposable) {
+    return useOptionalDisposable(createDisposable);
+}
+exports.useDisposable = useDisposable;
+/**
+ * A custom hook which calls the factory method to create a disposable object
+ * which might as well be undefined. If the result was a disposable object, the
+ * hook takes care of disposing it when necessary.
+ * @public
+ */
+function useOptionalDisposable(createDisposable) {
+    const previous = (0, react_1.useRef)();
+    const value = (0, react_1.useMemo)(() => {
+        if (previous.current)
+            previous.current.dispose();
+        previous.current = createDisposable();
+        return previous.current;
+    }, [createDisposable]);
+    (0, react_1.useEffect)(() => () => previous.current && previous.current.dispose(), []);
+    return value;
+}
+exports.useOptionalDisposable = useOptionalDisposable;
 //# sourceMappingURL=useDisposable.js.map

package/lib/cjs/core-react/utils/hooks/useEffectSkipFirst.d.ts

@@ -1,9 +1,9 @@
-/** @packageDocumentation
- * @module Utilities
- */
-/**
- * Custom hook which works like useEffect hook, but does not invoke callback when effect is triggered for the first time.
- * @public
- */
-export declare function useEffectSkipFirst(callback: () => (void | (() => void | undefined)) | void, deps?: any[]): void;
+/** @packageDocumentation
+ * @module Utilities
+ */
+/**
+ * Custom hook which works like useEffect hook, but does not invoke callback when effect is triggered for the first time.
+ * @public
+ */
+export declare function useEffectSkipFirst(callback: () => (void | (() => void | undefined)) | void, deps?: any[]): void;
 //# sourceMappingURL=useEffectSkipFirst.d.ts.map

package/lib/cjs/core-react/utils/hooks/useEffectSkipFirst.js

@@ -1,27 +1,27 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Utilities
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useEffectSkipFirst = void 0;
-const react_1 = require("react");
-/**
- * Custom hook which works like useEffect hook, but does not invoke callback when effect is triggered for the first time.
- * @public
- */
-function useEffectSkipFirst(callback, deps) {
-    const skipFirst = (0, react_1.useRef)(true);
-    (0, react_1.useEffect)(() => {
-        if (skipFirst.current) {
-            skipFirst.current = false;
-            return;
-        }
-        return callback();
-    }, deps); // eslint-disable-line react-hooks/exhaustive-deps
-}
-exports.useEffectSkipFirst = useEffectSkipFirst;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Utilities
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useEffectSkipFirst = void 0;
+const react_1 = require("react");
+/**
+ * Custom hook which works like useEffect hook, but does not invoke callback when effect is triggered for the first time.
+ * @public
+ */
+function useEffectSkipFirst(callback, deps) {
+    const skipFirst = (0, react_1.useRef)(true);
+    (0, react_1.useEffect)(() => {
+        if (skipFirst.current) {
+            skipFirst.current = false;
+            return;
+        }
+        return callback();
+    }, deps); // eslint-disable-line react-hooks/exhaustive-deps
+}
+exports.useEffectSkipFirst = useEffectSkipFirst;
 //# sourceMappingURL=useEffectSkipFirst.js.map

package/lib/cjs/core-react/utils/hooks/useEventListener.d.ts

@@ -1,12 +1,12 @@
-/**
- * Hook that adds and removes Event listeners.
- * @example
- *  useEventListener(
- *     'pointerup',
- *     handlePointerUp,
- *     containerRef.current?.ownerDocument,
- *  );
- * @internal
- */
-export declare function useEventListener(eventName: string, handler: (event: Event) => void, element: HTMLElement | Document | undefined): void;
+/**
+ * Hook that adds and removes Event listeners.
+ * @example
+ *  useEventListener(
+ *     'pointerup',
+ *     handlePointerUp,
+ *     containerRef.current?.ownerDocument,
+ *  );
+ * @internal
+ */
+export declare function useEventListener(eventName: string, handler: (event: Event) => void, element: HTMLElement | Document | undefined): void;
 //# sourceMappingURL=useEventListener.d.ts.map

package/lib/cjs/core-react/utils/hooks/useEventListener.js

@@ -1,44 +1,44 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useEventListener = void 0;
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-const React = require("react");
-/**
- * Hook that adds and removes Event listeners.
- * @example
- *  useEventListener(
- *     'pointerup',
- *     handlePointerUp,
- *     containerRef.current?.ownerDocument,
- *  );
- * @internal
- */
-function useEventListener(eventName, handler, element) {
-    // Based on published hook https://usehooks.com/useEventListener/.
-    const savedHandler = React.useRef();
-    // Update reference if handler changes. This allows our effect below to
-    // always use latest handler without us needing to pass it in effect deps array
-    // and potentially cause effect to re-run every render.
-    React.useEffect(() => {
-        savedHandler.current = handler;
-    }, [handler]);
-    React.useEffect(() => {
-        if (!element) {
-            return;
-        }
-        const eventListener = (event) => {
-            // istanbul ignore else
-            if (savedHandler.current)
-                savedHandler.current(event);
-        };
-        element.addEventListener(eventName, eventListener);
-        return () => {
-            element.removeEventListener(eventName, eventListener);
-        };
-    }, [eventName, element]);
-}
-exports.useEventListener = useEventListener;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useEventListener = void 0;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+const React = require("react");
+/**
+ * Hook that adds and removes Event listeners.
+ * @example
+ *  useEventListener(
+ *     'pointerup',
+ *     handlePointerUp,
+ *     containerRef.current?.ownerDocument,
+ *  );
+ * @internal
+ */
+function useEventListener(eventName, handler, element) {
+    // Based on published hook https://usehooks.com/useEventListener/.
+    const savedHandler = React.useRef();
+    // Update reference if handler changes. This allows our effect below to
+    // always use latest handler without us needing to pass it in effect deps array
+    // and potentially cause effect to re-run every render.
+    React.useEffect(() => {
+        savedHandler.current = handler;
+    }, [handler]);
+    React.useEffect(() => {
+        if (!element) {
+            return;
+        }
+        const eventListener = (event) => {
+            // istanbul ignore else
+            if (savedHandler.current)
+                savedHandler.current(event);
+        };
+        element.addEventListener(eventName, eventListener);
+        return () => {
+            element.removeEventListener(eventName, eventListener);
+        };
+    }, [eventName, element]);
+}
+exports.useEventListener = useEventListener;
 //# sourceMappingURL=useEventListener.js.map

package/lib/cjs/core-react/utils/hooks/useInterval.d.ts

@@ -1,6 +1,6 @@
-/** Hook that create an interval and clears it when unloaded
- * Reference: https://github.com/gaearon/overreacted.io/blob/master/src/pages/making-setinterval-declarative-with-react-hooks/index.md
- * @beta
- */
-export declare function useInterval(callback: (...args: any[]) => void, delay: number | undefined): void;
+/** Hook that create an interval and clears it when unloaded
+ * Reference: https://github.com/gaearon/overreacted.io/blob/master/src/pages/making-setinterval-declarative-with-react-hooks/index.md
+ * @beta
+ */
+export declare function useInterval(callback: (...args: any[]) => void, delay: number | undefined): void;
 //# sourceMappingURL=useInterval.d.ts.map

package/lib/cjs/core-react/utils/hooks/useInterval.js

@@ -1,37 +1,37 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useInterval = void 0;
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Utilities
- */
-const React = require("react");
-/** Hook that create an interval and clears it when unloaded
- * Reference: https://github.com/gaearon/overreacted.io/blob/master/src/pages/making-setinterval-declarative-with-react-hooks/index.md
- * @beta
- */
-function useInterval(callback, delay) {
-    const savedCallback = React.useRef(callback);
-    // Remember the latest function.
-    React.useEffect(() => {
-        savedCallback.current = callback;
-    }, [callback]);
-    // Set up the interval.
-    React.useEffect(() => {
-        function tick() {
-            savedCallback.current();
-        }
-        if (delay !== undefined) {
-            const id = setInterval(tick, delay);
-            return (() => { clearInterval(id); });
-        }
-        else {
-            return undefined;
-        }
-    }, [delay]);
-}
-exports.useInterval = useInterval;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useInterval = void 0;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Utilities
+ */
+const React = require("react");
+/** Hook that create an interval and clears it when unloaded
+ * Reference: https://github.com/gaearon/overreacted.io/blob/master/src/pages/making-setinterval-declarative-with-react-hooks/index.md
+ * @beta
+ */
+function useInterval(callback, delay) {
+    const savedCallback = React.useRef(callback);
+    // Remember the latest function.
+    React.useEffect(() => {
+        savedCallback.current = callback;
+    }, [callback]);
+    // Set up the interval.
+    React.useEffect(() => {
+        function tick() {
+            savedCallback.current();
+        }
+        if (delay !== undefined) {
+            const id = setInterval(tick, delay);
+            return (() => { clearInterval(id); });
+        }
+        else {
+            return undefined;
+        }
+    }, [delay]);
+}
+exports.useInterval = useInterval;
 //# sourceMappingURL=useInterval.js.map

package/lib/cjs/core-react/utils/hooks/useLifecycleLogging.d.ts

@@ -1,6 +1,6 @@
-/**
- * Logs to console information about component lifecycle: mounting, re-rendering and unmounting.
- * @internal
- */
-export declare function useLifecycleLogging(name: string, props: Record<string, any>, context?: Record<string, any>): void;
+/**
+ * Logs to console information about component lifecycle: mounting, re-rendering and unmounting.
+ * @internal
+ */
+export declare function useLifecycleLogging(name: string, props: Record<string, any>, context?: Record<string, any>): void;
 //# sourceMappingURL=useLifecycleLogging.d.ts.map

package/lib/cjs/core-react/utils/hooks/useLifecycleLogging.js

@@ -1,65 +1,65 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useLifecycleLogging = void 0;
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-const react_1 = require("react");
-/**
- * Logs to console information about component lifecycle: mounting, re-rendering and unmounting.
- * @internal
- */
-function useLifecycleLogging(name, props, context) {
-    (0, react_1.useEffect)(() => {
-        // eslint-disable-next-line no-console
-        console.log(`[useLifecycleLogging]: '${name}' Component mounted.`);
-        return () => {
-            // eslint-disable-next-line no-console
-            console.log(`[useLifecycleLogging]: '${name}' Component unmounted.`);
-        };
-    }, []); // eslint-disable-line react-hooks/exhaustive-deps
-    const prevProps = (0, react_1.useRef)(props);
-    const prevContext = (0, react_1.useRef)(context);
-    const firstRun = (0, react_1.useRef)(true);
-    (0, react_1.useEffect)(() => {
-        if (firstRun.current) {
-            firstRun.current = false;
-            return;
-        }
-        function getDiff(prev, current) {
-            const diff = {};
-            for (const key of Object.keys(current)) {
-                if (prev[key] !== current[key]) {
-                    diff[key] = {
-                        from: prev[key],
-                        to: current[key],
-                    };
-                }
-            }
-            return diff;
-        }
-        const propsDiff = getDiff(prevProps.current, props);
-        const contextDiff = { from: context === undefined ? context : prevContext.current, to: context };
-        if (Object.keys(propsDiff).length > 0 && prevContext.current !== context) {
-            // eslint-disable-next-line no-console
-            console.log(`[useLifecycleLogging]: '${name}' Props and context changed: `, propsDiff, contextDiff);
-        }
-        else if (Object.keys(propsDiff).length > 0) {
-            // eslint-disable-next-line no-console
-            console.log(`[useLifecycleLogging]: '${name}' Props changed: `, propsDiff);
-        }
-        else if (prevContext.current !== context) {
-            // eslint-disable-next-line no-console
-            console.log(`[useLifecycleLogging]: '${name}' Context changed: `, contextDiff);
-        }
-        else {
-            // eslint-disable-next-line no-console
-            console.log(`[useLifecycleLogging]: '${name}' Component re-rendered.`);
-        }
-        prevProps.current = props;
-        prevContext.current = context;
-    });
-}
-exports.useLifecycleLogging = useLifecycleLogging;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useLifecycleLogging = void 0;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+const react_1 = require("react");
+/**
+ * Logs to console information about component lifecycle: mounting, re-rendering and unmounting.
+ * @internal
+ */
+function useLifecycleLogging(name, props, context) {
+    (0, react_1.useEffect)(() => {
+        // eslint-disable-next-line no-console
+        console.log(`[useLifecycleLogging]: '${name}' Component mounted.`);
+        return () => {
+            // eslint-disable-next-line no-console
+            console.log(`[useLifecycleLogging]: '${name}' Component unmounted.`);
+        };
+    }, []); // eslint-disable-line react-hooks/exhaustive-deps
+    const prevProps = (0, react_1.useRef)(props);
+    const prevContext = (0, react_1.useRef)(context);
+    const firstRun = (0, react_1.useRef)(true);
+    (0, react_1.useEffect)(() => {
+        if (firstRun.current) {
+            firstRun.current = false;
+            return;
+        }
+        function getDiff(prev, current) {
+            const diff = {};
+            for (const key of Object.keys(current)) {
+                if (prev[key] !== current[key]) {
+                    diff[key] = {
+                        from: prev[key],
+                        to: current[key],
+                    };
+                }
+            }
+            return diff;
+        }
+        const propsDiff = getDiff(prevProps.current, props);
+        const contextDiff = { from: context === undefined ? context : prevContext.current, to: context };
+        if (Object.keys(propsDiff).length > 0 && prevContext.current !== context) {
+            // eslint-disable-next-line no-console
+            console.log(`[useLifecycleLogging]: '${name}' Props and context changed: `, propsDiff, contextDiff);
+        }
+        else if (Object.keys(propsDiff).length > 0) {
+            // eslint-disable-next-line no-console
+            console.log(`[useLifecycleLogging]: '${name}' Props changed: `, propsDiff);
+        }
+        else if (prevContext.current !== context) {
+            // eslint-disable-next-line no-console
+            console.log(`[useLifecycleLogging]: '${name}' Context changed: `, contextDiff);
+        }
+        else {
+            // eslint-disable-next-line no-console
+            console.log(`[useLifecycleLogging]: '${name}' Component re-rendered.`);
+        }
+        prevProps.current = props;
+        prevContext.current = context;
+    });
+}
+exports.useLifecycleLogging = useLifecycleLogging;
 //# sourceMappingURL=useLifecycleLogging.js.map

package/lib/cjs/core-react/utils/hooks/useOnOutsideClick.d.ts

@@ -1,13 +1,13 @@
-/** @packageDocumentation
- * @module Utilities
- */
-import * as React from "react";
-/** @public */
-export declare type OutsideClickEvent = PointerEvent | MouseEvent | TouchEvent;
-/** Invokes onOutsideClick handler when user clicks outside of referenced element.
- * @public
- */
-export declare function useOnOutsideClick<T extends Element>(onOutsideClick?: () => void, 
-/** Invoked for intermediate events. Return `false` to prevent outside click. */
-outsideEventPredicate?: (e: OutsideClickEvent) => boolean): React.RefObject<T>;
+/** @packageDocumentation
+ * @module Utilities
+ */
+import * as React from "react";
+/** @public */
+export type OutsideClickEvent = PointerEvent | MouseEvent | TouchEvent;
+/** Invokes onOutsideClick handler when user clicks outside of referenced element.
+ * @public
+ */
+export declare function useOnOutsideClick<T extends Element>(onOutsideClick?: () => void, 
+/** Invoked for intermediate events. Return `false` to prevent outside click. */
+outsideEventPredicate?: (e: OutsideClickEvent) => boolean): React.RefObject<T>;
 //# sourceMappingURL=useOnOutsideClick.d.ts.map

package/lib/cjs/core-react/utils/hooks/useOnOutsideClick.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useOnOutsideClick.d.ts","sourceRoot":"","sources":["../../../../../src/core-react/utils/hooks/useOnOutsideClick.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAI/B,cAAc;AACd,oBAAY,iBAAiB,GAAG,YAAY,GAAG,UAAU,GAAG,UAAU,CAAC;AAEvE;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,OAAO,EACjD,cAAc,CAAC,EAAE,MAAM,IAAI;AAC3B,gFAAgF;AAChF,qBAAqB,CAAC,EAAE,CAAC,CAAC,EAAE,iBAAiB,KAAK,OAAO,sBAoE1D"}
+{"version":3,"file":"useOnOutsideClick.d.ts","sourceRoot":"","sources":["../../../../../src/core-react/utils/hooks/useOnOutsideClick.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAI/B,cAAc;AACd,MAAM,MAAM,iBAAiB,GAAG,YAAY,GAAG,UAAU,GAAG,UAAU,CAAC;AAEvE;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,OAAO,EACjD,cAAc,CAAC,EAAE,MAAM,IAAI;AAC3B,gFAAgF;AAChF,qBAAqB,CAAC,EAAE,CAAC,CAAC,EAAE,iBAAiB,KAAK,OAAO,sBAoE1D"}