@itwin/itwinui-react 3.0.4 → 3.0.6

package/esm/core/utils/functions/colors.js

@@ -3,21 +3,21 @@
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
 export const SoftBackgrounds = {
-  skyblue: 'var(--iui-color-background-skyblue)',
-  celery: 'var(--iui-color-background-celery)',
-  froly: 'var(--iui-color-background-froly)',
-  steelblue: 'var(--iui-color-background-steelblue)',
-  sunglow: 'var(--iui-color-background-sunglow)',
-  seabuckthorn: 'var(--iui-color-background-seabuckthorn)',
-  montecarlo: 'var(--iui-color-background-montecarlo)',
-  poloblue: 'var(--iui-color-background-poloblue)',
-  bouquet: 'var(--iui-color-background-bouquet)',
-  ash: 'var(--iui-color-background-ash)',
-  oak: 'var(--iui-color-background-oak)',
+    skyblue: 'var(--iui-color-background-skyblue)',
+    celery: 'var(--iui-color-background-celery)',
+    froly: 'var(--iui-color-background-froly)',
+    steelblue: 'var(--iui-color-background-steelblue)',
+    sunglow: 'var(--iui-color-background-sunglow)',
+    seabuckthorn: 'var(--iui-color-background-seabuckthorn)',
+    montecarlo: 'var(--iui-color-background-montecarlo)',
+    poloblue: 'var(--iui-color-background-poloblue)',
+    bouquet: 'var(--iui-color-background-bouquet)',
+    ash: 'var(--iui-color-background-ash)',
+    oak: 'var(--iui-color-background-oak)',
 };
 /** Returns true if a string value is one of the SoftBackgrounds keys */
 export const isSoftBackground = (value) => {
-  return Object.keys(SoftBackgrounds).includes(value);
+    return Object.keys(SoftBackgrounds).includes(value);
 };
 const USER_COLORS = Object.values(SoftBackgrounds);
 /**
@@ -25,11 +25,11 @@ const USER_COLORS = Object.values(SoftBackgrounds);
  * Recommended to use for `backgroundColor` in `Avatar` component.
  */
 export const getUserColor = (emailOrName) => {
-  const normalizedString = emailOrName.trim().toLowerCase();
-  let hash = 0;
-  for (let i = 0; i < normalizedString.length; i++) {
-    const charCode = normalizedString.charCodeAt(i);
-    hash = (hash + charCode) % USER_COLORS.length;
-  }
-  return USER_COLORS[hash];
+    const normalizedString = emailOrName.trim().toLowerCase();
+    let hash = 0;
+    for (let i = 0; i < normalizedString.length; i++) {
+        const charCode = normalizedString.charCodeAt(i);
+        hash = (hash + charCode) % USER_COLORS.length;
+    }
+    return USER_COLORS[hash];
 };

package/esm/core/utils/functions/date.js

@@ -6,12 +6,12 @@
  * Return true if the first date is earlier than the second date
  */
 export const isBefore = (beforeDate, afterDate) => {
-  if (!beforeDate || !afterDate) {
-    return false;
-  }
-  const firstDate = new Date(beforeDate);
-  const secondDate = new Date(afterDate);
-  firstDate && firstDate.setHours(0, 0, 0, 0);
-  secondDate && secondDate.setHours(0, 0, 0, 0);
-  return firstDate < secondDate;
+    if (!beforeDate || !afterDate) {
+        return false;
+    }
+    const firstDate = new Date(beforeDate);
+    const secondDate = new Date(afterDate);
+    firstDate && firstDate.setHours(0, 0, 0, 0);
+    secondDate && secondDate.setHours(0, 0, 0, 0);
+    return firstDate < secondDate;
 };

package/esm/core/utils/functions/dev.js

@@ -6,8 +6,9 @@ const isJest = typeof jest !== 'undefined';
 let isDev = false;
 // wrapping in try-catch because process might be undefined
 try {
-  isDev = process.env.NODE_ENV !== 'production' && !isJest;
-} catch {}
+    isDev = process.env.NODE_ENV !== 'production' && !isJest;
+}
+catch { }
 /**
  * Logs message one time only in dev environments.
  *
@@ -16,14 +17,14 @@ try {
  * logWarningInDev("please don't use this")
  */
 const createWarningLogger = !isDev
