@itwin/itwinui-react 3.11.3 → 3.12.1

package/esm/core/ComboBox/ComboBox.types-test.js

@@ -0,0 +1,88 @@
+import { useRef } from 'react';
+import { ComboBox } from './ComboBox.js';
+() => {
+  const ref = useRef(null);
+  return React.createElement(ComboBox, {
+    options: [
+      {
+        label: 'Item 1',
+        value: 1,
+      },
+      {
+        label: 'Item 2',
+        value: 2,
+      },
+      {
+        label: 'Item 3',
+        value: 3,
+      },
+    ],
+    onChange: (value) => {
+      const returnValue = value;
+      return returnValue;
+    },
+    ref: ref,
+  });
+};
+() => {
+  return React.createElement(ComboBox, {
+    options: [
+      {
+        label: 'Item 1',
+        value: 1,
+      },
+      {
+        label: 'Item 2',
+        value: 2,
+      },
+      {
+        label: 'Item 3',
+        value: 3,
+      },
+    ],
+    onChange: (value) => {
+      const returnValue = value;
+      return returnValue;
+    },
+  });
+};
+() => {
+  return React.createElement(ComboBox, {
+    options: [
+      {
+        label: 'Item 1',
+        value: `1`,
+      },
+      {
+        label: 'Item 2',
+        value: `2`,
+      },
+      {
+        label: 'Item 3',
+        value: `3`,
+      },
+    ],
+    onChange: (value) => {
+      const returnValue = value;
+      return returnValue;
+    },
+  });
+};
+() => {
+  return React.createElement(
+    React.Fragment,
+    null,
+    React.createElement(ComboBox, {
+      options: [
+        {
+          label: 'Item #1',
+          value: 1,
+        },
+      ],
+      onChange: (value) => {
+        const returnValue = value;
+        return returnValue;
+      },
+    }),
+  );
+};

package/esm/core/ComboBox/ComboBoxEndIcon.js

@@ -1,16 +1,28 @@
-/*---------------------------------------------------------------------------------------------
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
- * See LICENSE.md in the project root for license terms and full copyright notice.
- *--------------------------------------------------------------------------------------------*/
 import cx from 'classnames';
 import * as React from 'react';
 import { SvgCaretDownSmall } from '../../utils/index.js';
 import { Icon } from '../Icon/Icon.js';
 export const ComboBoxEndIcon = React.forwardRef((props, forwardedRef) => {
-    const { className, children, disabled, isOpen, ...rest } = props;
-    return (React.createElement(Icon, { as: 'span', ref: forwardedRef, className: cx('iui-end-icon', {
-            'iui-disabled': disabled,
-            'iui-open': isOpen,
-        }, className), ...rest }, children ?? React.createElement(SvgCaretDownSmall, { "aria-hidden": true })));
+  const { className, children, disabled, isOpen, ...rest } = props;
+  return React.createElement(
+    Icon,
+    {
+      as: 'span',
+      ref: forwardedRef,
+      className: cx(
+        'iui-end-icon',
+        {
+          'iui-disabled': disabled,
+          'iui-open': isOpen,
+        },
+        className,
+      ),
+      ...rest,
+    },
+    children ??
+      React.createElement(SvgCaretDownSmall, {
+        'aria-hidden': true,
+      }),
+  );
 });
 ComboBoxEndIcon.displayName = 'ComboBoxEndIcon';

package/esm/core/ComboBox/ComboBoxInput.js

