@linzjs/lui 21.36.0 → 21.37.0

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+# [21.37.0](https://github.com/linz/lui/compare/v21.36.0...v21.37.0) (2024-07-01)
+
+
+### Features
+
+* **LuiModalV2:** trigger release ([#1129](https://github.com/linz/lui/issues/1129)) ([a914f10](https://github.com/linz/lui/commit/a914f10d05d070d40cda00b30aecab808c27ffe2))
+* **LuiModalV2:** Update modals UI ([#1127](https://github.com/linz/lui/issues/1127)) ([05d3ae5](https://github.com/linz/lui/commit/05d3ae571ff52dedabfc93ec4a056a0d0b3fe508))
+
 # [21.36.0](https://github.com/linz/lui/compare/v21.35.0...v21.36.0) (2024-07-01)
 
 

package/dist/components/LuiModal/LuiAlertModalV2.d.ts

@@ -0,0 +1,7 @@
+import { FC, PropsWithChildren } from 'react';
+import { LuiModalV2Props } from './LuiModalV2';
+export declare type LuiAlertModalLevel = 'success' | 'info' | 'warning' | 'error';
+export declare type LuiAlertModalV2Props = Omit<LuiModalV2Props, 'headingIcon'> & {
+    level: LuiAlertModalLevel;
+};
+export declare const LuiAlertModalV2: FC<PropsWithChildren<LuiAlertModalV2Props>>;

package/dist/components/LuiModal/LuiModal.d.ts

@@ -13,10 +13,19 @@ interface ILuiModal {
     appendToElement?: () => HTMLElement;
     headerStyle?: 'light' | 'default';
 }
+/**
+ * @deprecated this is replaced by `LuiModalV2`. [Migration notes](https://github.com/linz/Lui/pull/1127).
+ */
 export declare const LuiModal: React.FC<React.PropsWithChildren<ILuiModal>>;
+/**
+ * @deprecated this is replaced by `LuiAlertModalV2`. [Migration notes](https://github.com/linz/Lui/pull/1127).
+ */
 export declare const LuiAlertModal: React.FC<React.PropsWithChildren<{
     level: 'success' | 'info' | 'warning' | 'error';
 } & ILuiModal>>;
+/**
+ * @deprecated this is replaced by `LuiModalV2.Buttons`. [Migration notes](https://github.com/linz/Lui/pull/1127).
+ */
 export declare const LuiAlertModalButtons: React.FC<React.PropsWithChildren<unknown>>;
 interface IModalHeader {
     headingText?: string;
@@ -24,5 +33,8 @@ interface IModalHeader {
     onClose?: () => void;
     style?: 'light' | 'default';
 }
+/**
+ * @deprecated this is deprecated alongside `LuiModal`. [Migration notes](https://github.com/linz/Lui/pull/1127).
+ */
 export declare const LuiModalHeader: React.FC<React.PropsWithChildren<IModalHeader>>;
 export {};

package/dist/components/LuiModal/LuiModalV2.d.ts

@@ -0,0 +1,34 @@
+import React, { PropsWithChildren } from 'react';
+import { LuiIconProps } from '../LuiIcon/LuiIcon';
+export declare type LuiModalV2Props = {
+    key?: string;
+    /** Default `true` */
+    shouldCloseOnOverlayClick?: boolean;
+    /** Default `true` */
+    shouldCloseOnEsc?: boolean | 'use-keyup';
+    onClose?: () => void | Promise<void>;
+    showCloseButton?: boolean;
+    className?: string;
+    /** If set to true, the modal will take the full screen width. Default `false` */
+    maxWidth?: boolean;
+    headingText?: string;
+    headingIcon?: LuiIconProps;
+    helpLink?: string | (() => void | Promise<void>);
+    isLoading?: boolean;
+    /** Sets the overlay to white. This is only to be used for situations when the user is working in a component and there is benefit to hiding the surrounding page. An example is editing types of instruments in the Dealings flow in LOL. */
+    lowContrast?: boolean;
+    /** By default, the modal autofocuses the first `input` or `button` inside it. Set this prop to `true` to disable that behaviour. Default `false`. This is kept from LuiModal "V1" for backwards compatibility. */
+    preventAutoFocus?: boolean;
+    /** By default, the modal portal will be appended to the document's body, but we might need to append it to another element. This is passed the React Modal `parentSelector` prop. */
+    appendToElement?: () => HTMLElement;
+};
+/** Implements the [updated modal design system](https://www.figma.com/design/E7g3n5ziI7bR8MisISayia/FigLUI?node-id=9924-54717&t=q2r6Gct1cKGP9Q5B-0), keeping the same api as `LuiModal` as much as possible. */
+export declare const LuiModalV2: {
+    (props: PropsWithChildren<LuiModalV2Props>): JSX.Element;
+    Buttons: React.FC<React.PropsWithChildren<{
+        className?: string | undefined;
+    }>>;
+    HeaderTitle: React.FC<React.PropsWithChildren<{
+        className?: string | undefined;
+    }>>;
+};

package/dist/components/common/Hooks.d.ts

@@ -4,7 +4,7 @@
  *
  * @param onEscape the handler function
  */
-export declare const useEscapeFunction: (onEscape: () => void) => void;
+export declare const useEscapeFunction: (onEscape: (e: KeyboardEvent) => void | Promise<void>, trigger?: 'keyup' | 'keydown') => void;
 /**
  * A hook which allows handling of click event anywhere on the page.
  * Provides a way of handling clicks done inside or outside the element bound to the returned react ref.

package/dist/hooks/useClickedOutsideElement.d.ts

@@ -1,4 +1,4 @@
-import React from 'react';
+import { MutableRefObject, RefObject } from 'react';
 /**
  * This hook will callback with handleClickOutside() when "mousedown" dom event occurs off the refElement
  * usage:
@@ -11,4 +11,4 @@ import React from 'react';
   return <button ref={refElement}>Click Me!</button>;
  ```
  */
-export declare function useClickedOutsideElement(refElement: React.RefObject<HTMLElement>, handleClickOutside: CallableFunction): void;
+export declare function useClickedOutsideElement(refElement: RefObject<HTMLElement> | MutableRefObject<HTMLElement>, handleClickOutside: CallableFunction): void;

package/dist/index.d.ts

@@ -37,6 +37,8 @@ export * from './components/LuiHeaderMenu/LuiHeaderMenus';
 export * from './components/LuiHeaderMenuV2/LuiHeaderMenusV2';
 export { LuiUpdatesSplashModal } from './components/LuiUpdateSplashModal/LuiUpdatesSplashModal';
 export { LuiModal, LuiAlertModal, LuiAlertModalButtons, } from './components/LuiModal/LuiModal';
+export { LuiModalV2, type LuiModalV2Props, } from './components/LuiModal/LuiModalV2';
+export { LuiAlertModalV2, type LuiAlertModalLevel, type LuiAlertModalV2Props, } from './components/LuiModal/LuiAlertModalV2';
 export { type ISearchInputProps, LuiSearchInput, } from './components/LuiSearchInput/LuiSearchInput';
 export { type ISearchGroupedResult, type ISearchResult, } from './components/LuiSearchInput/ResultsDisplay';
 export { type ISearchMenuOption, type ILuiSearchBoxProps, LuiSearchBox, } from './components/LuiSearchBox/LuiSearchBox';

package/dist/index.js

@@ -39830,17 +39830,12 @@ var motif = 'data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0id
  *
  * @param onEscape the handler function
  */
-var useEscapeFunction = function (onEscape) {
-    var escFunction = React.useCallback(function (event) {
-        if (event.keyCode === 27) {
-            onEscape();
-        }
-    }, [onEscape]);
+var useEscapeFunction = function (onEscape, trigger) {
+    if (trigger === void 0) { trigger = 'keydown'; }
+    var escFunction = React.useCallback(function (event) { return event.key === 'Escape' && onEscape(event); }, [onEscape]);
     React.useEffect(function () {
-        document.addEventListener('keydown', escFunction, false);
-        return function () {
-            document.removeEventListener('keydown', escFunction, false);
-        };
+        document.addEventListener(trigger, escFunction);
+        return function () { return document.removeEventListener(trigger, escFunction); };
     }, [escFunction]);
 };
 /**
@@ -42123,6 +42118,9 @@ var FeatureIFrame = function (_a) {
         React__default["default"].createElement("iframe", __assign({ width: iframeConfig.width, height: iframeConfig.height, src: iframeConfig.url, title: iframeConfig.title }, iFrameProps))));
 };
 
+/**
+ * @deprecated this is replaced by `LuiModalV2`. [Migration notes](https://github.com/linz/Lui/pull/1127).
+ */
 var LuiModal = function (props) {
     var _a;
     var node = React.useRef(null);
@@ -42178,6 +42176,9 @@ var LuiModal = function (props) {
                     }
                 } }, props.children))));
 };
