@itwin/itwinui-react 3.11.3 → 3.12.1

package/esm/utils/hooks/useDragAndDrop.js

@@ -1,100 +1,116 @@
-/*---------------------------------------------------------------------------------------------
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
- * See LICENSE.md in the project root for license terms and full copyright notice.
- *--------------------------------------------------------------------------------------------*/
 import * as React from 'react';
-import { getTranslateValuesFromElement, getWindow, } from '../functions/index.js';
+import {
+  getTranslateValuesFromElement,
+  getWindow,
+} from '../functions/index.js';
 import { useEventListener } from './useEventListener.js';
 import { useResizeObserver } from './useResizeObserver.js';
 const getContainerRect = (containerRef) => {
-    const containerRect = containerRef?.current?.getBoundingClientRect();
-    return {
-        top: containerRect?.top ?? 0,
-        right: containerRect?.right ?? getWindow()?.innerWidth ?? 0,
-        bottom: containerRect?.bottom ?? getWindow()?.innerHeight ?? 0,
-        left: containerRect?.left ?? 0,
-    };
+  const containerRect = containerRef?.current?.getBoundingClientRect();
+  return {
+    top: containerRect?.top ?? 0,
+    right: containerRect?.right ?? getWindow()?.innerWidth ?? 0,
+    bottom: containerRect?.bottom ?? getWindow()?.innerHeight ?? 0,
+    left: containerRect?.left ?? 0,
+  };
 };