-  ? () => () => {}
-  : () => {
-      let logged = false;
-      return (message) => {
-        if (!logged) {
-          console.warn(message);
-          logged = true;
-        }
-      };
+    ? () => () => { }
+    : () => {
+        let logged = false;
+        return (message) => {
+            if (!logged) {
+                console.warn(message);
+                logged = true;
+            }
+        };
     };
 export { isJest, isDev, createWarningLogger };

package/esm/core/utils/functions/dom.d.ts

@@ -19,4 +19,5 @@ export declare const mergeEventHandlers: <E extends import("react").SyntheticEve
  * @param element HTML element you want to get translate value of
  * @returns Translate values in pixels in an array `[translateX, translateY]`
  */
-export declare const getTranslateValues: (element: HTMLElement | null | undefined) => number[];
+export declare const getTranslateValuesFromElement: (element: HTMLElement | null | undefined) => number[];
+export declare const getTranslateValues: (transformValue: string) => number[];

package/esm/core/utils/functions/dom.js

@@ -7,40 +7,40 @@
  * Used to support SSR/SSG applications.
  */
 export const getDocument = () => {
-  return typeof document === 'undefined' ? undefined : document;
+    return typeof document === 'undefined' ? undefined : document;
 };
 /**
  * Get window if it is defined.
  * Used to support SSR/SSG applications.
  */
 export const getWindow = () => {
-  return typeof window === 'undefined' ? undefined : window;
+    return typeof window === 'undefined' ? undefined : window;
 };
 /**
  * Merges multiple event handlers into one, while making sure that
  * `defaultPrevented` is respected for each callback.
  */
-export const mergeEventHandlers =
-  (...callbacks) =>
-  (event) => {
+export const mergeEventHandlers = (...callbacks) => (event) => {
     for (const cb of callbacks) {
-      cb?.(event);
-      if (event?.defaultPrevented) {
-        return;
-      }
+        cb?.(event);
+        if (event?.defaultPrevented) {
+            return;
+        }
     }
-  };
+};
 /**
  * Returns translate values as an array of a given element.
  * @param element HTML element you want to get translate value of
  * @returns Translate values in pixels in an array `[translateX, translateY]`
  */
-export const getTranslateValues = (element) => {
-  if (!element) {
-    return [];
-  }
-  const transformValue =
-    getComputedStyle(element).getPropertyValue('transform');
-  const matrix = new DOMMatrix(transformValue);
-  return [matrix.m41, matrix.m42];
+export const getTranslateValuesFromElement = (element) => {
+    if (!element) {
+        return [];
+    }
+    const transformValue = getComputedStyle(element).getPropertyValue('transform');
+    return getTranslateValues(transformValue);
+};
+export const getTranslateValues = (transformValue) => {
+    const matrix = new DOMMatrix(transformValue);
+    return [matrix.m41, matrix.m42];
 };

package/esm/core/utils/functions/focusable.js

@@ -2,37 +2,28 @@
  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
-const tabbableElementsSelector =
-  'a[href], button, input, textarea, select, details, audio[controls], video[controls], [contenteditable]:not([contenteditable="false"]), [tabindex]:not([tabindex="-1"])';
+const tabbableElementsSelector = 'a[href], button, input, textarea, select, details, audio[controls], video[controls], [contenteditable]:not([contenteditable="false"]), [tabindex]:not([tabindex="-1"])';
 /**
  * Return array of tabbable elements in the container.
  */
 export const getTabbableElements = (container) => {
-  if (!container) {
-    return [];
-  }
-  const elements = container.querySelectorAll(tabbableElementsSelector);
-  return Array.from(elements).filter(
-    (el) =>
-      !el.hasAttribute('disabled') &&
-      !el.classList.contains('iui-disabled') &&
-      el.getAttribute('aria-disabled') !== 'true',
-  );
+    if (!container) {
+        return [];
+    }
+    const elements = container.querySelectorAll(tabbableElementsSelector);
+    return Array.from(elements).filter((el) => !el.hasAttribute('disabled') &&
+        !el.classList.contains('iui-disabled') &&
+        el.getAttribute('aria-disabled') !== 'true');
 };
 /**
  * Return array of focusable elements in the container.
  */
 export const getFocusableElements = (container) => {
-  if (!container) {
-    return [];
-  }
-  const elements = container.querySelectorAll(
-    `${tabbableElementsSelector}, [tabindex="-1"]`,
-  );
-  return Array.from(elements).filter(
-    (el) =>
-      !el.hasAttribute('disabled') &&
-      !el.classList.contains('iui-disabled') &&
-      el.getAttribute('aria-disabled') !== 'true',
-  );
+    if (!container) {
+        return [];
+    }
+    const elements = container.querySelectorAll(`${tabbableElementsSelector}, [tabindex="-1"]`);
+    return Array.from(elements).filter((el) => !el.hasAttribute('disabled') &&
+        !el.classList.contains('iui-disabled') &&
+        el.getAttribute('aria-disabled') !== 'true');
 };

package/esm/core/utils/functions/import.js

@@ -7,8 +7,6 @@
  *   1. typescript trying to transpile dynamic import in CJS environment (https://github.com/microsoft/TypeScript/issues/43329)
  *   2. jest/node causing segfault when encountering dynamic import (https://github.com/nodejs/node/issues/35889)
  */
-export const dynamicImport =
-  typeof jest === undefined
+export const dynamicImport = typeof jest === undefined
     ? new Function('specifier', 'return import(specifier)')
-    : (specifier) =>
-        import(/* webpackIgnore: true */ /* @vite-ignore */ specifier);
+    : (specifier) => import(/* webpackIgnore: true */ /* @vite-ignore */ specifier);

package/esm/core/utils/functions/numbers.d.ts

@@ -6,3 +6,10 @@ export declare const getBoundedValue: (val: number, min: number, max: number) =>
  * Returns a random value of a given length containing `A-Za-z0-9_-` symbols.
  */
 export declare const getRandomValue: (length?: number) => string;
+/**
+ * Rounds a pixel value based on the device's pixel ratio. This ensures that values can be
+ * placed evenly on the device’s pixel grid, avoiding any blurring.
+ *
+ * @see https://floating-ui.com/docs/misc#subpixel-and-accelerated-positioning
+ */
+export declare const roundByDPR: (value: number) => number;

package/esm/core/utils/functions/numbers.js

@@ -6,16 +6,26 @@
  * Return input value bounded by specified range.
  */
 export const getBoundedValue = (val, min, max) => {
-  return Math.min(max, Math.max(min, val));
+    return Math.min(max, Math.max(min, val));
 };
 /**
  * Returns a random value of a given length containing `A-Za-z0-9_-` symbols.
  */
 export const getRandomValue = (length = 21) => {
-  const alphabet = `_-0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ`;
-  let id = '';
-  for (let i = 0; i < length; i++) {
-    id += alphabet[(Math.random() * 64) | 0];
-  }
-  return id;
+    const alphabet = `_-0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ`;
+    let id = '';
+    for (let i = 0; i < length; i++) {
+        id += alphabet[(Math.random() * 64) | 0];
+    }
+    return id;
+};
+/**
+ * Rounds a pixel value based on the device's pixel ratio. This ensures that values can be
+ * placed evenly on the device’s pixel grid, avoiding any blurring.
+ *
+ * @see https://floating-ui.com/docs/misc#subpixel-and-accelerated-positioning
+ */
+export const roundByDPR = (value) => {
+    const dpr = window.devicePixelRatio || 1;
+    return Math.round(value * dpr) / dpr;
 };

package/esm/core/utils/functions/polymorphic.js

@@ -7,22 +7,15 @@ import cx from 'classnames';
 import { useGlobals } from '../hooks/useGlobals.js';
 import styles from '../../../styles.js';
 const _base = (defaultElement) => {
-  return (className, attrs) => {
-    const Comp = React.forwardRef(({ as = defaultElement, ...props }, ref) => {
-      const Element = as || 'div'; // eslint-disable-line
-      useGlobals();
-      return React.createElement(Element, {
-        ref: ref,
-        ...attrs,
-        ...props,
-        className: getScopedClassName(
-          cx(className, attrs?.className, props.className),
-        ),
-      });
-    });
-    Comp.displayName = getDisplayNameFromClass(className);
-    return Comp;
-  };
+    return (className, attrs) => {
+        const Comp = React.forwardRef(({ as = defaultElement, ...props }, ref) => {
+            const Element = as || 'div'; // eslint-disable-line
+            useGlobals();
+            return (React.createElement(Element, { ref: ref, ...attrs, ...props, className: getScopedClassName(cx(className, attrs?.className, props.className)) }));
+        });
+        Comp.displayName = getDisplayNameFromClass(className);
+        return Comp;
+    };
 };
 /**
  * Utility to create a type-safe polymorphic component with a simple class.
@@ -44,26 +37,24 @@ const _base = (defaultElement) => {
  * @private
  */
 export const polymorphic = new Proxy(_base('div'), {
-  get: (target, prop) => {
-    if (typeof prop === 'string') {
-      // eslint-disable-next-line -- string is as far as we can narrow it down
-      // @ts-ignore
-      return _base(prop);
-    }
-    return Reflect.get(target, prop);
-  },
+    get: (target, prop) => {
+        if (typeof prop === 'string') {
+            // eslint-disable-next-line -- string is as far as we can narrow it down
+            // @ts-ignore
+            return _base(prop);
+        }
+        return Reflect.get(target, prop);
+    },
 });
 // e.g. iui-list-item-icon -> ListItemIcon
 const getDisplayNameFromClass = (str) => {
-  const camel = str.replace(/-([a-z])/g, (g) => g[1].toUpperCase());
-  return camel.substring(3);
+    const camel = str.replace(/-([a-z])/g, (g) => g[1].toUpperCase());
+    return camel.substring(3);
 };
 // e.g. iui-button -> _iui3-button
 const getScopedClassName = (className = '') => {
-  return (
-    className
-      .split(' ')
-      .map((c) => (c in styles ? styles[c] : c))
-      .join(' ') || null
-  );
+    return (className
+        .split(' ')
+        .map((c) => (c in styles ? styles[c] : c))
+        .join(' ') || null);
 };

package/esm/core/utils/functions/react.js

@@ -11,25 +11,23 @@ import { mergeRefs } from '../hooks/useMergedRefs.js';
  * @private
  */
 export const cloneElementWithRef = (children, getProps) => {
-  if (!children) {
-    return null;
-  }
-  if (!React.isValidElement(children)) {
-    return children;
-  }
-  const props = getProps(children);
-  const ref = mergeRefs(
-    ...[
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      'ref' in children ? children.ref : null,
-      'ref' in props ? props.ref : null,
-    ].filter(Boolean),
-  );
-  return React.cloneElement(children, {
-    ...props,
-    // we already checked ref above and handled null, so ts-ignore is ok
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    ref,
-  });
+    if (!children) {
+        return null;
+    }
+    if (!React.isValidElement(children)) {
+        return children;
+    }
+    const props = getProps(children);
+    const ref = mergeRefs(...[
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        'ref' in children ? children.ref : null,
+        'ref' in props ? props.ref : null,
+    ].filter(Boolean));
+    return React.cloneElement(children, {
+        ...props,
+        // we already checked ref above and handled null, so ts-ignore is ok
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        ref,
+    });
 };

package/esm/core/utils/functions/supports.js

@@ -6,5 +6,4 @@ import { getWindow } from './dom.js';
 /**
  * Returns true if the :has selector is supported in the browser
  */
-export const supportsHas = () =>
-  getWindow()?.CSS?.supports?.('selector(:has(+ *))');
+export const supportsHas = () => getWindow()?.CSS?.supports?.('selector(:has(+ *))');

package/esm/core/utils/hooks/useContainerWidth.js

@@ -21,22 +21,19 @@ import { useResizeObserver } from './useResizeObserver.js';
  * return <div ref={ref}>...</div>;
  */
 export const useContainerWidth = (watchResizes = true) => {
-  const [contentWidth, setContentWidth] = React.useState(0);
-  const ref = React.useCallback((element) => {
-    if (!element) {
-      return;
+    const [contentWidth, setContentWidth] = React.useState(0);
+    const ref = React.useCallback((element) => {
+        if (!element) {
+            return;
+        }
+        setContentWidth(element.getBoundingClientRect().width);
+    }, []);
+    const updateWidth = React.useCallback(({ width }) => setContentWidth(width), []);
+    const [resizeRef, resizeObserver] = useResizeObserver(updateWidth);
+    if (!watchResizes) {
+        resizeObserver?.disconnect();
     }
-    setContentWidth(element.getBoundingClientRect().width);
-  }, []);
-  const updateWidth = React.useCallback(
-    ({ width }) => setContentWidth(width),
-    [],
-  );
-  const [resizeRef, resizeObserver] = useResizeObserver(updateWidth);
-  if (!watchResizes) {
-    resizeObserver?.disconnect();
-  }
-  const refs = useMergedRefs(ref, watchResizes ? resizeRef : undefined);
-  return [refs, contentWidth];
+    const refs = useMergedRefs(ref, watchResizes ? resizeRef : undefined);
+    return [refs, contentWidth];
 };
 export default useContainerWidth;

package/esm/core/utils/hooks/useControlledState.js

@@ -14,21 +14,12 @@ import * as React from 'react';
  * @example
  * const [state, setState] = useControlledState(null, props.value, props.onChange);
  */
-export const useControlledState = (
-  initialValue,
-  controlledState,
-  setControlledState,
-) => {
-  const [uncontrolledState, setUncontrolledState] =
-    React.useState(initialValue);
-  const state =
-    controlledState !== undefined ? controlledState : uncontrolledState;
-  const setState = React.useCallback(
-    (value) => {
-      setUncontrolledState(value);
-      setControlledState?.(value);
-    },
-    [setControlledState, setUncontrolledState],
-  );
-  return [state, setState];
+export const useControlledState = (initialValue, controlledState, setControlledState) => {
+    const [uncontrolledState, setUncontrolledState] = React.useState(initialValue);
+    const state = controlledState !== undefined ? controlledState : uncontrolledState;
+    const setState = React.useCallback((value) => {
+        setUncontrolledState(value);
+        setControlledState?.(value);
+    }, [setControlledState, setUncontrolledState]);
+    return [state, setState];
 };