@carbon/ibm-products 2.54.0-canary.8 → 2.54.0-canary.80

package/lib/components/Tearsheet/TearsheetShell.js

@@ -23,7 +23,7 @@ var usePortalTarget = require('../../global/js/hooks/usePortalTarget.js');
 var useFocus = require('../../global/js/hooks/useFocus.js');
 var usePreviousValue = require('../../global/js/hooks/usePreviousValue.js');
 
-var _excluded = ["actions", "aiLabel", "ariaLabel", "children", "className", "closeIconDescription", "description", "hasCloseIcon", "headerActions", "influencer", "influencerPosition", "influencerWidth", "label", "navigation", "onClose", "open", "portalTarget", "selectorPrimaryFocus", "selectorsFloatingMenus", "size", "slug", "title", "verticalPosition", "launcherButtonRef"];
+var _excluded = ["actions", "aiLabel", "ariaLabel", "children", "className", "closeIconDescription", "currentStep", "description", "hasCloseIcon", "headerActions", "influencer", "influencerPosition", "influencerWidth", "label", "navigation", "onClose", "open", "portalTarget", "selectorPrimaryFocus", "selectorsFloatingMenus", "size", "slug", "title", "verticalPosition", "launcherButtonRef"];
 // The block part of our conventional BEM class names (bc__E--M).
 var bc = "".concat(settings.pkg.prefix, "--tearsheet");
 var componentName = 'TearsheetShell';
@@ -70,6 +70,7 @@ var TearsheetShell = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
     children = _ref.children,
     className = _ref.className,
     closeIconDescription = _ref.closeIconDescription,
+    currentStep = _ref.currentStep,
     description = _ref.description,
     hasCloseIcon = _ref.hasCloseIcon,
     headerActions = _ref.headerActions,
@@ -102,8 +103,7 @@ var TearsheetShell = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var prevOpen = usePreviousValue.usePreviousValue(open);
   var _useFocus = useFocus.useFocus(modalRef, selectorPrimaryFocus),
     firstElement = _useFocus.firstElement,
-    keyDownListener = _useFocus.keyDownListener,
-    specifiedElement = _useFocus.specifiedElement;
+    keyDownListener = _useFocus.keyDownListener;
   var modalRefValue = modalRef.current;
 
   // Function to strip html tags out of a string.
@@ -139,44 +139,12 @@ var TearsheetShell = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
     setDepth(newDepth);
     setPosition(newPosition);
   }
-  handleStackChange.checkFocus = function () {
-    // if we are now the topmost tearsheet, ensure we have focus
-    if (open && position === depth && modalRefValue && !modalRefValue.contains(document.activeElement)) {
-      handleStackChange.claimFocus();
-    }
-  };
-
-  // Callback to give the tearsheet the opportunity to claim focus
-  handleStackChange.claimFocus = function () {
-    if (selectorPrimaryFocus && useFocus.getSpecificElement(modalRef === null || modalRef === void 0 ? void 0 : modalRef.current, selectorPrimaryFocus)) {
-      var _window;
-      var specifiedEl = useFocus.getSpecificElement(modalRef === null || modalRef === void 0 ? void 0 : modalRef.current, selectorPrimaryFocus);
-      if (specifiedEl && ((_window = window) === null || _window === void 0 || (_window = _window.getComputedStyle(specifiedEl)) === null || _window === void 0 ? void 0 : _window.display) !== 'none') {
-        return specifiedEl.focus();
-      }
-    }
-    setTimeout(function () {
-      return firstElement === null || firstElement === void 0 ? void 0 : firstElement.focus();
-    }, 0);
-  };
   React.useEffect(function () {
-    if (open) {
+    if (open && position === depth) {
       // Focusing the first element or selectorPrimaryFocus element
-      if (selectorPrimaryFocus && useFocus.getSpecificElement(modalRef === null || modalRef === void 0 ? void 0 : modalRef.current, selectorPrimaryFocus)) {
-        var _window2;
-        var specifiedEl = useFocus.getSpecificElement(modalRef === null || modalRef === void 0 ? void 0 : modalRef.current, selectorPrimaryFocus);
-        if (specifiedEl && ((_window2 = window) === null || _window2 === void 0 || (_window2 = _window2.getComputedStyle(specifiedEl)) === null || _window2 === void 0 ? void 0 : _window2.display) !== 'none') {
-          setTimeout(function () {
-            return specifiedEl.focus();
-          }, 0);
-          return;
-        }
-      }
-      setTimeout(function () {
-        return firstElement === null || firstElement === void 0 ? void 0 : firstElement.focus();
-      }, 0);
+      useFocus.claimFocus(firstElement, modalRef, selectorPrimaryFocus);
     }
-  }, [firstElement, modalRef, open, selectorPrimaryFocus]);
+  }, [currentStep, depth, firstElement, modalRef, modalRefValue, open, position, selectorPrimaryFocus]);
   React.useEffect(function () {
     if (prevOpen && !open && launcherButtonRef) {
       setTimeout(function () {
@@ -184,22 +152,10 @@ var TearsheetShell = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
       }, 0);
     }
   }, [launcherButtonRef, open, prevOpen]);