+/**
+ * @deprecated this is replaced by `LuiAlertModalV2`. [Migration notes](https://github.com/linz/Lui/pull/1127).
+ */
 var LuiAlertModal = function (props) {
     var materialIcon = getMaterialIconForLevel(props.level);
     var level = props.level, className = props.className, children = props.children, rest = __rest(props, ["level", "className", "children"]);
@@ -42185,9 +42186,15 @@ var LuiAlertModal = function (props) {
         React__default["default"].createElement(LuiIcon, { name: "ic_".concat(materialIcon), alt: "".concat(level, " status icon"), size: "lg", className: "lui-msg-status-icon" }),
         children));
 };
+/**
+ * @deprecated this is replaced by `LuiModalV2.Buttons`. [Migration notes](https://github.com/linz/Lui/pull/1127).
+ */
 var LuiAlertModalButtons = function (props) {
     return React__default["default"].createElement("div", { className: "modal-btn-row" }, props.children);
 };
+/**
+ * @deprecated this is deprecated alongside `LuiModal`. [Migration notes](https://github.com/linz/Lui/pull/1127).
+ */
 var LuiModalHeader = function (props) {
     var _a;
     var headerStyle = (_a = props.style) !== null && _a !== void 0 ? _a : 'default';
@@ -42202,6 +42209,120 @@ var LuiModalHeader = function (props) {
                 React__default["default"].createElement(LuiIcon, { name: "ic_clear", alt: "Help", size: "lg" }))))))));
 };
 