-/**
- * Helper hook that handles elements drag logic.
- * @param elementRef Element ref that is draggable.
- * @param containerRect Bounding rectangle of container element that element can't go outside. If not passed window is used as a container.
- * @returns
- * `onPointerDown` - handler that is called when pointer is down and handles all the dragging logic.
- * `transform` - current transform of the element, it is used to preserve drag position when element visibility is being toggled.
- */
 export const useDragAndDrop = (elementRef, containerRef, enabled = true) => {
-    const grabOffsetX = React.useRef(0);
-    const grabOffsetY = React.useRef(0);
-    const translateX = React.useRef();
-    const translateY = React.useRef();
-    const containerRectRef = React.useRef(getContainerRect(containerRef));
-    const adjustTransform = React.useCallback(() => {
-        if (!elementRef.current || !enabled) {
-            return;
-        }
-        const { top, right, bottom, left } = elementRef.current?.getBoundingClientRect();
-        let [newTranslateX, newTranslateY] = getTranslateValuesFromElement(elementRef.current);
-        containerRectRef.current = getContainerRect(containerRef);
-        if (bottom > containerRectRef.current.bottom) {
-            newTranslateY -= bottom - containerRectRef.current.bottom;
-        }
-        if (top < containerRectRef.current.top) {
-            newTranslateY += containerRectRef.current.top - top;
-        }
-        if (right > containerRectRef.current.right) {
-            newTranslateX -= right - containerRectRef.current.right;
-        }
-        if (left < containerRectRef.current.left) {
-            newTranslateX += containerRectRef.current.left - left;
-        }
-        translateX.current = newTranslateX;
-        translateY.current = newTranslateY;
-        elementRef.current.style.transform = `translate(${newTranslateX}px, ${newTranslateY}px)`;
-    }, [containerRef, elementRef, enabled]);
-    const [resizeRef, resizeObserver] = useResizeObserver(adjustTransform);
-    resizeRef(containerRef?.current);
-    React.useEffect(() => {
-        return () => {
-            resizeObserver?.disconnect();
-        };
-    }, [resizeObserver]);
-    useEventListener('resize', () => {
-        adjustTransform();
-        if (translateX.current != null && translateY.current != null) {
-            setTransform(`translate(${translateX.current}px, ${translateY.current}px)`);
-        }
-    }, getWindow());
-    const [transform, setTransform] = React.useState('');
-    const onPointerMove = React.useRef((event) => {
-        if (!elementRef.current) {
-            return;
-        }
-        const newTranslateX = event.clientX - grabOffsetX.current;
-        const newTranslateY = event.clientY - grabOffsetY.current;
-        elementRef.current.style.transform = `translate(${newTranslateX}px, ${newTranslateY}px)`;
-        adjustTransform();
-    });
-    const originalUserSelect = React.useRef('');
-    const onPointerDown = React.useCallback((e) => {
-        if (!elementRef.current || e.button !== 0 || !enabled) {
-            return;
-        }
-        const [x, y] = getTranslateValuesFromElement(elementRef.current);
-        grabOffsetX.current = e.clientX - x;
-        grabOffsetY.current = e.clientY - y;
-        originalUserSelect.current = elementRef.current.style.userSelect;
-        // Prevents from selecting inner content when dragging.
-        elementRef.current.style.userSelect = 'none';
-        const ownerDocument = elementRef.current.ownerDocument || document;
-        ownerDocument.addEventListener('pointermove', onPointerMove.current);
-        ownerDocument.addEventListener('pointerup', () => {
-            setTransform(`translate(${translateX.current}px, ${translateY.current}px)`);
-            ownerDocument.removeEventListener('pointermove', onPointerMove.current);
-            if (elementRef.current) {
-                elementRef.current.style.userSelect = originalUserSelect.current;
-            }
-        }, { once: true });
-    }, [elementRef, enabled]);
-    return { onPointerDown, transform };
+  const grabOffsetX = React.useRef(0);
+  const grabOffsetY = React.useRef(0);
+  const translateX = React.useRef();
+  const translateY = React.useRef();
+  const containerRectRef = React.useRef(getContainerRect(containerRef));
+  const adjustTransform = React.useCallback(() => {
+    if (!elementRef.current || !enabled) {
+      return;
+    }
+    const { top, right, bottom, left } =
+      elementRef.current?.getBoundingClientRect();
+    let [newTranslateX, newTranslateY] = getTranslateValuesFromElement(
+      elementRef.current,
+    );
+    containerRectRef.current = getContainerRect(containerRef);
+    if (bottom > containerRectRef.current.bottom) {
+      newTranslateY -= bottom - containerRectRef.current.bottom;
+    }
+    if (top < containerRectRef.current.top) {
+      newTranslateY += containerRectRef.current.top - top;
+    }
+    if (right > containerRectRef.current.right) {
+      newTranslateX -= right - containerRectRef.current.right;
+    }
+    if (left < containerRectRef.current.left) {
+      newTranslateX += containerRectRef.current.left - left;
+    }
+    translateX.current = newTranslateX;
+    translateY.current = newTranslateY;
+    elementRef.current.style.transform = `translate(${newTranslateX}px, ${newTranslateY}px)`;
+  }, [containerRef, elementRef, enabled]);
+  const [resizeRef, resizeObserver] = useResizeObserver(adjustTransform);
+  resizeRef(containerRef?.current);
+  React.useEffect(() => {
+    return () => {
+      resizeObserver?.disconnect();
+    };
+  }, [resizeObserver]);
+  useEventListener(
+    'resize',
+    () => {
+      adjustTransform();
+      if (translateX.current != null && translateY.current != null) {
+        setTransform(
+          `translate(${translateX.current}px, ${translateY.current}px)`,
+        );
+      }
+    },
+    getWindow(),
+  );
+  const [transform, setTransform] = React.useState('');
+  const onPointerMove = React.useRef((event) => {
+    if (!elementRef.current) {
+      return;
+    }
+    const newTranslateX = event.clientX - grabOffsetX.current;
+    const newTranslateY = event.clientY - grabOffsetY.current;
+    elementRef.current.style.transform = `translate(${newTranslateX}px, ${newTranslateY}px)`;
+    adjustTransform();
+  });
+  const originalUserSelect = React.useRef('');
+  const onPointerDown = React.useCallback(
+    (e) => {
+      if (!elementRef.current || e.button !== 0 || !enabled) {
+        return;
+      }
+      const [x, y] = getTranslateValuesFromElement(elementRef.current);
+      grabOffsetX.current = e.clientX - x;
+      grabOffsetY.current = e.clientY - y;
+      originalUserSelect.current = elementRef.current.style.userSelect;
+      elementRef.current.style.userSelect = 'none';
+      const ownerDocument = elementRef.current.ownerDocument || document;
+      ownerDocument.addEventListener('pointermove', onPointerMove.current);
+      ownerDocument.addEventListener(
+        'pointerup',
+        () => {
+          setTransform(
+            `translate(${translateX.current}px, ${translateY.current}px)`,
+          );
+          ownerDocument.removeEventListener(
+            'pointermove',
+            onPointerMove.current,
+          );
+          if (elementRef.current) {
+            elementRef.current.style.userSelect = originalUserSelect.current;
+          }
+        },
+        {
+          once: true,
+        },
+      );
+    },
+    [elementRef, enabled],
+  );
+  return {
+    onPointerDown,
+    transform,
+  };
 };