@@ -1,155 +1,206 @@
-/*---------------------------------------------------------------------------------------------
- * 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 { Input } from '../Input/Input.js';
-import { useSafeContext, useMergedRefs, useContainerWidth, mergeEventHandlers, useLatestRef, } from '../../utils/index.js';
+import {
+  useSafeContext,
+  useMergedRefs,
+  useContainerWidth,
+  mergeEventHandlers,
+  useLatestRef,
+} from '../../utils/index.js';
 import { ComboBoxMultipleContainer } from './ComboBoxMultipleContainer.js';
-import { ComboBoxStateContext, ComboBoxActionContext, ComboBoxRefsContext, } from './helpers.js';
+import { ComboBoxStateContext, ComboBoxRefsContext } from './helpers.js';
 export const ComboBoxInput = React.forwardRef((props, forwardedRef) => {
-    const { selectTags, size, style, ...rest } = props;
-    const { isOpen, id, focusedIndex, enableVirtualization, multiple, onClickHandler, popover, show, hide, } = useSafeContext(ComboBoxStateContext);
-    const dispatch = useSafeContext(ComboBoxActionContext);
-    const { inputRef, menuRef, optionsExtraInfoRef } = useSafeContext(ComboBoxRefsContext);
-    const refs = useMergedRefs(inputRef, popover.refs.setReference, forwardedRef);
-    const focusedIndexRef = useLatestRef(focusedIndex ?? -1);
-    const getIdFromIndex = (index) => {
-        return (menuRef.current?.querySelector(`[data-iui-index="${index}"]`)?.id ?? '');
-    };
-    const handleKeyDown = React.useCallback((event) => {
-        const length = Object.keys(optionsExtraInfoRef.current).length ?? 0;
-        if (event.altKey) {
+  const { selectTags, size, style, ...rest } = props;
+  const {
+    isOpen,
+    id,
+    focusedIndex,
+    setFocusedIndex,
+    enableVirtualization,
+    multiple,
+    onClickHandler,
+    popover,
+    show,
+    hide,
+  } = useSafeContext(ComboBoxStateContext);
+  const { inputRef, menuRef, optionsExtraInfo } =
+    useSafeContext(ComboBoxRefsContext);
+  const refs = useMergedRefs(inputRef, popover.refs.setReference, forwardedRef);
+  const focusedIndexRef = useLatestRef(focusedIndex ?? -1);
+  const getIdFromIndex = (index) => {
+    return (
+      menuRef.current?.querySelector(`[data-iui-index="${index}"]`)?.id ?? ''
+    );
+  };
+  const handleKeyDown = React.useCallback(
+    (event) => {
+      const length = Object.keys(optionsExtraInfo).length ?? 0;
+      if (event.altKey) {
+        return;
+      }
+      switch (event.key) {
+        case 'ArrowDown': {
+          event.preventDefault();
+          if (!isOpen) {
+            return show();
+          }
+          if (length === 0) {
             return;
-        }
-        switch (event.key) {
-            case 'ArrowDown': {
-                event.preventDefault();
-                if (!isOpen) {
-                    return show();
-                }
-                if (length === 0) {
-                    return;
-                }
-                if (focusedIndexRef.current === -1) {
-                    const currentElement = menuRef.current?.querySelector('[data-iui-index]');
-                    return dispatch({
-                        type: 'focus',
-                        value: Number(currentElement?.getAttribute('data-iui-index') ?? 0),
-                    });
-                }
-                // If virtualization is enabled, dont let round scrolling
-                if (enableVirtualization &&
-                    !menuRef.current?.querySelector(`[data-iui-index="${focusedIndexRef.current}"]`)?.nextElementSibling) {
-                    return;
-                }
-                let nextIndex = focusedIndexRef.current;
-                do {
-                    const currentElement = menuRef.current?.querySelector(`[data-iui-index="${nextIndex}"]`);
-                    const nextElement = currentElement?.nextElementSibling ??
-                        menuRef.current?.querySelector('[data-iui-index]');
-                    nextIndex = Number(nextElement?.getAttribute('data-iui-index'));
-                    if (nextElement) {
-                        return dispatch({ type: 'focus', value: nextIndex });
-                    }
-                } while (nextIndex !== focusedIndexRef.current);
-                break;
-            }
-            case 'ArrowUp': {
-                event.preventDefault();
-                if (!isOpen) {
-                    return show();
-                }
-                if (length === 0) {
-                    return;
-                }
-                // If virtualization is enabled, dont let round scrolling
-                if (enableVirtualization &&
-                    !menuRef.current?.querySelector(`[data-iui-index="${focusedIndexRef.current}"]`)?.previousElementSibling) {
-                    return;
-                }
-                if (focusedIndexRef.current === -1) {
-                    return dispatch({
-                        type: 'focus',
-                        value: Object.values(optionsExtraInfoRef.current)?.[length - 1]
-                            .__originalIndex ?? -1,
-                    });
-                }
-                let prevIndex = focusedIndexRef.current;
-                do {
-                    const currentElement = menuRef.current?.querySelector(`[data-iui-index="${prevIndex}"]`);
-                    const prevElement = currentElement?.previousElementSibling ??
-                        menuRef.current?.querySelector('[data-iui-index]:last-of-type');
-                    prevIndex = Number(prevElement?.getAttribute('data-iui-index'));
-                    if (prevElement) {
-                        return dispatch({ type: 'focus', value: prevIndex });
-                    }
-                } while (prevIndex !== focusedIndexRef.current);
-                break;
-            }
-            case 'Enter': {
-                event.preventDefault();
-                if (isOpen) {
-                    if (focusedIndexRef.current > -1) {
-                        onClickHandler?.(focusedIndexRef.current);
-                    }
-                }
-                else {
-                    show();
-                }
-                break;
+          }
+          if (focusedIndexRef.current === -1) {
+            const currentElement =
+              menuRef.current?.querySelector('[data-iui-index]');
+            return setFocusedIndex(
+              Number(currentElement?.getAttribute('data-iui-index') ?? 0),
+            );
+          }
+          if (
+            enableVirtualization &&
+            !menuRef.current?.querySelector(
+              `[data-iui-index="${focusedIndexRef.current}"]`,
+            )?.nextElementSibling
+          ) {
+            return;
+          }
+          let nextIndex = focusedIndexRef.current;
+          do {
+            const currentElement = menuRef.current?.querySelector(
+              `[data-iui-index="${nextIndex}"]`,
+            );
+            const nextElement =
+              currentElement?.nextElementSibling ??
+              menuRef.current?.querySelector('[data-iui-index]');
+            nextIndex = Number(nextElement?.getAttribute('data-iui-index'));
+            if (nextElement) {
+              return setFocusedIndex(nextIndex);
             }
-            case 'Escape': {
-                event.preventDefault();
-                hide();
-                break;
+          } while (nextIndex !== focusedIndexRef.current);
+          break;
+        }
+        case 'ArrowUp': {
+          event.preventDefault();
+          if (!isOpen) {
+            return show();
+          }
+          if (length === 0) {
+            return;
+          }
+          if (
+            enableVirtualization &&
+            !menuRef.current?.querySelector(
+              `[data-iui-index="${focusedIndexRef.current}"]`,
+            )?.previousElementSibling
+          ) {
+            return;
+          }
+          if (focusedIndexRef.current === -1) {
+            return setFocusedIndex(
+              Object.values(optionsExtraInfo)?.[length - 1].__originalIndex ??
+                -1,
+            );
+          }
+          let prevIndex = focusedIndexRef.current;
+          do {
+            const currentElement = menuRef.current?.querySelector(
+              `[data-iui-index="${prevIndex}"]`,
+            );
+            const prevElement =
+              currentElement?.previousElementSibling ??
+              menuRef.current?.querySelector('[data-iui-index]:last-of-type');
+            prevIndex = Number(prevElement?.getAttribute('data-iui-index'));
+            if (prevElement) {
+              return setFocusedIndex(prevIndex);
             }
-            case 'Tab':
-                hide();
-                break;
+          } while (prevIndex !== focusedIndexRef.current);
+          break;
         }
-    }, [
-        dispatch,
-        enableVirtualization,
-        focusedIndexRef,
-        isOpen,
-        menuRef,
-        onClickHandler,
-        optionsExtraInfoRef,
-        show,
-        hide,
-    ]);
-    /**
-     * This temporarily stores the state of `isOpen` before click event starts and resets it later.
-     * It is necessary because `isOpen` may have changed during the process of the click,
-     * e.g. because of focus, which could cause the menu to close immediately after opening.
-     */
-    const wasOpenBeforeClick = React.useRef(false);
-    const handlePointerDown = React.useCallback(() => {
-        wasOpenBeforeClick.current = isOpen;
-    }, [isOpen]);
-    const handleClick = React.useCallback(() => {
-        if (!wasOpenBeforeClick.current) {
+        case 'Enter': {
+          event.preventDefault();
+          if (isOpen) {
+            if (focusedIndexRef.current > -1) {
+              onClickHandler?.(focusedIndexRef.current);
+            }
+          } else {
             show();
+          }
+          break;
         }
-        else {
-            hide();
+        case 'Escape': {
+          event.preventDefault();
+          hide();
+          break;
         }
-        wasOpenBeforeClick.current = false;
-    }, [hide, show]);
-    const [tagContainerWidthRef, tagContainerWidth] = useContainerWidth();
-    return (React.createElement(React.Fragment, null,
-        React.createElement(Input, { ref: refs, "aria-expanded": isOpen, "aria-activedescendant": isOpen && focusedIndex != undefined && focusedIndex > -1
-                ? getIdFromIndex(focusedIndex)
-                : undefined, role: 'combobox', "aria-controls": isOpen ? `${id}-list` : undefined, "aria-autocomplete": 'list', spellCheck: false, autoCapitalize: 'none', autoCorrect: 'off', style: {
-                ...(multiple && { paddingInlineStart: tagContainerWidth + 18 }),
-                ...style,
-            }, "aria-describedby": multiple ? `${id}-selected-live` : undefined, size: size, ...popover.getReferenceProps({
-                ...rest,
-                onPointerDown: mergeEventHandlers(props.onPointerDown, handlePointerDown),
-                onClick: mergeEventHandlers(props.onClick, handleClick),
-                onKeyDown: mergeEventHandlers(props.onKeyDown, handleKeyDown),
-            }) }),
-        multiple && selectTags ? (React.createElement(ComboBoxMultipleContainer, { ref: tagContainerWidthRef, selectedItems: selectTags, id: `${id}-selected-live` })) : null));
+        case 'Tab':
+          hide();
+          break;
+      }
+    },
+    [
+      setFocusedIndex,
+      enableVirtualization,
+      focusedIndexRef,
+      isOpen,
+      menuRef,
+      onClickHandler,
+      optionsExtraInfo,
+      show,
+      hide,
+    ],
+  );
+  const wasOpenBeforeClick = React.useRef(false);
+  const handlePointerDown = React.useCallback(() => {
+    wasOpenBeforeClick.current = isOpen;
+  }, [isOpen]);
+  const handleClick = React.useCallback(() => {
+    if (!wasOpenBeforeClick.current) {
+      show();
+    } else {
+      hide();
+    }
+    wasOpenBeforeClick.current = false;
+  }, [hide, show]);
+  const [tagContainerWidthRef, tagContainerWidth] = useContainerWidth();
+  return React.createElement(
+    React.Fragment,
+    null,
+    React.createElement(Input, {
+      ref: refs,
+      'aria-expanded': isOpen,
+      'aria-activedescendant':
+        isOpen && focusedIndex != undefined && focusedIndex > -1
+          ? getIdFromIndex(focusedIndex)
+          : undefined,
+      role: 'combobox',
+      'aria-controls': isOpen ? `${id}-list` : undefined,
+      'aria-autocomplete': 'list',
+      spellCheck: false,
+      autoCapitalize: 'none',
+      autoCorrect: 'off',
+      style: {
+        ...(multiple && {
+          paddingInlineStart: tagContainerWidth + 18,
+        }),
+        ...style,
+      },
+      'aria-describedby': multiple ? `${id}-selected-live` : undefined,
+      size: size,
+      ...popover.getReferenceProps({
+        ...rest,
+        onPointerDown: mergeEventHandlers(
+          props.onPointerDown,
+          handlePointerDown,
+        ),
+        onClick: mergeEventHandlers(props.onClick, handleClick),
+        onKeyDown: mergeEventHandlers(props.onKeyDown, handleKeyDown),
+      }),
+    }),
+    multiple && selectTags
+      ? React.createElement(ComboBoxMultipleContainer, {
+          ref: tagContainerWidthRef,
+          selectedItems: selectTags,
+          id: `${id}-selected-live`,
+        })
+      : null,
+  );
 });
 ComboBoxInput.displayName = 'ComboBoxInput';