+/**
+ * This hook will callback with handleClickOutside() when "mousedown" dom event occurs off the refElement
+ * usage:
+ ```typescript
+  const refElement = React.useRef<HTMLButtonElement>(null);
+  const handleClickOutside = () => {
+      console.log("hello world");
+  };
+  useClickedOutsideElement(refElement, handleClickOutside);
+  return <button ref={refElement}>Click Me!</button>;
+ ```
+ */
+function useClickedOutsideElement(refElement, handleClickOutside) {
+    React__default["default"].useEffect(function () {
+        function onOutsideClicked(event) {
+            var element = refElement.current;
+            if (!(element === null || element === void 0 ? void 0 : element.contains(event.target))) {
+                handleClickOutside();
+            }
+        }
+        document.addEventListener('mousedown', onOutsideClicked);
+        return function () {
+            document.removeEventListener('mousedown', onOutsideClicked);
+        };
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, []);
+}
+
+var _a;
+/** Implements the [updated modal design system](https://www.figma.com/design/E7g3n5ziI7bR8MisISayia/FigLUI?node-id=9924-54717&t=q2r6Gct1cKGP9Q5B-0), keeping the same api as `LuiModal` as much as possible. */
+var LuiModalV2 = function (props) {
+    var _a;
+    var modalRef = React.useRef(null);
+    var handleClickOutside = React.useCallback(function () { var _a; return props.shouldCloseOnOverlayClick && ((_a = props.onClose) === null || _a === void 0 ? void 0 : _a.call(props)); }, [props.shouldCloseOnEsc, props.onClose]);
+    useClickedOutsideElement(modalRef, handleClickOutside);
+    var handleEsc = React.useCallback(function (e) {
+        var _a;
+        if (props.shouldCloseOnEsc !== false) {
+            e.stopPropagation();
+            (_a = props.onClose) === null || _a === void 0 ? void 0 : _a.call(props);
+        }
+    }, [props.shouldCloseOnEsc, props.onClose]);
+    useEscapeFunction(handleEsc, props.shouldCloseOnEsc === 'use-keyup' ? 'keyup' : 'keydown');
+    var handleAutoFocus = function (el) {
+        if (props.preventAutoFocus)
+            return;
+        if (el && !el.contains(el.ownerDocument.activeElement)) {
+            var firstFocusableElement = el.querySelector('input,button');
+            firstFocusableElement === null || firstFocusableElement === void 0 ? void 0 : firstFocusableElement.focus();
+        }
+    };
+    var showCloseButton = Boolean(props.showCloseButton && props.onClose);
+    var showHelpButton = Boolean(props.helpLink);
+    var showButtons = showCloseButton || showHelpButton;
+    var showHeadingIcon = props.headingIcon && !props.isLoading;
+    return (React__default["default"].createElement(Modal, { key: props.key, isOpen: true, 
+        // disble the `shouldClose` props as we handle them ourselves
+        shouldCloseOnOverlayClick: false, shouldCloseOnEsc: false, overlayClassName: "modal", className: props.lowContrast ? 'lui-scrim-low-contrast' : 'lui-scrim', 
+        // required to prevent warnings that are not applicable in real usage
+        ariaHideApp: !isTest, parentSelector: props.appendToElement },
+        React__default["default"].createElement("div", { ref: function (el) {
+                modalRef.current = el;
+                handleAutoFocus(el);
+            }, className: clsx('lui-modal-v2 lui-box-shadow', props.maxWidth && 'lui-max-width', props.className) },
+            React__default["default"].createElement("div", { className: "lui-modal-v2-header" },
+                props.isLoading && (React__default["default"].createElement(LuiMiniSpinner, { size: 20, divProps: { className: 'lui-modal-v2-header-spinner' } })),
+                showHeadingIcon && (React__default["default"].createElement("div", { className: "lui-modal-v2-header-icon" },
+                    React__default["default"].createElement(LuiIcon, __assign({ size: "md", name: "", alt: "Help" }, props.headingIcon, { className: clsx('', (_a = props.headingIcon) === null || _a === void 0 ? void 0 : _a.className) })))),
+                props.headingText && (React__default["default"].createElement("h2", { className: "lui-modal-v2-header-title" }, props.headingText)),
+                showButtons && (React__default["default"].createElement("div", { className: "lui-modal-v2-header-buttons" },
+                    showHelpButton && React__default["default"].createElement(HelpButton, { helpLink: props.helpLink }),
+                    showCloseButton && React__default["default"].createElement(CloseButton, { onClose: props.onClose })))),
+            React__default["default"].createElement("div", { className: "lui-modal-v2-contents" }, props.children))));
+};
+var ButtonRow = function (props) { return (React__default["default"].createElement("div", { className: clsx('lui-modal-v2-btn-row', props.className) }, props.children)); };
+LuiModalV2.Buttons = ButtonRow;
+var HelpButton = function (props) { return (React__default["default"].createElement("button", { "aria-label": "Modal Help", title: "Help", className: "lui-modal-v2-header-help-btn", onClick: typeof props.helpLink === 'string'
+        ? function () { return window.open(props.helpLink, '_blank'); }
+        : props.helpLink },
+    React__default["default"].createElement(LuiIcon, { name: "ic_help_outline", alt: "Help", size: "md" }))); };
+var CloseButton = function (props) { return (React__default["default"].createElement("button", { "aria-label": "Modal Close", title: "Close", className: "lui-modal-v2-header-close-btn", onClick: props.onClose },
+    React__default["default"].createElement(LuiIcon, { name: "ic_clear", alt: "Help", size: "md" }))); };
+/** Allows injecting the modal header text. Useful when you can't use the `headingText` prop directly, or when you need to render styled content. */
+var HeaderTitle = function (props) {
+    var _a = React.useState(), target = _a[0], setTarget = _a[1];
+    // on mount, find the parent modal and set it as the target
+    if (!target)
+        return (React__default["default"].createElement("div", { style: { display: 'none' }, ref: function (el) {
+                var modal = el === null || el === void 0 ? void 0 : el.closest(".lui-modal-v2");
+                var modalHeader = modal === null || modal === void 0 ? void 0 : modal.querySelector(':scope > .lui-modal-v2-header');
+                modalHeader && setTarget(modalHeader);
+            } }));
+    return ReactDOM.createPortal(React__default["default"].createElement("h2", { className: clsx('lui-modal-v2-header-title lui-modal-v2-header-title-portal', props.className) }, props.children), target);
+};
+LuiModalV2.HeaderTitle = HeaderTitle;
+// this is here for the tests
+var isTest = typeof process !== 'undefined' && ((_a = process === null || process === void 0 ? void 0 : process.env) === null || _a === void 0 ? void 0 : _a.NODE_ENV) === 'test';
+if (!isTest)
+    Modal.setAppElement('#root');
+
+var LuiAlertModalV2 = function (props) {
+    var level = props.level, className = props.className, children = props.children, rest = __rest(props, ["level", "className", "children"]);
+    var materialIcon = getMaterialIconForLevel(level);
+    var status = Object.keys(ICON_STATUS).includes(level)
+        ? level
+        : 'interactive';
+    return (React__default["default"].createElement(LuiModalV2, __assign({}, rest, { className: clsx("lui-modal-v2-alert lui-modal-v2-".concat(level), className), headingIcon: {
+            name: "ic_".concat(materialIcon),
+            alt: "".concat(level, " status icon"),
+            size: 'md',
+            status: status
+        } }), children));
+};
+
 var css_248z$g = "@keyframes react-loading-skeleton {\n  100% {\n    transform: translateX(100%);\n  }\n}\n\n.react-loading-skeleton {\n  --base-color: #ebebeb;\n  --highlight-color: #f5f5f5;\n  --animation-duration: 1.5s;\n  --animation-direction: normal;\n  --pseudo-element-display: block; /* Enable animation */\n\n  background-color: var(--base-color);\n\n  width: 100%;\n  border-radius: 0.25rem;\n  display: inline-flex;\n  line-height: 1;\n\n  position: relative;\n  user-select: none;\n  overflow: hidden;\n  z-index: 1; /* Necessary for overflow: hidden to work correctly in Safari */\n}\n\n.react-loading-skeleton::after {\n  content: ' ';\n  display: var(--pseudo-element-display);\n  position: absolute;\n  top: 0;\n  left: 0;\n  right: 0;\n  height: 100%;\n  background-repeat: no-repeat;\n  background-image: linear-gradient(\n    90deg,\n    var(--base-color),\n    var(--highlight-color),\n    var(--base-color)\n  );\n  transform: translateX(-100%);\n\n  animation-name: react-loading-skeleton;\n  animation-direction: var(--animation-direction);\n  animation-duration: var(--animation-duration);\n  animation-timing-function: ease-in-out;\n  animation-iteration-count: infinite;\n}\n\n@media (prefers-reduced-motion) {\n  .react-loading-skeleton {\n    --pseudo-element-display: none; /* Disable animation */\n  }\n}\n";
 styleInject(css_248z$g);
 
@@ -46800,34 +46921,6 @@ var LuiTooltip = function (props) {
     return React__default["default"].createElement(Tippy, __assign({}, tippyProps), children);
 };
 
-/**
- * This hook will callback with handleClickOutside() when "mousedown" dom event occurs off the refElement
- * usage:
- ```typescript
-  const refElement = React.useRef<HTMLButtonElement>(null);
-  const handleClickOutside = () => {
-      console.log("hello world");
-  };
-  useClickedOutsideElement(refElement, handleClickOutside);
-  return <button ref={refElement}>Click Me!</button>;
- ```
- */
-function useClickedOutsideElement(refElement, handleClickOutside) {
-    React__default["default"].useEffect(function () {
-        function onOutsideClicked(event) {
-            var element = refElement.current;
-            if (!(element === null || element === void 0 ? void 0 : element.contains(event.target))) {
-                handleClickOutside();
-            }
-        }
-        document.addEventListener('mousedown', onOutsideClicked);
-        return function () {
-            document.removeEventListener('mousedown', onOutsideClicked);
-        };
-        // eslint-disable-next-line react-hooks/exhaustive-deps
-    }, []);
-}
-
 var getFillClassName = function (fillVariation, backgroundFill) {
     if (backgroundFill) {
         return 'LuiBadge--fill';
@@ -59730,6 +59823,7 @@ exports.LuiAccordicardStatic = LuiAccordicardStatic;
 exports.LuiAccordion = LuiAccordion;
 exports.LuiAlertModal = LuiAlertModal;
 exports.LuiAlertModalButtons = LuiAlertModalButtons;
+exports.LuiAlertModalV2 = LuiAlertModalV2;
 exports.LuiAppFooterSml = LuiAppFooterSml;
 exports.LuiBadge = LuiBadge;
 exports.LuiBanner = LuiBanner;
@@ -59783,6 +59877,7 @@ exports.LuiMenuCloseButtonV2 = LuiMenuCloseButtonV2;
 exports.LuiMessagingContextProvider = LuiMessagingContextProvider;
 exports.LuiMiniSpinner = LuiMiniSpinner;
 exports.LuiModal = LuiModal;
+exports.LuiModalV2 = LuiModalV2;
 exports.LuiMoneyInput = LuiMoneyInput;
 exports.LuiMultiSwitch = LuiMultiSwitch;
 exports.LuiMultiSwitchYesNo = LuiMultiSwitchYesNo;