@itwin/itwinui-react 3.18.2 → 3.19.0

package/cjs/core/ToggleSwitch/ToggleSwitch.js

@@ -24,15 +24,22 @@ const ToggleSwitch = _react.forwardRef((props, ref) => {
     style,
     size = 'default',
     labelProps = {},
+    wrapperProps,
     icon: iconProp,
     ...rest
   } = props;
+  let { consistentPropsSpread } =
+    (0, _index.useFutureFlag)('ToggleSwitch') || {};
+  let shouldApplyClassNameAndStyleOnInput =
+    null != wrapperProps || consistentPropsSpread;
   let shouldShowIcon =
     void 0 === iconProp || (null !== iconProp && 'small' !== size);
   return _react.createElement(
     _index.Box,
     {
       as: label ? 'label' : 'div',
+      style: shouldApplyClassNameAndStyleOnInput ? void 0 : style,
+      ...wrapperProps,
       className: (0, _classnames.default)(
         'iui-toggle-switch-wrapper',
         {
@@ -40,19 +47,23 @@ const ToggleSwitch = _react.forwardRef((props, ref) => {
           'iui-label-on-right': label && 'right' === labelPosition,
           'iui-label-on-left': label && 'left' === labelPosition,
         },
-        className,
+        shouldApplyClassNameAndStyleOnInput ? void 0 : className,
+        wrapperProps?.className,
       ),
       'data-iui-size': size,
-      style: style,
     },
     _react.createElement(_index.Box, {
       as: 'input',
-      className: 'iui-toggle-switch',
       type: 'checkbox',
       role: 'switch',
+      style: shouldApplyClassNameAndStyleOnInput ? style : void 0,
+      ...rest,
+      className: (0, _classnames.default)(
+        'iui-toggle-switch',
+        shouldApplyClassNameAndStyleOnInput ? className : void 0,
+      ),
       disabled: disabled,
       ref: ref,
-      ...rest,
     }),
     shouldShowIcon &&
       _react.createElement(

package/cjs/styles.js

@@ -1,6 +1,6 @@
 'use strict';
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const e = '3.18.2';
+const e = '3.19.0';
 const u = new Proxy(
   {},
   {

package/cjs/utils/components/index.d.ts

@@ -9,6 +9,6 @@ export * from './Box.js';
 export * from './ButtonBase.js';
 export * from './Portal.js';
 export * from './ShadowRoot.js';
-export * from './LineClamp.js';
+export * from './lineClamp.js';
 export * from './FieldsetBase.js';
 export * from './OverflowContainer.js';

package/cjs/utils/components/index.js

@@ -14,6 +14,6 @@ _export_star._(require('./Box.js'), exports);
 _export_star._(require('./ButtonBase.js'), exports);
 _export_star._(require('./Portal.js'), exports);
 _export_star._(require('./ShadowRoot.js'), exports);
-_export_star._(require('./LineClamp.js'), exports);
+_export_star._(require('./lineClamp.js'), exports);
 _export_star._(require('./FieldsetBase.js'), exports);
 _export_star._(require('./OverflowContainer.js'), exports);

package/cjs/utils/components/lineClamp.d.ts

@@ -0,0 +1,5 @@
+/** @private */
+export declare const lineClamp: {
+    css: string;
+    className: string;
+};

package/cjs/utils/components/lineClamp.js

@@ -0,0 +1,23 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', {
+  value: true,
+});
+Object.defineProperty(exports, 'lineClamp', {
+  enumerable: true,
+  get: function () {
+    return lineClamp;
+  },
+});
+const className = '_iui-line-clamp';
+const css = `
+.${className} {
+  overflow: hidden;
+  display: -webkit-box;
+  -webkit-line-clamp: var(--_iui-line-clamp, 3);
+  -webkit-box-orient: vertical;
+}
+`;
+const lineClamp = {
+  css,
+  className,
+};

package/cjs/utils/functions/react.d.ts

@@ -1,4 +1,9 @@
 import * as React from 'react';
+/**
+ * `true` if the current React version is 17 or 18. Else, is `false`.
+ * @private
+ */
+export declare const isReact17or18: boolean;
 /**
  * Wrapper over `cloneElement` that automatically checks for `isValidElement`
  * and automatically merges `children.ref` with the ref passed in props.

package/cjs/utils/functions/react.js

@@ -2,19 +2,33 @@
 Object.defineProperty(exports, '__esModule', {
   value: true,
 });
-Object.defineProperty(exports, 'cloneElementWithRef', {
-  enumerable: true,
-  get: function () {
+function _export(target, all) {
+  for (var name in all)
+    Object.defineProperty(target, name, {
+      enumerable: true,
+      get: all[name],
+    });
+}
+_export(exports, {
+  cloneElementWithRef: function () {
     return cloneElementWithRef;
   },
+  isReact17or18: function () {
+    return isReact17or18;
+  },
 });
 const _interop_require_wildcard = require('@swc/helpers/_/_interop_require_wildcard');
 const _react = /*#__PURE__*/ _interop_require_wildcard._(require('react'));
 const _useMergedRefs = require('../hooks/useMergedRefs.js');
+const _React = _react;
+const isReact17or18 = (() => {
+  let version = _React.version?.split('.')?.[0];
+  return ['17', '18'].includes(version);
+})();
 const cloneElementWithRef = (children, getProps) => {
   if (!children) return null;
   if (!_react.isValidElement(children)) return children;
-  let childrenRef = children.props?.ref || children?.ref;
+  let childrenRef = isReact17or18 ? children?.ref : children.props?.ref;
   let props = getProps(children);
   let ref = (0, _useMergedRefs.mergeRefs)(
     ...[childrenRef, 'ref' in props ? props.ref : null].filter(Boolean),

package/cjs/utils/hooks/useControlledState.d.ts

@@ -1,4 +1,3 @@
-import * as React from 'react';
 /**
  * Wrapper over `useState` that always gives preference to the
  * controlled state (which often comes from a prop).
@@ -6,8 +5,12 @@ import * as React from 'react';
  * This is helpful when a component needs to support both uncontrolled
  * and controlled states. If controlled value/setter is not passed,
  * then it will work just like a regular `useState`.
+ * The only exception is that the set function only accepts the new state. It does not accept a function.
+ *
+ * **NOTE**: `setControlledState` is called only when the value *changes* (uncontrolled mode) or should *change*
+ * (controlled mode).
  *
  * @example
  * const [state, setState] = useControlledState(null, props.value, props.onChange);
  */
-export declare const useControlledState: <T>(initialValue: T, controlledState: T | undefined, setControlledState?: React.Dispatch<React.SetStateAction<T>>) => readonly [T, React.Dispatch<React.SetStateAction<T>>];
+export declare const useControlledState: <T>(initialValue: T, controlledState: T | undefined, setControlledState?: (value: T) => void) => readonly [T, (value: T) => void];

package/cjs/utils/hooks/useControlledState.js

@@ -10,6 +10,7 @@ Object.defineProperty(exports, 'useControlledState', {
 });
 const _interop_require_wildcard = require('@swc/helpers/_/_interop_require_wildcard');
 const _react = /*#__PURE__*/ _interop_require_wildcard._(require('react'));
+const _useLatestRef = require('./useLatestRef.js');
 const useControlledState = (
   initialValue,
   controlledState,
@@ -20,12 +21,15 @@ const useControlledState = (
     () => (void 0 !== controlledState ? controlledState : uncontrolledState),
     [controlledState, uncontrolledState],
   );
+  let oldState = (0, _useLatestRef.useLatestRef)(state);
   let setState = _react.useCallback(
     (value) => {
+      if (value === oldState.current) return;
+      oldState.current = value;
       setUncontrolledState(value);
       setControlledState?.(value);
     },
-    [setControlledState, setUncontrolledState],
+    [oldState, setControlledState],
   );
   return [state, setState];
 };

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

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

package/cjs/utils/providers/FutureFlagsProvider.d.ts

@@ -0,0 +1,37 @@
+import * as React from 'react';
+export type FutureOptions = {
+    /**
+     * @alpha
+     *
+     * If enabled, the theme resembles the future iTwinUI version's theme (including alphas) *whenever possible*.
+     *
+     * This is useful in making apps looks like future versions of iTwinUI to help with incremental adoption.
+     *
+     * **NOTE**: Since this is a theme bridge to *future* versions, the theme could have breaking changes.
+     */
+    themeBridge?: boolean;
+    ToggleSwitch?: {
+        /**
+         * When `true`, `className` and `style` will be applied on the
+         * input element, along with the rest of the DOM props.
+         *
+         * By default (without this flag), `className` and `style` get
+         * applied on the wrapper element, unless `wrapperProps` is also passed.
+         */
+        consistentPropsSpread?: boolean;
+    };
+};
+/**
+ * Hook to access future flags.
+ * @private
+ *
+ * @example
+ * ```jsx
+ * const themeBridge = useFutureFlag('themeBridge');
+ * ```
+ */
+export declare function useFutureFlag<K extends keyof FutureOptions>(key: K): FutureOptions[K];
+/** @private */
+export declare const FutureFlagsProvider: ({ children, value, }: React.PropsWithChildren<{
+    value: true | FutureOptions;
+}>) => React.JSX.Element;

package/cjs/utils/providers/FutureFlagsProvider.js

@@ -0,0 +1,48 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', {
+  value: true,
+});
+function _export(target, all) {
+  for (var name in all)
+    Object.defineProperty(target, name, {
+      enumerable: true,
+      get: all[name],
+    });
+}
+_export(exports, {
+  FutureFlagsProvider: function () {
+    return FutureFlagsProvider;
+  },
+  useFutureFlag: function () {
+    return useFutureFlag;
+  },
+});
+const _interop_require_wildcard = require('@swc/helpers/_/_interop_require_wildcard');
+const _react = /*#__PURE__*/ _interop_require_wildcard._(require('react'));
+const _useSafeContext = require('../hooks/useSafeContext.js');
+const FutureFlagsContext = _react.createContext({});
+function useFutureFlag(key) {
+  let context = (0, _useSafeContext.useSafeContext)(FutureFlagsContext);
+  return context[key];
+}
+const FutureFlagsProvider = ({ children, value }) => {
+  if (true === value)
+    value = {
+      themeBridge: true,
+    };
+  let context = _react.useContext(FutureFlagsContext);
+  let combinedValue = {
+    ...context,
+    ...value,
+  };
+  return _react.createElement(
+    FutureFlagsContext.Provider,
+    {
+      value: _react.useMemo(
+        () => combinedValue,
+        [JSON.stringify(combinedValue)],
+      ),
+    },
+    children,
+  );
+};

package/cjs/utils/providers/index.d.ts

@@ -1 +1,2 @@
+export * from './FutureFlagsProvider.js';
 export * from './HydrationProvider.js';

package/cjs/utils/providers/index.js

@@ -3,4 +3,5 @@ Object.defineProperty(exports, '__esModule', {
   value: true,
 });
 const _export_star = require('@swc/helpers/_/_export_star');
+_export_star._(require('./FutureFlagsProvider.js'), exports);
 _export_star._(require('./HydrationProvider.js'), exports);

package/esm/core/Buttons/DropdownButton.d.ts

@@ -8,7 +8,7 @@ export type DropdownButtonProps = {
      * Pass a function that takes the `close` argument (to close the menu),
      * and returns a list of `MenuItem` components.
      */
-    menuItems: (close: () => void) => React.JSX.Element[];
+    menuItems: ((close: () => void) => React.JSX.Element[]) | React.JSX.Element[] | React.JSX.Element;
     /**
      * Style of the dropdown button.
      * Use 'borderless' to hide outline.

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

@@ -1,20 +1,9 @@
 import * as React from 'react';
-export declare const ComboBoxMenuItem: React.NamedExoticComponent<Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "children" | "as" | "role" | "onClick" | "size" | "icon" | "disabled" | "value" | "startIcon" | "endIcon" | "index" | "focused" | "isSelected" | "sublabel" | "badge" | "subMenuItems"> & {
-    isSelected?: boolean;
-    disabled?: boolean;
-    value?: unknown;
-    onClick?: (value?: unknown) => void;
-    size?: "default" | "large";
-    sublabel?: React.ReactNode;
-    startIcon?: React.JSX.Element;
-    icon?: React.JSX.Element;
-    endIcon?: React.JSX.Element;
-    badge?: React.JSX.Element;
-    role?: string;
-    subMenuItems?: React.JSX.Element[];
-    children?: React.ReactNode;
-} & Pick<import("../List/ListItem.js").ListItemOwnProps, "focused"> & {
+import type { MenuItemProps } from '../Menu/MenuItem.js';
+type ComboBoxMenuItemProps = MenuItemProps & {
     index: number;
-} & {
+};
+export declare const ComboBoxMenuItem: React.NamedExoticComponent<Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "children" | "as" | "role" | "onClick" | "size" | "icon" | "disabled" | "value" | "startIcon" | "endIcon" | "index" | "focused" | "isSelected" | "sublabel" | "badge" | "subMenuItems"> & ComboBoxMenuItemProps & {
     as?: "div" | undefined;
 }>;
+export {};

package/esm/core/ComboBox/ComboBoxMenuItem.js

@@ -41,7 +41,7 @@ export const ComboBoxMenuItem = React.memo(
         disabled: disabled,
         focused: focusedIndex === index,
         ref: refs,
-        onClick: () => onClick?.(value),
+        onClick: () => onClick?.(),
         role: role,
         tabIndex: 'presentation' === role ? void 0 : -1,
         'aria-selected': isSelected,

package/esm/core/DropdownMenu/DropdownMenu.d.ts

@@ -16,7 +16,7 @@ export type DropdownMenuProps = {
     /**
      * Child element to wrap dropdown with.
      */
-    children: React.ReactNode;
+    children: React.JSX.Element;
     /**
      * Middleware options.
      *

package/esm/core/Menu/MenuItem.d.ts

@@ -10,14 +10,20 @@ export type MenuItemProps = {
      * Item is disabled.
      */
     disabled?: boolean;
+} & ({
     /**
      * Value of the item.
+     * @deprecated
      */
-    value?: unknown;
+    value: unknown;
     /**
      * Callback function that handles click and keyboard submit actions.
      */
     onClick?: (value?: unknown) => void;
+} | {
+    /** @deprecated */ value?: never;
+    onClick?: (event?: React.MouseEvent) => void;
+}) & {
     /**
      * Modify height of the item.
      * Use 'large' when any of the sibling items have `sublabel`.

package/esm/core/Menu/MenuItem.js

@@ -63,13 +63,10 @@ export const MenuItem = React.forwardRef((props, forwardedRef) => {
     }),
     [hasSubMenu],
   );
-  let onClick = () => {
+  let onClick = (event) => {
     if (disabled) return;
     if (shouldCloseMenuOnClick) dropdownMenu?.close();
-    onClickProp?.(value);
-  };
-  let handlers = {
-    onClick,
+    onClickProp?.(value ?? event);
   };
   let focusableItemIndex = parentMenu?.focusableElements.findIndex(
     (el) => el === menuItemRef.current,
@@ -94,9 +91,13 @@ export const MenuItem = React.forwardRef((props, forwardedRef) => {
       ...(parentMenu?.popoverGetItemProps != null
         ? parentMenu.popoverGetItemProps({
             focusableItemIndex,
-            userProps: handlers,
+            userProps: {
+              onClick,
+            },
           })
-        : handlers),
+        : {
+            onClick,
+          }),
       ...rest,
     },
     startIcon &&

package/esm/core/Popover/Popover.d.ts

@@ -14,8 +14,10 @@ type PopoverOptions = {
      */
     visible?: boolean;
     /**
-     * Callback invoked every time the popover visibility changes as a result
-     * of internal logic. Should be used alongside `visible` prop.
+     * Callback invoked every time the popover visibility *changes* (uncontrolled mode) or should *change*
+     * (controlled mode) as a result of internal logic.
+     *
+     * Should be used alongside `visible` prop.
      */
     onVisibleChange?: (visible: boolean) => void;
     /**
@@ -147,7 +149,7 @@ export declare const usePopover: (options: PopoverOptions & PopoverInternalProps
         elements: import("@floating-ui/react").ExtendedElements<import("@floating-ui/react").ReferenceType>;
     };
     open: boolean;
-    onOpenChange: React.Dispatch<React.SetStateAction<boolean>>;
+    onOpenChange: (value: boolean) => void;
     getReferenceProps: (userProps?: React.HTMLProps<HTMLElement>) => Record<string, unknown>;
     getFloatingProps: (userProps?: React.HTMLProps<HTMLElement>) => Record<string, unknown>;
 };

package/esm/core/Select/Select.js

@@ -12,6 +12,7 @@ import {
   useLatestRef,
   InputWithIcon,
   mergeEventHandlers,
+  isReact17or18,
 } from '../../utils/index.js';
 import { SelectTag } from './SelectTag.js';
 import { SelectTagContainer } from './SelectTagContainer.js';
@@ -174,7 +175,13 @@ let CustomSelect = React.forwardRef((props, forwardedRef) => {
               isSelected,
             })
           : React.createElement(MenuItem, null, option.label);
-        let { label, icon, startIcon: startIconProp, ...restOption } = option;
+        let {
+          label,
+          icon,
+          startIcon: startIconProp,
+          value: _,
+          ...restOption
+        } = option;
         let startIcon = startIconProp ?? icon;
         return React.cloneElement(menuItem, {
           key: `${label}-${index}`,
@@ -451,15 +458,17 @@ let SelectListbox = React.forwardRef((props, forwardedRef) => {
   }, []);
   let children = React.useMemo(
     () =>
-      React.Children.map(childrenProp, (child, index) =>
-        React.isValidElement(child)
-          ? React.createElement(CompositeItem, {
-              key: index,
-              render: child,
-              ref: child.props.ref || child.ref,
-            })
-          : child,
-      ),
+      React.Children.map(childrenProp, (child, index) => {
+        if (React.isValidElement(child)) {
+          let ref = isReact17or18 ? child.ref : child.props.ref;
+          return React.createElement(CompositeItem, {
+            key: index,
+            ref: ref,
+            render: child,
+          });
+        }
+        return child;
+      }),
     [childrenProp],
   );
   return React.createElement(

package/esm/core/SideNavigation/SideNavigation.js

@@ -30,9 +30,9 @@ export const SideNavigation = React.forwardRef((props, forwardedRef) => {
       className: 'iui-sidenav-button iui-expand',
       size: 'small',
       onClick: React.useCallback(() => {
-        setIsExpanded((expanded) => !expanded);
+        setIsExpanded(!isExpanded);
         onExpanderClick?.();
-      }, [onExpanderClick, setIsExpanded]),
+      }, [isExpanded, onExpanderClick, setIsExpanded]),
     },
     React.createElement(SvgChevronRight, null),
   );

package/esm/core/Table/ColumnHeader.js

@@ -2,7 +2,7 @@ import * as React from 'react';
 import {
   Box,
   ShadowRoot,
-  LineClamp,
+  lineClamp,
   SvgSortDown,
   SvgSortUp,
   useMergedRefs,
@@ -103,10 +103,14 @@ export const ColumnHeader = React.forwardRef((props, forwardedRef) => {
       'string' == typeof column.Header
         ? React.createElement(
             ShadowRoot,
-            null,
+            {
+              css: lineClamp.css,
+            },
             React.createElement(
-              LineClamp,
-              null,
+              'div',
+              {
+                className: lineClamp.className,
+              },
               React.createElement('slot', null),
             ),
             React.createElement('slot', {

package/esm/core/Table/Table.d.ts

@@ -206,8 +206,8 @@ export type TableProps<T extends Record<string, unknown> = Record<string, unknow
     /**
      * Passes props to the `role="table"` element within the wrapper.
      *
-     * If `tableProps` or `role` is passed to `Table`, all ARIA attributes passed to `Table` will be passed to the wrapper.
-     * Else, all ARIA attributes will be passed to the inner element with `role="table"`.
+     * - If `tableProps` or `role` is passed to `Table`, all ARIA attributes passed to `Table` will be passed to the wrapper.
+     * - Else, all ARIA attributes will be passed to the inner element with `role="table"`.
      */
     tableProps?: React.ComponentProps<'div'>;
     /**

package/esm/core/Table/Table.js

@@ -113,6 +113,38 @@ export const Table = (props) => {
     caption = 'Table',
     role,
     scrollToRow,
+    useControlledState,
+    autoResetExpanded,
+    autoResetFilters,
+    autoResetGlobalFilter,
+    autoResetHiddenColumns,
+    autoResetPage,
+    autoResetResize,
+    autoResetSelectedRows,
+    autoResetSortBy,
+    defaultCanFilter,
+    defaultCanSort,
+    defaultColumn: defaultColumnProp,
+    disableFilters,
+    disableGlobalFilter,
+    disableMultiSort,
+    disableSortRemove,
+    disabledMultiRemove,
+    expandSubRows,
+    globalFilter,
+    initialState,
+    isMultiSortEvent,
+    manualExpandedKey,
+    manualFilters,
+    manualGlobalFilter,
+    manualRowSelectedKey,
+    manualSortBy,
+    maxMultiSortColCount,
+    orderByFn,
+    pageCount,
+    sortTypes,
+    manualPagination,
+    paginateExpandedRows,
     ..._rest
   } = props;
   let { ariaRestAttributes, nonAriaRestAttributes } = React.useMemo(
@@ -153,8 +185,9 @@ export const Table = (props) => {
       maxWidth: 0,
       minWidth: 0,
       width: 0,
+      ...defaultColumnProp,
     }),
-    [],
+    [defaultColumnProp],
   );
   let rowHeight = React.useMemo(() => {
     if ('condensed' === density) return 50;
@@ -306,9 +339,36 @@ export const Table = (props) => {
   );
   let instance = useTable(
     {
-      manualPagination: !paginatorRenderer,
-      paginateExpandedRows: false,
-      ...props,
+      manualPagination: manualPagination ?? !paginatorRenderer,
+      paginateExpandedRows: paginateExpandedRows ?? false,
+      useControlledState,
+      autoResetExpanded,
+      autoResetFilters,
+      autoResetGlobalFilter,
+      autoResetHiddenColumns,
+      autoResetPage,
+      autoResetResize,
+      autoResetSelectedRows,
+      autoResetSortBy,
+      defaultCanFilter,
+      defaultCanSort,
+      disableFilters,
+      disableGlobalFilter,
+      disableMultiSort,
+      disableSortRemove,
+      disabledMultiRemove,
+      expandSubRows,
+      globalFilter,
+      isMultiSortEvent,
+      manualExpandedKey,
+      manualFilters,
+      manualGlobalFilter,
+      manualRowSelectedKey,
+      manualSortBy,
+      maxMultiSortColCount,
+      orderByFn,
+      pageCount: pageCount ?? -1,
+      sortTypes,
       columns,
       defaultColumn,
       disableSortBy: !isSortable,
@@ -319,7 +379,7 @@ export const Table = (props) => {
       getSubRows: subComponent ? getSubRowsWithSubComponents : getSubRows,
       initialState: {
         pageSize,
-        ...props.initialState,
+        ...initialState,
       },
       columnResizeMode,
       getRowId: subComponent ? getRowIdWithSubComponents : getRowId,