@itwin/itwinui-react 3.15.5 → 3.16.0

package/esm/core/Dialog/DialogContext.d.ts

@@ -30,13 +30,17 @@ export type DialogContextProps = {
      */
     closeOnEsc?: boolean;
     /**
-     * Traps the focus inside the dialog. This is useful when the dialog is modal.
+     * Prevents focus from leaving the dialog. This is useful when the dialog is modal.
+     *
+     * Setting this prop to `true` will also set `setFocus` to `true`.
+     *
      * @default false
      */
     trapFocus?: boolean;
     /**
      * If true, focuses the dialog.
-     * @default false
+     *
+     * Defaults to `true` if `trapFocus` is set to `true`, otherwise defaults to `false`.
      */
     setFocus?: boolean;
     /**

package/esm/core/Panels/Panels.d.ts

@@ -0,0 +1,174 @@
+import * as React from 'react';
+import type { PolymorphicForwardRefComponent } from '../../utils/index.js';
+import { Text } from '../Typography/Text.js';
+import type { FocusEntry, PanelsInstance, TriggerMapEntry } from './helpers.js';
+type PanelsWrapperProps = {
+    /**
+     * Function that gets called when the active panel is changed.
+     */
+    onActiveIdChange?: (newActiveId: string) => void;
+    children: React.ReactNode;
+    /**
+     * Pass an instance created by `useInstance` to control the panels imperatively.
+     *
+     * @example
+     * const panels = Panels.useInstance();
+     * <Panels instance={panels} />
+     */
+    instance?: PanelsInstance;
+};
+export declare const PanelsWrapper: PolymorphicForwardRefComponent<"div", PanelsWrapperProps>;
+export declare const PanelsWrapperContext: React.Context<{
+    activePanelId: string | undefined;
+    setActivePanelId: React.Dispatch<React.SetStateAction<string>>;
+    /**
+     * Simpler alternative to a full history stack.
+     *
+     * ```
+     * Record<
+     *   string, // Id of a panel
+     *   {
+     *     triggerId: string, // Id of the trigger element that points to this panel
+     *     panelId: string, // Id of the panel element in which the trigger is present
+     *   }
+     * >
+     * ```
+     */
+    triggers: Record<string, TriggerMapEntry>;
+    setTriggers: React.Dispatch<React.SetStateAction<Record<string, TriggerMapEntry>>>;
+    changeActivePanel: (newActiveId: string) => void;
+    shouldFocus: FocusEntry;
+    setShouldFocus: React.Dispatch<React.SetStateAction<FocusEntry>>;
+    panels: React.MutableRefObject<Set<string>>;
+} | undefined>;
+type PanelProps = {
+    id: string;
+};
+type PanelTriggerProps = {
+    for: string;
+    children: React.ReactElement;
+};
+type PanelHeaderProps = {
+    titleProps?: React.ComponentProps<typeof Text>;
+};
+export declare const Panels: {
+    /**
+     * Component that manages the logic for layered panels.
+     * It can be used anywhere to create layers. E.g. `Menu`, `InformationPanel`, `Popover`, etc.
+     *
+     * Requirements:
+     * - The initial displayed Panel should be the first `Panel` in the `Panels.Wrapper`.
+     * - A panel can have only one trigger pointing to it. i.e. out of all the triggers across all panels,
+     *   only one can point to a particular panel.
+     * - The `Panels.Panel`s within the wrapper should be in the order of the navigation. E.g.:
+     *   ```jsx
+     *   <Panels.Wrapper>
+     *     <Panels.Panel id={root} /> // Must come before moreDetails since it contains the trigger to moreDetails
+     *     <Panels.Panel id={moreDetails}> // Must come after root since it is navigated to from root
+     *   </Panels.Wrapper>
+     *   ```
+     *
+     * @example
+     * <Panels.Wrapper as={Surface}>
+     *   <Panels.Panel
+     *     id={panelIdRoot}
+     *     as={Surface}
+     *     border={false}
+     *     elevation={0}
+     *   >
+     *     <Surface.Header as={Panels.Header}>Root</Surface.Header>
+     *     <Surface.Body as={List}>
+     *       <ListItem>
+     *         <Panels.Trigger for={panelIdMoreInfo}>
+     *           <ListItem.Action>More details</ListItem.Action>
+     *         </Panels.Trigger>
+     *       </ListItem>
+     *     </Surface.Body>
+     *   </Panels.Panel>
+     *
+     *   <Panels.Panel
+     *     id={panelIdMoreInfo}
+     *     as={Surface}
+     *     border={false}
+     *     elevation={0}
+     *   >
+     *     <Surface.Header as={Panels.Header}>More details</Surface.Header>
+     *     <Surface.Body isPadded>
+     *       <Text>Content</Text>
+     *     </Surface.Body>
+     *   </Panels.Panel>
+     * </Panels.Wrapper>
+     */
+    Wrapper: PolymorphicForwardRefComponent<"div", PanelsWrapperProps>;
+    /**
+     * Takes an `id` and the panel content.
+     * Match this `id` with a `Panels.Triggers`'s `for` prop to create a link between them.
+     *
+     * @example
+     * <Panels.Panel id={panelIdRoot} as={Surface} border={false} elevation={0}>
+     *   <Surface.Header as={Panels.Header}>Root</Surface.Header>
+     *   <Surface.Body as={List}>
+     *     <ListItem>
+     *       <Panels.Trigger for={panelIdMoreInfo}>
+     *         <ListItem.Action>More details</ListItem.Action>
+     *       </Panels.Trigger>
+     *     </ListItem>
+     *   </Surface.Body>
+     * </Panels.Panel>
+     */
+    Panel: PolymorphicForwardRefComponent<"div", PanelProps>;
+    /**
+     * Wraps the clickable element and appends an `onClick` to change the active panel to the one specified in the `for`
+     * prop. Also appends some attributes for accessibility.
+     *
+     * @example
+     * <Panels.Trigger for={nextPanelId}>
+     *   <Button>go to next panel</Button>
+     * </Panels.Trigger>
+     *
+     * @example
+     * <ListItem>
+     *   <Panels.Trigger for={panelIdMoreInfo}>
+     *     <ListItem.Action>More details</ListItem.Action>
+     *   </Panels.Trigger>
+     * </ListItem>
+     */
+    Trigger: {
+        (props: PanelTriggerProps): string | number | true | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | null;
+        displayName: string;
+    };
+    /**
+     * Required component to add an accessible name and also a back button (if previous panel exists) to the panel.
+     *
+     * @example
+     * <Panels.Panel id={panelIdRoot}>
+     *   <Panels.Header>Root</Panels.Header>
+     *   …
+     * </Panels.Panel>
+     *
+     * @example
+     * <Panels.Panel
+     *   id={panelIdMoreInfo}
+     *   as={Surface}
+     *   border={false}
+     *   elevation={0}
+     * >
+     *   <Surface.Header as={Panels.Header}>More details</Surface.Header>
+     *   <Surface.Body isPadded>
+     *     <Text>Content</Text>
+     *   </Surface.Body>
+     * </Panels.Panel>
+     */
+    Header: PolymorphicForwardRefComponent<"div", PanelHeaderProps>;
+    /**
+     * You can use methods from `Panels.useInstance()` to control the state programmatically.
+     *
+     * @example
+     * const panels = Panels.useInstance();
+     *
+     * <Button onClick={() => panels.goBack()}>Go back</Button>
+     * <Panels.Wrapper instance={panels}>{…}</Panels.Wrapper>;
+     */
+    useInstance: () => PanelsInstance;
+};
+export {};