package/esm/utils/hooks/useEventListener.js

@@ -1,34 +1,17 @@
-/*---------------------------------------------------------------------------------------------
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
- * See LICENSE.md in the project root for license terms and full copyright notice.
- *--------------------------------------------------------------------------------------------*/
 import * as React from 'react';
-/**
- * Hook that adds and removes Event listeners.
- * @example
- *  useEventListener(
- *     'pointerup',
- *     handlePointerUp,
- *     containerRef.current?.ownerDocument,
- *  );
- */
 export const 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) => savedHandler.current?.(event);
-        element.addEventListener(eventName, eventListener);
-        return () => {
-            element.removeEventListener(eventName, eventListener);
-        };
-    }, [eventName, element]);
+  const savedHandler = React.useRef();
+  React.useEffect(() => {
+    savedHandler.current = handler;
+  }, [handler]);
+  React.useEffect(() => {
+    if (!element) {
+      return;
+    }
+    const eventListener = (event) => savedHandler.current?.(event);
+    element.addEventListener(eventName, eventListener);
+    return () => {
+      element.removeEventListener(eventName, eventListener);
+    };
+  }, [eventName, element]);
 };

package/esm/utils/hooks/useGlobals.d.ts

@@ -7,9 +7,9 @@ import { ThemeContext } from '../../core/ThemeProvider/ThemeContext.js';
  * @private
  */
 export declare const useGlobals: () => {
-    theme?: import("../../index.js").ThemeType | undefined;
-    themeOptions?: import("../../core/ThemeProvider/ThemeProvider.js").ThemeOptions | undefined;
-    portalContainer?: HTMLElement | null | undefined;
+    theme?: import("../../index.js").ThemeType;
+    themeOptions?: import("../../core/ThemeProvider/ThemeProvider.js").ThemeOptions;
+    portalContainer?: HTMLElement | null;
 } | undefined;
 /** Shows console error if ThemeProvider is not used */
 export declare const useThemeProviderWarning: (themeContext: React.ContextType<typeof ThemeContext>) => void;

package/esm/utils/hooks/useGlobals.js

@@ -1,46 +1,38 @@
-/*---------------------------------------------------------------------------------------------
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
- * See LICENSE.md in the project root for license terms and full copyright notice.
- *--------------------------------------------------------------------------------------------*/
 import * as React from 'react';
 import { ThemeContext } from '../../core/ThemeProvider/ThemeContext.js';
 import { isDev } from '../functions/dev.js';
 const didLogWarning = {
-    fontSize: false,
-    themeProvider: false,
+  fontSize: false,
+  themeProvider: false,
 };
-/**
- * Hook used in every component for any shared setup and side effects.
- * Returns the nearest ThemeContext.
- *
- * @private
- */
 export const useGlobals = () => {
-    const themeContext = React.useContext(ThemeContext);
-    useThemeProviderWarning(themeContext);
-    useRootFontSizeWarning();
-    return themeContext;
+  const themeContext = React.useContext(ThemeContext);
+  useThemeProviderWarning(themeContext);
+  useRootFontSizeWarning();
+  return themeContext;
 };