-  React.useEffect(function () {
-    if (open && position !== depth) {
-      setTimeout(function () {
-        if (selectorPrimaryFocus) {
-          return specifiedElement === null || specifiedElement === void 0 ? void 0 : specifiedElement.focus();
-        }
-        firstElement === null || firstElement === void 0 || firstElement.focus();
-      }, 0);
-    }
-  }, [position, depth, firstElement, open, specifiedElement, selectorPrimaryFocus]);
   React.useEffect(function () {
     var notify = function notify() {
       return stack.all.forEach(function (handler) {
-        var _handler$checkFocus;
         handler(Math.min(stack.open.length, maxDepth), stack.open.indexOf(handler) + 1);
-        (_handler$checkFocus = handler.checkFocus) === null || _handler$checkFocus === void 0 || _handler$checkFocus.call(handler);
       });
     };
 
@@ -234,14 +190,6 @@ var TearsheetShell = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
       }
     };
   }, [open, size]);
-  function handleFocus() {
-    // If something within us is receiving focus but we are not the topmost
-    // stacked tearsheet, transfer focus to the topmost tearsheet instead
-    if (position < depth) {
-      var _stack$open$claimFocu, _stack$open;
-      (_stack$open$claimFocu = (_stack$open = stack.open[stack.open.length - 1]).claimFocus) === null || _stack$open$claimFocu === void 0 || _stack$open$claimFocu.call(_stack$open);
-    }
-  }
   if (position <= depth) {
     var _prevDepth$current;
     // Include a modal header if and only if one or more of these is given.
@@ -273,7 +221,6 @@ var TearsheetShell = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
       onClose: onClose,
       open: open,
       selectorPrimaryFocus: selectorPrimaryFocus,
-      onFocus: handleFocus,
       onKeyDown: keyDownListener,
       preventCloseOnClickOutside: !isPassive,
       ref: modalRef,

package/lib/global/js/hooks/useFocus.d.ts

@@ -12,3 +12,4 @@ export function useFocus(modalRef: any, selectorPrimaryFocus: any): {
         specified: any;
     };
 };
+export function claimFocus(firstElement: any, modalRef: any, selectorPrimaryFocus?: string | undefined): void;

package/lib/global/js/hooks/useFocus.js

@@ -106,5 +106,29 @@ var useFocus = function useFocus(modalRef, selectorPrimaryFocus) {
   };
 };
 