package/esm/core/Panels/Panels.js

@@ -0,0 +1,294 @@
+import * as React from 'react';
+import * as ReactDOM from 'react-dom';
+import {
+  Box,
+  cloneElementWithRef,
+  mergeEventHandlers,
+  SvgChevronLeft,
+  useInstance,
+  useMergedRefs,
+  useSafeContext,
+  useMediaQuery,
+  useWarningLogger,
+  useLayoutEffect,
+  useLatestRef,
+} from '../../utils/index.js';
+import { IconButton } from '../Buttons/IconButton.js';
+import { Flex } from '../Flex/Flex.js';
+import { Text } from '../Typography/Text.js';
+import cx from 'classnames';
+import { PanelsInstanceContext, PanelsInstanceProvider } from './helpers.js';
+export const PanelsWrapper = React.forwardRef((props, forwardedRef) => {
+  let {
+    children,
+    className,
+    onActiveIdChange: onActiveIdChangeProp,
+    instance,
+    ...rest
+  } = props;
+  let onActiveIdChange = useLatestRef(onActiveIdChangeProp);
+  let ref = React.useRef(null);
+  let [activePanelId, setActivePanelId] = React.useState(void 0);
+  let [triggers, setTriggers] = React.useState({});
+  let panels = React.useRef(new Set());
+  let [shouldFocus, setShouldFocus] = React.useState(void 0);
+  let motionOk = useMediaQuery('(prefers-reduced-motion: no-preference)');
+  let changeActivePanel = React.useCallback(
+    (newActiveId) => {
+      if (!panels.current.has(newActiveId) || newActiveId === activePanelId)
+        return;
+      ReactDOM.flushSync(() => setActivePanelId(newActiveId));
+      onActiveIdChange.current?.(newActiveId);
+      ref.current?.ownerDocument.getElementById(newActiveId)?.scrollIntoView({
+        block: 'nearest',
+        inline: 'center',
+        behavior: motionOk ? 'smooth' : 'instant',
+      });
+    },
+    [activePanelId, motionOk, onActiveIdChange],
+  );
+  return React.createElement(
+    PanelsWrapperContext.Provider,
+    {
+      value: React.useMemo(
+        () => ({
+          activePanelId,
+          setActivePanelId,
+          changeActivePanel,
+          triggers,
+          setTriggers,
+          shouldFocus,
+          setShouldFocus,
+          panels,
+        }),
+        [
+          activePanelId,
+          changeActivePanel,
+          setActivePanelId,
+          setTriggers,
+          shouldFocus,
+          triggers,
+        ],
+      ),
+    },
+    React.createElement(
+      PanelsInstanceProvider,
+      {
+        instance: instance,
+      },
+      React.createElement(
+        Box,
+        {
+          ref: useMergedRefs(ref, forwardedRef),
+          ...rest,
+          className: cx('iui-panel-wrapper', className),
+        },
+        children,
+      ),
+    ),
+  );
+});
+export const PanelsWrapperContext = React.createContext(void 0);
+let Panel = React.forwardRef((props, forwardedRef) => {
+  let { id, children, className, ...rest } = props;
+  let { activePanelId, triggers, panels, setActivePanelId } =
+    useSafeContext(PanelsWrapperContext);
+  let associatedTrigger = React.useMemo(() => triggers[id], [id, triggers]);
+  let previousActivePanelId = useDelayed(activePanelId) || activePanelId;
+  let isMounted = [activePanelId, previousActivePanelId].includes(id);
+  let isTransitioning =
+    activePanelId === id && activePanelId !== previousActivePanelId;
+  let isInert = previousActivePanelId === id && activePanelId !== id;
+  useLayoutEffect(() => {
+    let isFirstPanel = null == activePanelId && 0 === panels.current.size;
+    if (isFirstPanel) setActivePanelId(id);
+    let panelsCurrent = panels.current;
+    if (!panelsCurrent.has(id)) panelsCurrent.add(id);
+    return () => {
+      panelsCurrent.delete(id);
+    };
+  }, [activePanelId, id, panels, setActivePanelId]);
+  return React.createElement(
+    PanelContext.Provider,
+    {
+      value: React.useMemo(
+        () => ({
+          id,
+          associatedTrigger,
+        }),
+        [associatedTrigger, id],
+      ),
+    },
+    isMounted &&
+      React.createElement(
+        Box,
+        {
+          ref: forwardedRef,
+          id: id,
+          className: cx('iui-panel', className),
+          'aria-labelledby': `${id}-header-title`,
+          role: 'group',
+          inert: isInert ? '' : void 0,
+          'data-iui-transitioning': isTransitioning ? 'true' : void 0,
+          ...rest,
+        },
+        children,
+      ),
+  );
+});
+let PanelContext = React.createContext(void 0);
+let PanelTrigger = (props) => {
+  let { children, for: forProp } = props;
+  let {
+    changeActivePanel,
+    triggers,
+    setTriggers,
+    activePanelId: activePanel,
+    shouldFocus,
+    setShouldFocus,
+    panels,
+  } = useSafeContext(PanelsWrapperContext);
+  let { id: panelId } = useSafeContext(PanelContext);
+  let fallbackId = React.useId();
+  let triggerId = children.props.id || fallbackId;
+  let onClick = React.useCallback(() => {
+    if (null == activePanel) return;
+    setShouldFocus({
+      fromPanelId: activePanel,
+      toPanelId: forProp,
+      direction: 'forward',
+    });
+    changeActivePanel?.(forProp);
+  }, [activePanel, changeActivePanel, forProp, setShouldFocus]);
+  let focusRef = React.useCallback(
+    (el) => {
+      if (
+        shouldFocus?.direction === 'backward' &&
+        shouldFocus?.toPanelId === panelId &&
+        shouldFocus?.fromPanelId === forProp
+      ) {
+        el?.focus({
+          preventScroll: true,
+        });
+        setShouldFocus(void 0);
+      }
+    },
+    [forProp, panelId, setShouldFocus, shouldFocus],
+  );
+  let logWarning = useWarningLogger();
+  React.useEffect(() => {
+    if (!panels.current.has(forProp))
+      logWarning(
+        `Panels.Trigger's \`for\` prop ("${forProp}") corresponds to no Panel.`,
+      );
+  }, [forProp, logWarning, panels, triggers]);
+  React.useEffect(() => {
+    setTriggers((oldTriggers) => {
+      let triggersMatch = oldTriggers[forProp];
+      if (
+        null == triggersMatch ||
+        panelId !== triggersMatch.panelId ||
+        triggerId !== triggersMatch.triggerId
+      )
+        return {
+          ...oldTriggers,
+          [forProp]: {
+            panelId,
+            triggerId,
+          },
+        };
+      return oldTriggers;
+    });
+  }, [forProp, panelId, setTriggers, triggerId]);
+  return cloneElementWithRef(children, (children) => ({
+    ...children.props,
+    id: triggerId,
+    ref: focusRef,
+    onClick: mergeEventHandlers(children.props.onClick, onClick),
+    'aria-expanded': activePanel === forProp,
+    'aria-controls': forProp,
+  }));
+};
+let PanelHeader = React.forwardRef((props, forwardedRef) => {
+  let { titleProps, children, ...rest } = props;
+  let { shouldFocus, setShouldFocus } = useSafeContext(PanelsWrapperContext);
+  let { id: panelId, associatedTrigger: panelAssociatedTrigger } =
+    useSafeContext(PanelContext);
+  let focusRef = React.useCallback(
+    (el) => {
+      if (
+        shouldFocus?.direction === 'forward' &&
+        shouldFocus.toPanelId === panelId
+      ) {
+        el?.focus({
+          preventScroll: true,
+        });
+        setShouldFocus(void 0);
+      }
+    },
+    [panelId, setShouldFocus, shouldFocus?.direction, shouldFocus?.toPanelId],
+  );
+  return React.createElement(
+    Flex,
+    {
+      ref: forwardedRef,
+      ...rest,
+    },
+    panelAssociatedTrigger && React.createElement(PanelBackButton, null),
+    React.createElement(
+      Text,
+      {
+        id: `${panelId}-header-title`,
+        as: 'h2',
+        tabIndex: -1,
+        ref: focusRef,
+        ...titleProps,
+      },
+      children,
+    ),
+  );
+});
+let PanelBackButton = React.forwardRef((props, forwardedRef) => {
+  let { children, onClick, ...rest } = props;
+  let { instance: panelInstance } = useSafeContext(PanelsInstanceContext);
+  return React.createElement(
+    IconButton,
+    {
+      ref: forwardedRef,
+      'aria-label': 'Previous panel',
+      styleType: 'borderless',
+      size: 'small',
+      'data-iui-shift': 'left',
+      ...rest,
+      onClick: mergeEventHandlers(
+        React.useCallback(() => panelInstance?.goBack(), [panelInstance]),
+        onClick,
+      ),
+    },
+    children || React.createElement(SvgChevronLeft, null),
+  );
+});
+export const Panels = {
+  Wrapper: PanelsWrapper,
+  Panel,
+  Trigger: PanelTrigger,
+  Header: PanelHeader,
+  useInstance: useInstance,
+};
+function useDelayed(
+  value,
+  { delay } = {
+    delay: 500,
+  },
+) {
+  let [delayed, setDelayed] = React.useState(void 0);
+  let timeout = React.useRef(void 0);
+  React.useEffect(() => {
+    if (0 === delay) setDelayed(value);
+    else timeout.current = setTimeout(() => setDelayed(value), delay);
+    return () => {
+      clearTimeout(timeout.current);
+    };
+  }, [value, delay]);
+  return delayed;
+}