-// ----------------------------------------------------------------------------
-/** Shows console error if ThemeProvider is not used */
 export const useThemeProviderWarning = (themeContext) => {
-    React.useEffect(() => {
-        if (isDev && !didLogWarning.themeProvider && !themeContext) {
-            console.error('iTwinUI components must be used within a tree wrapped in a ThemeProvider.');
-            didLogWarning.themeProvider = true;
-        }
-    }, [themeContext]);
+  React.useEffect(() => {
+    if (isDev && !didLogWarning.themeProvider && !themeContext) {
+      console.error(
+        'iTwinUI components must be used within a tree wrapped in a ThemeProvider.',
+      );
+      didLogWarning.themeProvider = true;
+    }
+  }, [themeContext]);
 };
-// ----------------------------------------------------------------------------
-/** Shows console error if the page changes the root font size */
 const useRootFontSizeWarning = () => {
-    React.useEffect(() => {
-        if (isDev && !didLogWarning.fontSize) {
-            const rootFontSize = parseInt(getComputedStyle(document.documentElement).fontSize);
-            if (rootFontSize < 16) {
-                console.error('Root font size must not be overridden. \nSee https://github.com/iTwin/iTwinUI/wiki/iTwinUI-react-v2-migration-guide#relative-font-size');
-            }
-            didLogWarning.fontSize = true;
-        }
-    }, []);
+  React.useEffect(() => {
+    if (isDev && !didLogWarning.fontSize) {
+      const rootFontSize = parseInt(
+        getComputedStyle(document.documentElement).fontSize,
+      );
+      if (rootFontSize < 16) {
+        console.error(
+          'Root font size must not be overridden. \nSee https://github.com/iTwin/iTwinUI/wiki/iTwinUI-react-v2-migration-guide#relative-font-size',
+        );
+      }
+      didLogWarning.fontSize = true;
+    }
+  }, []);
 };

package/esm/utils/hooks/useId.js

@@ -1,18 +1,9 @@
-/*---------------------------------------------------------------------------------------------
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
- * See LICENSE.md in the project root for license terms and full copyright notice.
- *--------------------------------------------------------------------------------------------*/
 import * as React from 'react';
 import { getRandomValue } from '../functions/numbers.js';
-/**
- * Wrapper around React's `useId` hook, which prefixes the id with `iui-` and uses
- * a random value as fallback for older React versions which don't include `useId`.
- */
 export const useId = () => {
-    const uniqueValue = useUniqueValue();
-    return React.useMemo(() => `iui-${uniqueValue}`, [uniqueValue]);
+  const uniqueValue = useUniqueValue();
+  return React.useMemo(() => `iui-${uniqueValue}`, [uniqueValue]);
 };
-// This is needed to avoid bundlers trying to import non-existing export.
-// Read more: https://github.com/webpack/webpack/issues/14814
 const _React = React;
-const useUniqueValue = _React.useId ?? (() => React.useMemo(() => getRandomValue(10), []));
+const useUniqueValue =
+  _React.useId ?? (() => React.useMemo(() => getRandomValue(10), []));

package/esm/utils/hooks/useIntersection.js

@@ -1,40 +1,34 @@
-/*---------------------------------------------------------------------------------------------
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
- * See LICENSE.md in the project root for license terms and full copyright notice.
- *--------------------------------------------------------------------------------------------*/
 import * as React from 'react';
 import { getWindow } from '../functions/dom.js';
