@itwin/itwinui-react 3.11.3 → 3.12.1

package/esm/core/Menu/MenuItemSkeleton.js

@@ -1,25 +1,54 @@
-/*---------------------------------------------------------------------------------------------
- * 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 { Box } from '../../utils/index.js';
 import { VisuallyHidden } from '../VisuallyHidden/VisuallyHidden.js';
-/**
- * Menu item that uses skeletons to indicate loading state.
- */
 export const MenuItemSkeleton = React.forwardRef((props, forwardedRef) => {
-    const { hasSublabel, hasIcon, contentWidth, translatedStrings = { loading: 'Loading…' }, className, style, ...rest } = props;
-    return (React.createElement(Box, { className: cx('iui-menu-item-skeleton', className), "data-iui-size": hasSublabel && 'large', style: {
-            ...{
-                '--iui-menu-item-content-skeleton-max-width': contentWidth,
-            },
-            ...style,
-        }, ref: forwardedRef, ...rest },
-        hasIcon && React.createElement(Box, { className: 'iui-icon iui-skeleton', "aria-hidden": true }),
-        React.createElement(Box, { as: 'span', className: 'iui-content' },
-            React.createElement(Box, { className: 'iui-menu-label iui-skeleton', "aria-hidden": true }),
-            hasSublabel && (React.createElement(Box, { className: 'iui-menu-description iui-skeleton', "aria-hidden": true })),
-            React.createElement(VisuallyHidden, null, translatedStrings.loading))));
+  const {
+    hasSublabel,
+    hasIcon,
+    contentWidth,
+    translatedStrings = {
+      loading: 'Loading…',
+    },
+    className,
+    style,
+    ...rest
+  } = props;
+  return React.createElement(
+    Box,
+    {
+      className: cx('iui-menu-item-skeleton', className),
+      'data-iui-size': hasSublabel && 'large',
+      style: {
+        ...{
+          '--iui-menu-item-content-skeleton-max-width': contentWidth,
+        },
+        ...style,
+      },
+      ref: forwardedRef,
+      ...rest,
+    },
+    hasIcon &&
+      React.createElement(Box, {
+        className: 'iui-icon iui-skeleton',
+        'aria-hidden': true,
+      }),
+    React.createElement(
+      Box,
+      {
+        as: 'span',
+        className: 'iui-content',
+      },
+      React.createElement(Box, {
+        className: 'iui-menu-label iui-skeleton',
+        'aria-hidden': true,
+      }),
+      hasSublabel &&
+        React.createElement(Box, {
+          className: 'iui-menu-description iui-skeleton',
+          'aria-hidden': true,
+        }),
+      React.createElement(VisuallyHidden, null, translatedStrings.loading),
+    ),
+  );
 });

package/esm/core/Modal/Modal.js

@@ -1,35 +1,47 @@
-/*---------------------------------------------------------------------------------------------
- * 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 { Dialog } from '../Dialog/Dialog.js';
-/**
- * Modal component which can wrap any content.
- * @example
- * <Modal
- *   isOpen={true}
- *   title='My modal'
- *   onClose={onClose}
- * >
- *   <ModalContent>
- *     Here is my modal content
- *   </ModalContent>
- *   <ModalButtonBar>
- *     <Button styleType='high-visibility'>
- *       Primary button
- *     </Button>
- *     <Button>
- *       Secondary button
- *     </Button>
- *   </ModalButtonBar>
- * </Modal>
- */
 export const Modal = React.forwardRef((props, forwardedRef) => {
-    const { isOpen = false, isDismissible = true, closeOnEsc = true, closeOnExternalClick = true, onClose, title, children, portal = true, wrapperProps, backdropProps, titleBarProps, ...rest } = props;
-    return (React.createElement(Dialog, { isOpen: isOpen, closeOnEsc: closeOnEsc, closeOnExternalClick: closeOnExternalClick, isDismissible: isDismissible, onClose: onClose, preventDocumentScroll: true, trapFocus: true, setFocus: true, ref: forwardedRef, portal: portal, ...wrapperProps },
-        React.createElement(Dialog.Backdrop, { ...backdropProps }),
-        React.createElement(Dialog.Main, { "aria-modal": true, ...rest },
-            React.createElement(Dialog.TitleBar, { titleText: title, ...titleBarProps }),
-            children)));
+  const {
+    isOpen = false,
+    isDismissible = true,
+    closeOnEsc = true,
+    closeOnExternalClick = true,
+    onClose,
+    title,
+    children,
+    portal = true,
+    wrapperProps,
+    backdropProps,
+    titleBarProps,
+    ...rest
+  } = props;
+  return React.createElement(
+    Dialog,
+    {
+      isOpen: isOpen,
+      closeOnEsc: closeOnEsc,
+      closeOnExternalClick: closeOnExternalClick,
+      isDismissible: isDismissible,
+      onClose: onClose,
+      preventDocumentScroll: true,
+      trapFocus: true,
+      setFocus: true,
+      ref: forwardedRef,
+      portal: portal,
+      ...wrapperProps,
+    },
+    React.createElement(Dialog.Backdrop, backdropProps),
+    React.createElement(
+      Dialog.Main,
+      {
+        'aria-modal': true,
+        ...rest,
+      },
+      React.createElement(Dialog.TitleBar, {
+        titleText: title,
+        ...titleBarProps,
+      }),
+      children,
+    ),
+  );
 });