package/esm/core/Panels/helpers.d.ts

@@ -0,0 +1,23 @@
+import * as React from 'react';
+export type PanelsInstance = {
+    /** Go back to the panel that has a trigger that points to the current panel. */
+    goBack: () => void;
+};
+export type TriggerMapEntry = {
+    triggerId: string;
+    panelId: string;
+};
+export type FocusEntry = {
+    fromPanelId: string;
+    toPanelId: string;
+    direction: 'forward' | 'backward';
+} | undefined;
+export declare const PanelsInstanceContext: React.Context<{
+    instance: PanelsInstance;
+} | undefined>;
+type PanelInstanceProviderProps = {
+    children: React.ReactNode;
+    instance: PanelsInstance | undefined;
+};
+export declare const PanelsInstanceProvider: (props: PanelInstanceProviderProps) => React.JSX.Element;
+export {};

package/esm/core/Panels/helpers.js

@@ -0,0 +1,41 @@
+import * as React from 'react';
+import { useSafeContext, useSynchronizeInstance } from '../../utils/index.js';
+import { Panels, PanelsWrapperContext } from './Panels.js';
+export const PanelsInstanceContext = React.createContext(void 0);
+export const PanelsInstanceProvider = (props) => {
+  let { children, instance: instanceProp } = props;
+  let instanceBackup = Panels.useInstance();
+  let instance = instanceProp || instanceBackup;
+  let { activePanelId, changeActivePanel, triggers, setShouldFocus } =
+    useSafeContext(PanelsWrapperContext);
+  let goBack = React.useCallback(async () => {
+    if (null == activePanelId) return;
+    let trigger = triggers[activePanelId];
+    if (null != trigger.triggerId) {
+      setShouldFocus({
+        fromPanelId: activePanelId,
+        toPanelId: trigger.panelId,
+        direction: 'backward',
+      });
+      changeActivePanel(trigger.panelId);
+    }
+  }, [activePanelId, changeActivePanel, setShouldFocus, triggers]);
+  useSynchronizeInstance(
+    instance,
+    React.useMemo(
+      () => ({
+        goBack,
+      }),
+      [goBack],
+    ),
+  );
+  return React.createElement(
+    PanelsInstanceContext.Provider,
+    {
+      value: {
+        instance,
+      },
+    },
+    children,
+  );
+};