-/**
- * Hook that uses `IntersectionObserver` to trigger `onIntersect` callback when element is in viewport.
- * Callback is called only once by default (can be changed using the `once` parameter).
- * @returns a callback ref that needs to be set on the element you want to observe.
- * @private
- * @example
- * const onIntersection = React.useCallback(() => {
- *   console.log('Element is in viewport!');
- * }, []);
- * const ref = useIntersection(onIntersection);
- * return (<div ref={ref}>One of many elements</div>);
- */
 export const useIntersection = (onIntersect, options = {}, once = true) => {
-    const { root, rootMargin, threshold } = options;
-    const cleanupRef = React.useRef(() => { });
-    const setRef = React.useCallback((node) => {
-        cleanupRef.current?.();
-        cleanupRef.current = () => { }; // ensure it doesn't try to clean up again
-        if (!node || !getWindow()?.IntersectionObserver) {
-            return;
-        }
-        const observer = new IntersectionObserver(([entry], obs) => {
-            if (entry.isIntersecting) {
-                if (once) {
-                    obs.disconnect();
-                }
-                onIntersect();
+  const { root, rootMargin, threshold } = options;
+  const cleanupRef = React.useRef(() => {});
+  const setRef = React.useCallback(
+    (node) => {
+      cleanupRef.current?.();
+      cleanupRef.current = () => {};
+      if (!node || !getWindow()?.IntersectionObserver) {
+        return;
+      }
+      const observer = new IntersectionObserver(
+        ([entry], obs) => {
+          if (entry.isIntersecting) {
+            if (once) {
+              obs.disconnect();
             }
-        }, { root, rootMargin, threshold });
-        observer.observe(node);
-        cleanupRef.current = () => observer.disconnect();
-    }, [onIntersect, once, root, rootMargin, threshold]);
-    return setRef;
+            onIntersect();
+          }
+        },
+        {
+          root,
+          rootMargin,
+          threshold,
+        },
+      );
+      observer.observe(node);
+      cleanupRef.current = () => observer.disconnect();
+    },
+    [onIntersect, once, root, rootMargin, threshold],
+  );
+  return setRef;
 };

package/esm/utils/hooks/useIsClient.js

@@ -1,12 +1,8 @@
-/*---------------------------------------------------------------------------------------------
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
- * See LICENSE.md in the project root for license terms and full copyright notice.
- *--------------------------------------------------------------------------------------------*/
 import * as React from 'react';
 export const useIsClient = () => {
-    const [isClient, setIsClient] = React.useState(false);
-    React.useEffect(() => {
-        setIsClient(true);
-    }, []);
-    return isClient;
+  const [isClient, setIsClient] = React.useState(false);
+  React.useEffect(() => {
+    setIsClient(true);
+  }, []);
+  return isClient;
 };

package/esm/utils/hooks/useIsomorphicLayoutEffect.js

@@ -1,14 +1,4 @@
-/*---------------------------------------------------------------------------------------------
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
- * See LICENSE.md in the project root for license terms and full copyright notice.
- *--------------------------------------------------------------------------------------------*/
 import * as React from 'react';
-/**
- * SSR-safe version of `useLayoutEffect` that replaces it with `useEffect` on the server.
- *
- * Exported as `useLayoutEffect` so that the react hooks linter correctly identifies the necessary dependencies.
- *
- * @see https://fb.me/react-uselayouteffect-ssr
- */
-const useIsomorphicLayoutEffect = typeof window !== 'undefined' ? React.useLayoutEffect : React.useEffect;
+const useIsomorphicLayoutEffect =
+  typeof window !== 'undefined' ? React.useLayoutEffect : React.useEffect;
 export { useIsomorphicLayoutEffect as useLayoutEffect };

package/esm/utils/hooks/useLatestRef.js

@@ -1,19 +1,8 @@
-/*---------------------------------------------------------------------------------------------
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
- * See LICENSE.md in the project root for license terms and full copyright notice.
- *--------------------------------------------------------------------------------------------*/
 import * as React from 'react';
-/**
- * Hook that keeps track of the latest value in a ref.
- * @private
- * @example
- * const { value } = props;
- * const valueRef = useLatestRef(value);
- */
 export const useLatestRef = (value) => {
-    const valueRef = React.useRef(value);
-    React.useEffect(() => {
-        valueRef.current = value;
-    }, [value]);
-    return valueRef;
+  const valueRef = React.useRef(value);
+  React.useEffect(() => {
+    valueRef.current = value;
+  }, [value]);
+  return valueRef;
 };

package/esm/utils/hooks/useMediaQuery.js

@@ -1,19 +1,18 @@
-/*---------------------------------------------------------------------------------------------
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
- * See LICENSE.md in the project root for license terms and full copyright notice.
- *--------------------------------------------------------------------------------------------*/
 import * as React from 'react';
 import { useSyncExternalStore } from './useSyncExternalStore.js';
 export const useMediaQuery = (queryString) => {
-    const getSnapshot = React.useCallback(() => {
-        return typeof window !== 'undefined'
-            ? window.matchMedia?.(queryString).matches
-            : undefined;
-    }, [queryString]);
-    const subscribe = React.useCallback((onChange) => {
-        const mediaQueryList = window.matchMedia?.(queryString);
-        mediaQueryList?.addEventListener?.('change', onChange);
-        return () => mediaQueryList?.removeEventListener?.('change', onChange);
-    }, [queryString]);
-    return useSyncExternalStore(subscribe, getSnapshot, () => undefined);
+  const getSnapshot = React.useCallback(() => {
+    return typeof window !== 'undefined'
+      ? window.matchMedia?.(queryString).matches
+      : undefined;
+  }, [queryString]);
+  const subscribe = React.useCallback(
+    (onChange) => {
+      const mediaQueryList = window.matchMedia?.(queryString);
+      mediaQueryList?.addEventListener?.('change', onChange);
+      return () => mediaQueryList?.removeEventListener?.('change', onChange);
+    },
+    [queryString],
+  );
+  return useSyncExternalStore(subscribe, getSnapshot, () => undefined);
 };

package/esm/utils/hooks/useMergedRefs.d.ts

@@ -2,8 +2,8 @@ import * as React from 'react';
 /**
  * Function that merges the provided refs into one.
  */
-export declare const mergeRefs: <T>(...refs: (React.Ref<T> | undefined)[]) => (instance: T | null) => void;
+export declare const mergeRefs: <T>(...refs: Array<React.Ref<T> | React.LegacyRef<T> | undefined | null>) => (instance: T | null) => void;
 /**
  * Returns a ref callback that merges the provided refs using `mergeRefs`.
  */
-export declare const useMergedRefs: <T>(...refs: readonly (React.Ref<T> | undefined)[]) => (instance: T | null) => void;
+export declare const useMergedRefs: <T>(...refs: ReadonlyArray<React.Ref<T> | React.LegacyRef<T> | undefined | null>) => (instance: T | null) => void;

package/esm/utils/hooks/useMergedRefs.js

@@ -1,27 +1,15 @@
-/*---------------------------------------------------------------------------------------------
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
- * See LICENSE.md in the project root for license terms and full copyright notice.
- *--------------------------------------------------------------------------------------------*/
 import * as React from 'react';
-/**
- * Function that merges the provided refs into one.
- */
 export const mergeRefs = (...refs) => {
-    return (instance) => {
-        refs.forEach((ref) => {
-            if (typeof ref === 'function') {
-                ref(instance);
-            }
-            else if (ref) {
-                ref.current = instance;
-            }
-        });
-    };
+  return (instance) => {
+    refs.forEach((ref) => {
+      if (typeof ref === 'function') {
+        ref(instance);
+      } else if (ref) {
+        ref.current = instance;
+      }
+    });
+  };
 };
-/**
- * Returns a ref callback that merges the provided refs using `mergeRefs`.
- */
 export const useMergedRefs = (...refs) => {
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-    return React.useCallback(mergeRefs(...refs), [...refs]);
+  return React.useCallback(mergeRefs(...refs), [...refs]);
 };

package/esm/utils/hooks/useOverflow.d.ts

@@ -21,4 +21,4 @@ import * as React from 'react';
  *   </div>
  * );
  */
-export declare const useOverflow: <T extends HTMLElement>(items: React.ReactNode[] | string, disabled?: boolean, orientation?: 'horizontal' | 'vertical') => readonly [(instance: T | null | undefined) => void, number];
+export declare const useOverflow: <T extends HTMLElement>(items: React.ReactNode[] | string, disabled?: boolean, orientation?: "horizontal" | "vertical") => readonly [(instance: T | null | undefined) => void, number];