package/esm/core/Modal/ModalButtonBar.js

@@ -1,9 +1,2 @@
-/*---------------------------------------------------------------------------------------------
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
- * See LICENSE.md in the project root for license terms and full copyright notice.
- *--------------------------------------------------------------------------------------------*/
 import { DialogButtonBar } from '../Dialog/DialogButtonBar.js';
-/**
- * Container for Buttons in modal.
- */
 export const ModalButtonBar = Object.assign({}, DialogButtonBar);

package/esm/core/Modal/ModalContent.js

@@ -1,9 +1,2 @@
-/*---------------------------------------------------------------------------------------------
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
- * See LICENSE.md in the project root for license terms and full copyright notice.
- *--------------------------------------------------------------------------------------------*/
 import { DialogContent } from '../Dialog/DialogContent.js';
-/**
- * Container for content in `Modal`.
- */
 export const ModalContent = Object.assign({}, DialogContent);

package/esm/core/NonIdealState/ErrorPage.js

@@ -1,145 +1,192 @@
-/*---------------------------------------------------------------------------------------------
- * 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 { Button } from '../Buttons/Button.js';
 import { NonIdealState } from './NonIdealState.js';
 import { ProgressRadial } from '../ProgressIndicators/ProgressRadial.js';
-const Svg401 = React.lazy(() => import('@itwin/itwinui-illustrations-react/Svg401'));
-const Svg403 = React.lazy(() => import('@itwin/itwinui-illustrations-react/Svg403'));
-const Svg404 = React.lazy(() => import('@itwin/itwinui-illustrations-react/Svg404'));
-const Svg500 = React.lazy(() => import('@itwin/itwinui-illustrations-react/Svg500'));
-const Svg502 = React.lazy(() => import('@itwin/itwinui-illustrations-react/Svg502'));
-const Svg503 = React.lazy(() => import('@itwin/itwinui-illustrations-react/Svg503'));
-const SvgError = React.lazy(() => import('@itwin/itwinui-illustrations-react/SvgError'));
-const SvgRedirect = React.lazy(() => import('@itwin/itwinui-illustrations-react/SvgRedirect'));
-const SvgTimedOut = React.lazy(() => import('@itwin/itwinui-illustrations-react/SvgTimedOut'));
-/**
- * @deprecated Use `NonIdealState` instead for a smaller client bundle.
- *
- * A stylized display to communicate common http errors.
- * @example
- * <ErrorPage errorType='401' />
- */
+const Svg401 = React.lazy(
+  () => import('@itwin/itwinui-illustrations-react/Svg401'),
+);
+const Svg403 = React.lazy(
+  () => import('@itwin/itwinui-illustrations-react/Svg403'),
+);
+const Svg404 = React.lazy(
+  () => import('@itwin/itwinui-illustrations-react/Svg404'),
+);
+const Svg500 = React.lazy(
+  () => import('@itwin/itwinui-illustrations-react/Svg500'),
+);
+const Svg502 = React.lazy(
+  () => import('@itwin/itwinui-illustrations-react/Svg502'),
+);
+const Svg503 = React.lazy(
+  () => import('@itwin/itwinui-illustrations-react/Svg503'),
+);
+const SvgError = React.lazy(
+  () => import('@itwin/itwinui-illustrations-react/SvgError'),
+);
+const SvgRedirect = React.lazy(
+  () => import('@itwin/itwinui-illustrations-react/SvgRedirect'),
+);
+const SvgTimedOut = React.lazy(
+  () => import('@itwin/itwinui-illustrations-react/SvgTimedOut'),
+);
 export const ErrorPage = React.forwardRef((props, forwardedRef) => {
-    const { errorType, errorName, errorMessage, primaryButtonHandle, primaryButtonLabel, secondaryButtonHandle, secondaryButtonLabel, translatedErrorMessages, ...rest } = props;
-    const defaultErrorMessages = {
-        badGateway: 'Bad gateway',
-        error: 'Error',
-        forbidden: 'Forbidden',
-        internalServerError: 'Internal server error',
-        redirect: 'Redirect',
-        pageNotFound: 'Page not found',
-        serviceUnavailable: 'Service unavailable',
-        timedOut: 'Timed out',
-        unauthorized: 'Unauthorized',
-        ...translatedErrorMessages,
-    };
-    function getErrorIcon() {
-        switch (errorType) {
-            case '300':
-            case '301':
-            case '302':
-            case '303':
-            case '304':
-            case '305':
-            case '307':
-            case '308': {
-                return React.createElement(SvgRedirect, null);
-            }
-            case '401': {
-                return React.createElement(Svg401, null);
-            }
-            case '403': {
-                return React.createElement(Svg403, null);
-            }
-            case '404': {
-                return React.createElement(Svg404, null);
-            }
-            case '408':
-            case '504': {
-                return React.createElement(SvgTimedOut, null);
-            }
-            case '500': {
-                return React.createElement(Svg500, null);
-            }
-            case '502': {
-                return React.createElement(Svg502, null);
-            }
-            case '503': {
-                return React.createElement(Svg503, null);
-            }
-            case 'generic':
-            default: {
-                return React.createElement(SvgError, null);
-            }
-        }
+  const {
+    errorType,
+    errorName,
+    errorMessage,
+    primaryButtonHandle,
+    primaryButtonLabel,
+    secondaryButtonHandle,
+    secondaryButtonLabel,
+    translatedErrorMessages,
+    ...rest
+  } = props;
+  const defaultErrorMessages = {
+    badGateway: 'Bad gateway',
+    error: 'Error',
+    forbidden: 'Forbidden',
+    internalServerError: 'Internal server error',
+    redirect: 'Redirect',
+    pageNotFound: 'Page not found',
+    serviceUnavailable: 'Service unavailable',
+    timedOut: 'Timed out',
+    unauthorized: 'Unauthorized',
+    ...translatedErrorMessages,
+  };
+  function getErrorIcon() {
+    switch (errorType) {
+      case '300':
+      case '301':
+      case '302':
+      case '303':
+      case '304':
+      case '305':
+      case '307':
+      case '308': {
+        return React.createElement(SvgRedirect, null);
+      }
+      case '401': {
+        return React.createElement(Svg401, null);
+      }
+      case '403': {
+        return React.createElement(Svg403, null);
+      }
+      case '404': {
+        return React.createElement(Svg404, null);
+      }
+      case '408':
+      case '504': {
+        return React.createElement(SvgTimedOut, null);
+      }
+      case '500': {
+        return React.createElement(Svg500, null);
+      }
+      case '502': {
+        return React.createElement(Svg502, null);
+      }
+      case '503': {
+        return React.createElement(Svg503, null);
+      }
+      case 'generic':
+      default: {
+        return React.createElement(SvgError, null);
+      }
     }
-    function getHeadingMessage() {
-        if (errorName) {
-            return errorName;
-        }
-        switch (errorType) {
-            case '300':
-            case '301':
-            case '302':
-            case '303':
-            case '304':
-            case '305':
-            case '307':
-            case '308': {
-                return defaultErrorMessages.redirect || '';
-            }
-            case '401': {
-                return defaultErrorMessages.unauthorized;
-            }
-            case '403': {
-                return defaultErrorMessages.forbidden;
-            }
-            case '404': {
-                return defaultErrorMessages.pageNotFound;
-            }
-            case '408':
-            case '504': {
-                return defaultErrorMessages.timedOut || '';
-            }
-            case '500': {
-                return defaultErrorMessages.internalServerError;
-            }
-            case '502': {
-                return defaultErrorMessages.badGateway;
-            }
-            case '503': {
-                return defaultErrorMessages.serviceUnavailable;
-            }
-            case 'generic':
-            default: {
-                return defaultErrorMessages.error;
-            }
-        }
+  }
+  function getHeadingMessage() {
+    if (errorName) {
+      return errorName;
     }
-    function getPrimaryButton() {
-        if (!primaryButtonHandle || !primaryButtonLabel) {
-            return null;
-        }
-        return (React.createElement(Button, { styleType: 'high-visibility', onClick: primaryButtonHandle }, primaryButtonLabel));
+    switch (errorType) {
+      case '300':
+      case '301':
+      case '302':
+      case '303':
+      case '304':
+      case '305':
+      case '307':
+      case '308': {
+        return defaultErrorMessages.redirect || '';
+      }
+      case '401': {
+        return defaultErrorMessages.unauthorized;
+      }
+      case '403': {
+        return defaultErrorMessages.forbidden;
+      }
+      case '404': {
+        return defaultErrorMessages.pageNotFound;
+      }
+      case '408':
+      case '504': {
+        return defaultErrorMessages.timedOut || '';
+      }
+      case '500': {
+        return defaultErrorMessages.internalServerError;
+      }
+      case '502': {
+        return defaultErrorMessages.badGateway;
+      }
+      case '503': {
+        return defaultErrorMessages.serviceUnavailable;
+      }
+      case 'generic':
+      default: {
+        return defaultErrorMessages.error;
+      }
     }
-    function getSecondaryButton() {
-        if (!secondaryButtonHandle || !secondaryButtonLabel) {
-            return null;
-        }
-        return (React.createElement(Button, { styleType: 'default', onClick: secondaryButtonHandle }, secondaryButtonLabel));
+  }
+  function getPrimaryButton() {
+    if (!primaryButtonHandle || !primaryButtonLabel) {
+      return null;
     }
-    function getActions() {
-        const primaryButton = getPrimaryButton();
-        const secondaryButton = getSecondaryButton();
-        if (!primaryButton && !secondaryButton) {
-            return null;
-        }
-        return (React.createElement(React.Fragment, null,
-            primaryButton,
-            secondaryButton));
+    return React.createElement(
+      Button,
+      {
+        styleType: 'high-visibility',
+        onClick: primaryButtonHandle,
+      },
+      primaryButtonLabel,
+    );
+  }
+  function getSecondaryButton() {
+    if (!secondaryButtonHandle || !secondaryButtonLabel) {
+      return null;
     }
-    return (React.createElement(NonIdealState, { svg: React.createElement(React.Suspense, { fallback: React.createElement(ProgressRadial, null) }, getErrorIcon()), heading: getHeadingMessage(), description: errorMessage, actions: getActions(), ref: forwardedRef, ...rest }));
+    return React.createElement(
+      Button,
+      {
+        styleType: 'default',
+        onClick: secondaryButtonHandle,
+      },
+      secondaryButtonLabel,
+    );
+  }
+  function getActions() {
+    const primaryButton = getPrimaryButton();
+    const secondaryButton = getSecondaryButton();
+    if (!primaryButton && !secondaryButton) {
+      return null;
+    }
+    return React.createElement(
+      React.Fragment,
+      null,
+      primaryButton,
+      secondaryButton,
+    );
+  }
+  return React.createElement(NonIdealState, {
+    svg: React.createElement(
+      React.Suspense,
+      {
+        fallback: React.createElement(ProgressRadial, null),
+      },
+      getErrorIcon(),
+    ),
+    heading: getHeadingMessage(),
+    description: errorMessage,
+    actions: getActions(),
+    ref: forwardedRef,
+    ...rest,
+  });
 });

package/esm/core/NonIdealState/NonIdealState.js

@@ -1,22 +1,70 @@
-/*---------------------------------------------------------------------------------------------
- * 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 { Box } from '../../utils/index.js';
 import cx from 'classnames';
-/**
- * A stylized display to communicate common http errors and other non-ideal states.
- * Works well with svgs from @itwin/itwinui-illustrations-react.
- *
- * @example
- * <NonIdealState svg={<Svg404 />} heading='Not found' />
- */
 export const NonIdealState = React.forwardRef((props, forwardedRef) => {
-    const { className, svg, heading, description, actions, illustrationProps, titleProps, descriptionProps, actionsProps, ...rest } = props;
-    return (React.createElement(Box, { className: cx('iui-non-ideal-state', className), ref: forwardedRef, ...rest },
-        React.createElement(Box, { as: 'div', ...illustrationProps, className: cx('iui-non-ideal-state-illustration', illustrationProps?.className) }, svg),
-        heading && (React.createElement(Box, { as: 'div', ...titleProps, className: cx('iui-non-ideal-state-title', titleProps?.className) }, heading)),
-        description && (React.createElement(Box, { as: 'div', ...descriptionProps, className: cx('iui-non-ideal-state-description', descriptionProps?.className) }, description)),
-        actions && (React.createElement(Box, { as: 'div', ...actionsProps, className: cx('iui-non-ideal-state-actions', actionsProps?.className) }, actions))));
+  const {
+    className,
+    svg,
+    heading,
+    description,
+    actions,
+    illustrationProps,
+    titleProps,
+    descriptionProps,
+    actionsProps,
+    ...rest
+  } = props;
+  return React.createElement(
+    Box,
+    {
+      className: cx('iui-non-ideal-state', className),
+      ref: forwardedRef,
+      ...rest,
+    },
+    React.createElement(
+      Box,
+      {
+        as: 'div',
+        ...illustrationProps,
+        className: cx(
+          'iui-non-ideal-state-illustration',
+          illustrationProps?.className,
+        ),
+      },
+      svg,
+    ),
+    heading &&
+      React.createElement(
+        Box,
+        {
+          as: 'div',
+          ...titleProps,
+          className: cx('iui-non-ideal-state-title', titleProps?.className),
+        },
+        heading,
+      ),
+    description &&
+      React.createElement(
+        Box,
+        {
+          as: 'div',
+          ...descriptionProps,
+          className: cx(
+            'iui-non-ideal-state-description',
+            descriptionProps?.className,
+          ),
+        },
+        description,
+      ),
+    actions &&
+      React.createElement(
+        Box,
+        {
+          as: 'div',
+          ...actionsProps,
+          className: cx('iui-non-ideal-state-actions', actionsProps?.className),
+        },
+        actions,
+      ),
+  );
 });

package/esm/core/NotificationMarker/NotificationMarker.js

@@ -1,23 +1,30 @@
-/*---------------------------------------------------------------------------------------------
- * 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 { Box } from '../../utils/index.js';
 import cx from 'classnames';
-/**
- * A small notification circle to the top-right of the passed children prop.
- * This can be applied to almost anything but mostly intended for icons within buttons with `styleType = default / borderless`.
- * @example
- * <IconButton styleType='borderless'>
- *   <NotificationMarker>
- *     <SvgNotification />
- *   </NotificationMarker>
- * </IconButton>
- * @example
- * <NotificationMarker status='positive' pulsing={true}>Live</NotificationMarker>
- */
 export const NotificationMarker = React.forwardRef((props, ref) => {
-    const { className, children, status = 'primary', pulsing = false, enabled = true, ...rest } = props;
-    return (React.createElement(Box, { as: 'span', ref: ref, className: cx({ 'iui-notification-marker': enabled }, className), "data-iui-variant": enabled ? status : null, "data-iui-urgent": enabled ? pulsing : null, ...rest }, children));
+  const {
+    className,
+    children,
+    status = 'primary',
+    pulsing = false,
+    enabled = true,
+    ...rest
+  } = props;
+  return React.createElement(
+    Box,
+    {
+      as: 'span',
+      ref: ref,
+      className: cx(
+        {
+          'iui-notification-marker': enabled,
+        },
+        className,
+      ),
+      'data-iui-variant': enabled ? status : null,
+      'data-iui-urgent': enabled ? pulsing : null,
+      ...rest,
+    },
+    children,
+  );
 });

package/esm/core/Overlay/Overlay.d.ts

@@ -1,4 +1,4 @@
-import React from 'react';
+import * as React from 'react';
 import type { PolymorphicForwardRefComponent } from '../../utils/index.js';
 type OverlayComponentProps = {
     /**
@@ -38,7 +38,7 @@ export declare const Overlay: PolymorphicForwardRefComponent<"div", OverlayCompo
      * The main component is a wrapper to hold the
      * `Overlay.HiddenContent` and `Overlay.Overlay`.
      */
-    Wrapper: PolymorphicForwardRefComponent<NonNullable<keyof JSX.IntrinsicElements>, {}>;
+    Wrapper: PolymorphicForwardRefComponent<keyof JSX.IntrinsicElements, {}>;
     /**
      * `Overlay.HiddenContent` houses page elements that are blurred by the
      * Overlay. These elements will become inert when the overlay is active.
@@ -48,6 +48,6 @@ export declare const Overlay: PolymorphicForwardRefComponent<"div", OverlayCompo
      * `Overlay.Overlay` sits on top of the HiddenContent, and can show
      * any arbitrary content like a progress indicator and loading message.
      */
-    Overlay: PolymorphicForwardRefComponent<NonNullable<keyof JSX.IntrinsicElements>, {}>;
+    Overlay: PolymorphicForwardRefComponent<keyof JSX.IntrinsicElements, {}>;
 };
 export {};