package/esm/core/Radio/Radio.js

@@ -16,7 +16,7 @@ export const Radio = React.forwardRef((props, ref) => {
   let refs = useMergedRefs(inputElementRef, ref);
   let radio = React.createElement(Box, {
     as: 'input',
-    className: cx('iui-radio', className),
+    className: cx('iui-checkbox', 'iui-radio', className),
     style: style,
     disabled: disabled,
     type: 'radio',
@@ -29,14 +29,9 @@ export const Radio = React.forwardRef((props, ref) => {
         {
           as: 'label',
           ...wrapperProps,
-          className: cx(
-            'iui-radio-wrapper',
-            {
-              'iui-disabled': disabled,
-              [`iui-${status}`]: !!status,
-            },
-            wrapperProps?.className,
-          ),
+          className: cx('iui-checkbox-wrapper', wrapperProps?.className),
+          'data-iui-status': status,
+          'data-iui-disabled': disabled ? 'true' : void 0,
         },
         radio,
         label &&

package/esm/core/RadioTiles/RadioTileGroup.d.ts

@@ -1,7 +1,9 @@
 import * as React from 'react';
 import { InputGroup } from '../InputGroup/InputGroup.js';
 import type { PolymorphicForwardRefComponent } from '../../utils/index.js';
-type RadioTileGroupProps = Omit<React.ComponentProps<typeof InputGroup>, 'displayStyle' | 'disabled'>;
+type RadioTileGroupProps = {
+    tileContainerProps?: React.ComponentProps<'div'>;
+} & Omit<React.ComponentProps<typeof InputGroup>, 'displayStyle' | 'disabled'>;
 /**
  * RadioTileGroup component to group RadioTile components together
  * @example

package/esm/core/RadioTiles/RadioTileGroup.js

@@ -1,8 +1,9 @@
 import * as React from 'react';
 import { InputGroup } from '../InputGroup/InputGroup.js';
 import { Box } from '../../utils/index.js';
+import cx from 'classnames';
 export const RadioTileGroup = React.forwardRef((props, forwardedRef) => {
-  let { children, label, ...rest } = props;
+  let { children, label, tileContainerProps, ...rest } = props;
   return React.createElement(
     InputGroup,
     {
@@ -13,7 +14,12 @@ export const RadioTileGroup = React.forwardRef((props, forwardedRef) => {
     React.createElement(
       Box,
       {
-        className: 'iui-radio-tile-container',
+        as: 'div',
+        ...tileContainerProps,
+        className: cx(
+          'iui-radio-tile-container',
+          tileContainerProps?.className,
+        ),
       },
       children,
     ),

package/esm/core/Select/SelectTag.d.ts

@@ -1,10 +1,12 @@
+import * as React from 'react';
+import { Tag } from '../Tag/Tag.js';
 import type { PolymorphicForwardRefComponent } from '../../utils/index.js';
 type SelectTagProps = {
     /**
      * Text inside the tag.
      */
     label: string;
-};
+} & Pick<React.ComponentProps<typeof Tag>, 'onClick' | 'onRemove'>;
 /**
  * Tag for showing selected value in `Select`.
  * @private

package/esm/core/Select/SelectTag.js

@@ -1,23 +1,21 @@
 import cx from 'classnames';
 import * as React from 'react';
-import { Box } from '../../utils/index.js';
+import { Tag } from '../Tag/Tag.js';
 export const SelectTag = React.forwardRef((props, forwardedRef) => {
   let { className, label, ...rest } = props;
   return React.createElement(
-    Box,
+    Tag,
     {
-      as: 'span',
       className: cx('iui-select-tag', className),
+      labelProps: {
+        className: 'iui-select-tag-label',
+      },
+      removeButtonProps: {
+        className: 'iui-select-tag-button',
+      },
       ref: forwardedRef,
       ...rest,
     },
-    React.createElement(
-      Box,
-      {
-        as: 'span',
-        className: 'iui-select-tag-label',
-      },
-      label,
-    ),
+    label,
   );
 });

package/esm/core/Select/SelectTagContainer.js

@@ -2,7 +2,7 @@ import * as React from 'react';
 import cx from 'classnames';
 import { SelectTag } from './SelectTag.js';
 import { OverflowContainer } from '../../utils/index.js';
-export const SelectTagContainer = React.forwardRef((props, ref) => {
+export const SelectTagContainer = React.forwardRef((props, forwardedRef) => {
   let { tags: tagsProp, className, ...rest } = props;
   let tags = React.useMemo(() => React.Children.toArray(tagsProp), [tagsProp]);
   return React.createElement(
@@ -10,7 +10,7 @@ export const SelectTagContainer = React.forwardRef((props, ref) => {
     {
       itemsCount: tags.length,
       className: cx('iui-select-tag-container', className),
-      ref: ref,
+      ref: forwardedRef,
       ...rest,
     },
     React.createElement(SelectTagContainerContent, {

package/esm/core/Stepper/Stepper.d.ts

@@ -12,6 +12,10 @@ export type StepProperties = {
      * A tooltip giving detailed description to this step.
      */
     description?: string;
+    /**
+     * Custom content displayed in the step's circle.
+     */
+    stepContent?: () => React.ReactNode;
 } & React.ComponentProps<'li'>;
 export type StepperProps = {
     /**