package/esm/core/ComboBox/ComboBoxInputContainer.js

@@ -1,16 +1,39 @@
-/*---------------------------------------------------------------------------------------------
- * 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 { StatusMessage } from '../StatusMessage/StatusMessage.js';
-import { InputContainer, useSafeContext, InputWithIcon, } from '../../utils/index.js';
+import {
+  InputContainer,
+  useSafeContext,
+  InputWithIcon,
+} from '../../utils/index.js';
 import { ComboBoxStateContext } from './helpers.js';
-export const ComboBoxInputContainer = React.forwardRef((props, forwardedRef) => {
+export const ComboBoxInputContainer = React.forwardRef(
+  (props, forwardedRef) => {
     const { className, status, message, children, ...rest } = props;
     const { id } = useSafeContext(ComboBoxStateContext);
-    return (React.createElement(InputContainer, { className: className, status: status, statusMessage: typeof message === 'string' ? (React.createElement(StatusMessage, { status: status }, message)) : (React.isValidElement(message) &&
-            React.cloneElement(message, { status })), ref: forwardedRef, ...rest, id: id },
-        React.createElement(InputWithIcon, null, children)));
-});
+    return React.createElement(
+      InputContainer,
+      {
+        className: className,
+        status: status,
+        statusMessage:
+          typeof message === 'string'
+            ? React.createElement(
+                StatusMessage,
+                {
+                  status: status,
+                },
+                message,
+              )
+            : React.isValidElement(message) &&
+              React.cloneElement(message, {
+                status,
+              }),
+        ref: forwardedRef,
+        ...rest,
+        id: id,
+      },
+      React.createElement(InputWithIcon, null, children),
+    );
+  },
+);
 ComboBoxInputContainer.displayName = 'ComboBoxInputContainer';

package/esm/core/ComboBox/ComboBoxMenu.d.ts

@@ -1,6 +1,6 @@
 import * as React from 'react';
 import { Menu } from '../Menu/Menu.js';
 import type { PolymorphicForwardRefComponent } from '../../utils/index.js';
-type ComboBoxMenuProps = Omit<React.ComponentPropsWithoutRef<typeof Menu>, 'onClick'> & React.ComponentPropsWithoutRef<'div'>;
+type ComboBoxMenuProps = Omit<React.ComponentPropsWithoutRef<typeof Menu>, 'onClick' | 'trigger'> & React.ComponentPropsWithoutRef<'div'>;
 export declare const ComboBoxMenu: PolymorphicForwardRefComponent<"div", ComboBoxMenuProps>;
 export {};

package/esm/core/ComboBox/ComboBoxMenu.js

@@ -1,53 +1,95 @@
-/*---------------------------------------------------------------------------------------------
- * 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 cx from 'classnames';
-import { Menu } from '../Menu/Menu.js';
-import { useSafeContext, useMergedRefs, useVirtualization, Portal, Box, } from '../../utils/index.js';
+import {
+  useSafeContext,
+  useMergedRefs,
+  useVirtualization,
+  Portal,
+  Box,
+} from '../../utils/index.js';
 import { ComboBoxStateContext, ComboBoxRefsContext } from './helpers.js';
 import { List } from '../List/List.js';
 const VirtualizedComboBoxMenu = (props) => {
-    const { children, ...rest } = props;
-    const { filteredOptions, getMenuItem, focusedIndex } = useSafeContext(ComboBoxStateContext);
-    const { menuRef } = useSafeContext(ComboBoxRefsContext);
-    const virtualItemRenderer = React.useCallback((index) => filteredOptions.length > 0
+  const { children, ...rest } = props;
+  const { filteredOptions, getMenuItem, focusedIndex } =
+    useSafeContext(ComboBoxStateContext);
+  const { menuRef } = useSafeContext(ComboBoxRefsContext);
+  const virtualItemRenderer = React.useCallback(
+    (index) =>
+      filteredOptions.length > 0
         ? getMenuItem(filteredOptions[index], index)
-        : children, // Here is expected empty state content
-    [filteredOptions, getMenuItem, children]);
-    const focusedVisibleIndex = React.useMemo(() => {
-        const currentElement = menuRef.current?.querySelector(`[data-iui-index="${focusedIndex}"]`);
-        if (!currentElement) {
-            return focusedIndex;
-        }
-        return Number(currentElement.getAttribute('data-iui-filtered-index') ?? focusedIndex);
-    }, [focusedIndex, menuRef]);
-    const { outerProps, innerProps, visibleChildren } = useVirtualization({
-        // 'Fool' VirtualScroll by passing length 1
-        // whenever there is no elements, to show empty state message
-        itemsLength: filteredOptions.length || 1,
-        itemRenderer: virtualItemRenderer,
-        scrollToIndex: focusedVisibleIndex,
-    });
-    return (React.createElement(Box, { as: 'div', ...outerProps, ...rest },
-        React.createElement("div", { ...innerProps, ref: innerProps.ref }, visibleChildren)));
+        : children,
+    [filteredOptions, getMenuItem, children],
+  );
+  const focusedVisibleIndex = React.useMemo(() => {
+    const currentElement = menuRef.current?.querySelector(
+      `[data-iui-index="${focusedIndex}"]`,
+    );
+    if (!currentElement) {
+      return focusedIndex;
+    }
+    return Number(
+      currentElement.getAttribute('data-iui-filtered-index') ?? focusedIndex,
+    );
+  }, [focusedIndex, menuRef]);
+  const { outerProps, innerProps, visibleChildren } = useVirtualization({
+    itemsLength: filteredOptions.length || 1,
+    itemRenderer: virtualItemRenderer,
+    scrollToIndex: focusedVisibleIndex,
+  });
+  return React.createElement(
+    Box,
+    {
+      as: 'div',
+      ...outerProps,
+      ...rest,
+    },
+    React.createElement(
+      'div',
+      {
+        ...innerProps,
+        ref: innerProps.ref,
+      },
+      visibleChildren,
+    ),
+  );
 };
 export const ComboBoxMenu = React.forwardRef((props, forwardedRef) => {
-    const { className, children, style, ...rest } = props;
-    const { id, enableVirtualization, popover } = useSafeContext(ComboBoxStateContext);
-    const { menuRef } = useSafeContext(ComboBoxRefsContext);
-    const refs = useMergedRefs(popover.refs.setFloating, forwardedRef, menuRef);
-    return (popover.open && (React.createElement(Portal, { portal: true },
-        React.createElement(List, { as: 'div', className: cx('iui-menu', className), id: `${id}-list`, role: 'listbox', ref: refs, ...popover.getFloatingProps({
-                style: !enableVirtualization
-                    ? style
-                    : {
-                        // set as constant because we don't want it shifting when items are unmounted
-                        maxInlineSize: 0,
-                        ...style,
-                    },
-                ...rest,
-            }) }, !enableVirtualization ? (children) : (React.createElement(VirtualizedComboBoxMenu, null, children))))));
+  const { className, children, style, ...rest } = props;
+  const { id, enableVirtualization, popover } =
+    useSafeContext(ComboBoxStateContext);
+  const { menuRef } = useSafeContext(ComboBoxRefsContext);
+  const refs = useMergedRefs(popover.refs.setFloating, forwardedRef, menuRef);
+  return (
+    popover.open &&
+    React.createElement(
+      Portal,
+      {
+        portal: true,
+      },
+      React.createElement(
+        List,
+        {
+          as: 'div',
+          className: cx('iui-menu', className),
+          id: `${id}-list`,
+          role: 'listbox',
+          ref: refs,
+          ...popover.getFloatingProps({
+            style: !enableVirtualization
+              ? style
+              : {
+                  maxInlineSize: 0,
+                  ...style,
+                },
+            ...rest,
+          }),
+        },
+        !enableVirtualization
+          ? children
+          : React.createElement(VirtualizedComboBoxMenu, null, children),
+      ),
+    )
+  );
 });
 ComboBoxMenu.displayName = 'ComboBoxMenu';