+/**
+ *
+ * @param {*} firstElement
+ * @param {*} modalRef
+ * @param {string | undefined} selectorPrimaryFocus
+ */
+var claimFocus = function claimFocus(firstElement, modalRef) {
+  var selectorPrimaryFocus = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : undefined;
+  if (selectorPrimaryFocus && getSpecificElement(modalRef === null || modalRef === void 0 ? void 0 : modalRef.current, selectorPrimaryFocus)) {
+    var _window2;
+    var specifiedEl = getSpecificElement(modalRef === null || modalRef === void 0 ? void 0 : modalRef.current, selectorPrimaryFocus);
+    if (specifiedEl && ((_window2 = window) === null || _window2 === void 0 || (_window2 = _window2.getComputedStyle(specifiedEl)) === null || _window2 === void 0 ? void 0 : _window2.display) !== 'none') {
+      setTimeout(function () {
+        return specifiedEl.focus();
+      }, 0);
+    }
+  } else {
+    setTimeout(function () {
+      return firstElement === null || firstElement === void 0 ? void 0 : firstElement.focus();
+    }, 0);
+  }
+};
+
+exports.claimFocus = claimFocus;
 exports.getSpecificElement = getSpecificElement;
 exports.useFocus = useFocus;

package/lib/global/js/hooks/usePrefersReducedMotion.js

@@ -33,6 +33,5 @@ var usePrefersReducedMotion = function usePrefersReducedMotion() {
   }, []);
   return prefersReducedMotion;
 };
-var usePrefersReducedMotion$1 = usePrefersReducedMotion;
 
-exports.default = usePrefersReducedMotion$1;
+exports.default = usePrefersReducedMotion;

package/lib/global/js/package-settings.d.ts

@@ -66,6 +66,7 @@ declare namespace defaults {
         let WebTerminal: boolean;
         let WebTerminalContentWrapper: boolean;
         let WebTerminalProvider: boolean;
+        let UserAvatar: boolean;
         let Toolbar: boolean;
         let ToolbarButton: boolean;
         let ToolbarGroup: boolean;
@@ -115,7 +116,6 @@ declare namespace defaults {
         let DescriptionListCell: boolean;
         let DescriptionListRow: boolean;
         let SearchBar: boolean;
-        let UserAvatar: boolean;
         let EmptyStateV2: boolean;
         let Guidebanner: boolean;
         let GuidebannerElement: boolean;

package/lib/global/js/package-settings.js

@@ -68,6 +68,7 @@ var defaults = {
     WebTerminal: true,
     WebTerminalContentWrapper: true,
     WebTerminalProvider: true,
+    UserAvatar: true,
     // other public components not yet reviewed and released:
     Toolbar: false,
     ToolbarButton: false,
@@ -121,7 +122,6 @@ var defaults = {
     DescriptionListCell: false,
     DescriptionListRow: false,
     SearchBar: false,
-    UserAvatar: false,
     /* new component flags here - comment used by generate CLI */
 
     // Onboarding components not yet reviewed and released:

package/lib/global/js/utils/checkForOverflow.d.ts

@@ -0,0 +1,5 @@
+/**
+ * used to calculate if a element is overflowing the width or height of an area
+ */
+export declare const checkWidthOverflow: (el: HTMLElement | null) => boolean;
+export declare const checkHeightOverflow: (el: HTMLElement | null) => boolean;

package/lib/global/js/utils/checkForOverflow.js

@@ -0,0 +1,34 @@
+/**
+ * Copyright IBM Corp. 2020, 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+'use strict';
+
+// Copyright IBM Corp. 2024, 2024
+//
+// This source code is licensed under the Apache-2.0 license found in the
+// LICENSE file in the root directory of this source tree.
+//
+
+/**
+ * used to calculate if a element is overflowing the width or height of an area
+ */
+
+var checkWidthOverflow = function checkWidthOverflow(el) {
+  if (el) {
+    return (el === null || el === void 0 ? void 0 : el.offsetWidth) < (el === null || el === void 0 ? void 0 : el.scrollWidth);
+  }
+  return false;
+};
+var checkHeightOverflow = function checkHeightOverflow(el) {
+  if (el) {
+    return (el === null || el === void 0 ? void 0 : el.offsetHeight) < (el === null || el === void 0 ? void 0 : el.scrollHeight);
+  }
+  return false;
+};
+
+exports.checkHeightOverflow = checkHeightOverflow;
+exports.checkWidthOverflow = checkWidthOverflow;