@carbon/ibm-products 2.33.0 → 2.34.0

package/lib/components/SidePanel/SidePanel.js

@@ -37,8 +37,8 @@ var _excluded = ["actionToolbarButtons", "actions", "animateTitle", "children",
   _excluded2 = ["label", "kind", "icon", "tooltipPosition", "tooltipAlignment", "leading", "disabled", "className", "onClick"];
 var blockClass = "".concat(settings.pkg.prefix, "--side-panel");
 var componentName = 'SidePanel';
-
-// NOTE: the component SCSS is not imported here: it is rolled up separately.
+// `any` is a work around until ActionSet is migrated to TS
+var MotionActionSet = framerMotion.motion(ActionSet.ActionSet);
 
 // Default values for props
 var defaults = {
@@ -49,7 +49,6 @@ var defaults = {
   placement: 'right',
   size: 'md'
 };
-var MotionActionSet = framerMotion.motion(ActionSet.ActionSet);
 
 /**
  * Side panels keep users in-context of a page while performing tasks like navigating, editing, viewing details, or configuring something new.
@@ -93,16 +92,16 @@ exports.SidePanel = /*#__PURE__*/React__default["default"].forwardRef(function (
     _useState2 = _rollupPluginBabelHelpers.slicedToArray(_useState, 2),
     animationComplete = _useState2[0],
     setAnimationComplete = _useState2[1];
-  var localRef = React.useRef();
+  var localRef = React.useRef(null);
   var sidePanelRef = ref || localRef;
-  var overlayRef = React.useRef();
-  var innerContentRef = React.useRef();
-  var closeRef = React.useRef();
-  var animatedScrollRef = React.useRef();
-  var headerRef = React.useRef();
-  var titleRef = React.useRef();
-  var labelTextRef = React.useRef();
-  var subtitleRef = React.useRef();
+  var overlayRef = React.useRef(null);
+  var innerContentRef = React.useRef(null);
+  var closeRef = React.useRef(null);
+  var animatedScrollRef = React.useRef(null);
+  var headerRef = React.useRef(null);
+  var titleRef = React.useRef(null);
+  var labelTextRef = React.useRef(null);
+  var subtitleRef = React.useRef(null);
   var previousState = usePreviousValue.usePreviousValue({
     size: size,
     open: open
@@ -118,32 +117,36 @@ exports.SidePanel = /*#__PURE__*/React__default["default"].forwardRef(function (
   var _useFocus = useFocus.useFocus(sidePanelRef),
     firstElement = _useFocus.firstElement,
     keyDownListener = _useFocus.keyDownListener;
+  var panelRefValue = sidePanelRef.current;
   var shouldReduceMotion = framerMotion.useReducedMotion();
   React.useEffect(function () {
     setDoAnimateTitle(animateTitle);
   }, [animateTitle]);
   var handleScroll = React.useCallback(function () {
-    var scrollTop = animatedScrollRef.current.scrollTop;
-    sidePanelRef.current.style.setProperty("--".concat(blockClass, "--scroll-animation-progress"), Math.min(scrollTop, scrollAnimationDistance) / scrollAnimationDistance);
-  }, [scrollAnimationDistance, sidePanelRef]);
+    var _animatedScrollRef$cu;
+    var scrollTop = animatedScrollRef === null || animatedScrollRef === void 0 || (_animatedScrollRef$cu = animatedScrollRef.current) === null || _animatedScrollRef$cu === void 0 ? void 0 : _animatedScrollRef$cu.scrollTop;
+    panelRefValue === null || panelRefValue === void 0 || panelRefValue.style.setProperty("--".concat(blockClass, "--scroll-animation-progress"), (Math.min(Number(scrollTop), scrollAnimationDistance) / scrollAnimationDistance).toString());
+  }, [scrollAnimationDistance, panelRefValue]);
   var reducedMotion = typeof window !== 'undefined' && (_window = window) !== null && _window !== void 0 && _window.matchMedia ? window.matchMedia('(prefers-reduced-motion: reduce)') : {
     matches: true
   };
 
   // scroll panel to top going between steps
   React.useEffect(function () {
-    if (sidePanelRef && sidePanelRef.current) {
-      var _animatedScrollRef$cu;
-      var scrollableSection = (_animatedScrollRef$cu = animatedScrollRef.current) !== null && _animatedScrollRef$cu !== void 0 ? _animatedScrollRef$cu : innerContentRef.current;
-      scrollableSection.scrollTop = 0;
+    if (sidePanelRef && panelRefValue) {
+      var _animatedScrollRef$cu2;
+      var scrollableSection = (_animatedScrollRef$cu2 = animatedScrollRef.current) !== null && _animatedScrollRef$cu2 !== void 0 ? _animatedScrollRef$cu2 : innerContentRef.current;
+      if (scrollableSection) {
+        scrollableSection.scrollTop = 0;
+      }
       // The size of the panel has changed while it is still opened
       // so we need to scroll it to the top and reset the header
       // height css custom property
-      if ((previousState === null || previousState === void 0 ? void 0 : previousState.size) !== size) {
+      if (previousState && previousState['size'] !== size && scrollableSection) {
         scrollableSection.scrollTop = 0;
       }
     }
-  }, [currentStep, sidePanelRef, size, previousState === null || previousState === void 0 ? void 0 : previousState.size, id]);
+  }, [currentStep, sidePanelRef, size, previousState, id, panelRefValue]);
 
   // Add console warning if labelText is provided without a title.
   // This combination is not allowed.
@@ -154,7 +157,7 @@ exports.SidePanel = /*#__PURE__*/React__default["default"].forwardRef(function (
   }, [labelText, title]);
   var checkSetDoAnimateTitle = function checkSetDoAnimateTitle() {
     var canDoAnimateTitle = false;
-    if (sidePanelRef !== null && sidePanelRef !== void 0 && sidePanelRef.current && open && animateTitle && animationComplete && titleRef !== null && titleRef !== void 0 && titleRef.current && title && title.length && !reducedMotion.matches) {
+    if (panelRefValue && open && animateTitle && animationComplete && titleRef !== null && titleRef !== void 0 && titleRef.current && title && title.length && !reducedMotion.matches) {
       var _labelTextRef$current, _labelTextRef$current2, _subtitleRef$current$, _subtitleRef$current;
       var titleEl = titleRef.current;
       var labelHeight = (_labelTextRef$current = labelTextRef === null || labelTextRef === void 0 || (_labelTextRef$current2 = labelTextRef.current) === null || _labelTextRef$current2 === void 0 ? void 0 : _labelTextRef$current2.offsetHeight) !== null && _labelTextRef$current !== void 0 ? _labelTextRef$current : 0;
@@ -167,7 +170,7 @@ exports.SidePanel = /*#__PURE__*/React__default["default"].forwardRef(function (
       setScrollAnimationDistance(_scrollAnimationDistance);
 
       // used to calculate the header moves
-      sidePanelRef.current.style.setProperty("--".concat(blockClass, "--scroll-animation-distance"), _scrollAnimationDistance);
+      panelRefValue === null || panelRefValue === void 0 || panelRefValue.style.setProperty("--".concat(blockClass, "--scroll-animation-distance"), _scrollAnimationDistance.toString());
       var scrollEl = animatedScrollRef.current;
       if (!scrollEl && animateTitle && !doAnimateTitle) {
         // may be switching back based on resize
@@ -192,9 +195,9 @@ exports.SidePanel = /*#__PURE__*/React__default["default"].forwardRef(function (
       animatedScrollRef.current.addEventListener('scroll', handleScroll);
     }
     if (!doAnimateTitle && sidePanelRef.current) {
-      sidePanelRef.current.style.setProperty("--".concat(blockClass, "--scroll-animation-progress"), 0);
+      panelRefValue === null || panelRefValue === void 0 || panelRefValue.style.setProperty("--".concat(blockClass, "--scroll-animation-progress"), '0');
     }
-  }, [animatedScrollRef, doAnimateTitle, handleScroll, sidePanelRef]);
+  }, [animatedScrollRef, doAnimateTitle, handleScroll, sidePanelRef, panelRefValue]);
 
   /* istanbul ignore next */
   var handleResize = function handleResize() {
@@ -203,7 +206,7 @@ exports.SidePanel = /*#__PURE__*/React__default["default"].forwardRef(function (
 
   // Calculate scroll distances
   React.useEffect(function () {
-    if (sidePanelRef !== null && sidePanelRef !== void 0 && sidePanelRef.current && open && animateTitle && animationComplete && titleRef !== null && titleRef !== void 0 && titleRef.current && title && title.length && !reducedMotion.matches) {
+    if (panelRefValue && open && animateTitle && animationComplete && titleRef !== null && titleRef !== void 0 && titleRef.current && title && title.length && !reducedMotion.matches) {
       checkSetDoAnimateTitle();
     }
 
@@ -213,7 +216,7 @@ exports.SidePanel = /*#__PURE__*/React__default["default"].forwardRef(function (
   // click outside functionality if `includeOverlay` prop is set
   React.useEffect(function () {
     var handleOutsideClick = function handleOutsideClick(event) {
-      if (sidePanelRef.current && overlayRef.current && overlayRef.current.contains(event.target) && onRequestClose) {
+      if (panelRefValue && overlayRef.current && overlayRef.current.contains(event.target) && onRequestClose) {
         onRequestClose();
       }
     };
@@ -231,7 +234,7 @@ exports.SidePanel = /*#__PURE__*/React__default["default"].forwardRef(function (
       bodyElement.style.overflow = '';
       document.removeEventListener('click', handleOutsideClick);
     };
-  }, [includeOverlay, onRequestClose, open, preventCloseOnClickOutside, onUnmount, sidePanelRef]);
+  }, [includeOverlay, onRequestClose, open, preventCloseOnClickOutside, onUnmount, sidePanelRef, panelRefValue]);
 
   // initializes the side panel to close
   var onAnimationEnd = function onAnimationEnd() {
@@ -250,43 +253,43 @@ exports.SidePanel = /*#__PURE__*/React__default["default"].forwardRef(function (
   }, [reducedMotion.matches]);
 
   // initializes the side panel to open
-  var _onAnimationStart = function onAnimationStart() {
+  var onAnimationStart = function onAnimationStart() {
     setAnimationComplete(false);
   };
 
   // used to reset margins of the slide in panel when closed/closing
   React.useEffect(function () {
     if (!open && slideIn) {
-      var pageContentElement = document.querySelector(selectorPageContent);
+      var pageContentElement = selectorPageContent ? document.querySelector(selectorPageContent) : null;
       if (placement && placement === 'right' && pageContentElement) {
-        pageContentElement.style.marginInlineEnd = 0;
+        pageContentElement.style.marginInlineEnd = '0';
       } else if (pageContentElement) {
-        pageContentElement.style.marginInlineStart = 0;
+        pageContentElement.style.marginInlineStart = '0';
       }
     }
   }, [open, placement, selectorPageContent, slideIn]);
   React.useEffect(function () {
-    if (!open && previousState !== null && previousState !== void 0 && previousState.open && reducedMotion.matches) {
+    if (!open && previousState && previousState['open'] && reducedMotion.matches) {
       onUnmount === null || onUnmount === void 0 || onUnmount();
     }
-  }, [open, onUnmount, reducedMotion.matches, previousState === null || previousState === void 0 ? void 0 : previousState.open]);
+  }, [open, onUnmount, reducedMotion.matches, previousState]);
 
   // used to set margins of content for slide in panel version
   React.useEffect(function () {
     if (open && slideIn) {
-      var pageContentElement = document.querySelector(selectorPageContent);
+      var pageContentElement = selectorPageContent ? document.querySelector(selectorPageContent) : null;
       if (pageContentElement) {
         pageContentElement.style.inlineSize = 'auto';
       } else {
         pconsole["default"].warn('SidePanel prop `selectorPageContent` was not provided a selector that matches any element on your page. If an element is not found, the panel will render as a slide over.');
       }
       if (placement && placement === 'right' && pageContentElement) {
-        pageContentElement.style.marginInlineEnd = 0;
-        pageContentElement.style.transition = !reducedMotion.matches ? "margin-inline-end ".concat(carbonMotion.moderate02) : null;
+        pageContentElement.style.marginInlineEnd = '0';
+        pageContentElement.style.transition = !reducedMotion.matches ? "margin-inline-end ".concat(carbonMotion.moderate02) : '';
         pageContentElement.style.marginInlineEnd = constants.SIDE_PANEL_SIZES[size];
       } else if (pageContentElement) {
-        pageContentElement.style.marginInlineStart = 0;
-        pageContentElement.style.transition = !reducedMotion.matches ? "margin-inline-start ".concat(carbonMotion.moderate02) : null;
+        pageContentElement.style.marginInlineStart = '0';
+        pageContentElement.style.transition = !reducedMotion.matches ? "margin-inline-start ".concat(carbonMotion.moderate02) : '';
         pageContentElement.style.marginInlineStart = constants.SIDE_PANEL_SIZES[size];
       }
     }
@@ -294,10 +297,12 @@ exports.SidePanel = /*#__PURE__*/React__default["default"].forwardRef(function (
   React.useEffect(function () {
     if (open) {
       setTimeout(function () {
-        var _document;
-        var primeFocusEl = (_document = document) === null || _document === void 0 ? void 0 : _document.querySelector(selectorPrimaryFocus);
-        if (selectorPrimaryFocus && primeFocusEl) {
-          primeFocusEl.focus();
+        if (selectorPrimaryFocus) {
+          var _document;
+          var primeFocusEl = (_document = document) === null || _document === void 0 ? void 0 : _document.querySelector(selectorPrimaryFocus);
+          if (primeFocusEl) {
+            primeFocusEl === null || primeFocusEl === void 0 || primeFocusEl.focus();
+          }
         } else {
           firstElement === null || firstElement === void 0 || firstElement.focus();
         }
@@ -324,7 +329,7 @@ exports.SidePanel = /*#__PURE__*/React__default["default"].forwardRef(function (
     var _slug$type;
     var slugCloseSize = actions && actions.length && /l/.test(size) ? 'md' : 'sm';
     var normalizedSlug;
-    if (slug && (slug === null || slug === void 0 || (_slug$type = slug.type) === null || _slug$type === void 0 ? void 0 : _slug$type.displayName) === 'Slug') {
+    if (slug && ((_slug$type = slug['type']) === null || _slug$type === void 0 ? void 0 : _slug$type.displayName) === 'Slug') {
       normalizedSlug = /*#__PURE__*/React__default["default"].cloneElement(slug, {
         // slug size is sm unless actions and size > md
         size: slugCloseSize
@@ -409,9 +414,7 @@ exports.SidePanel = /*#__PURE__*/React__default["default"].forwardRef(function (
     role: "complementary",
     "aria-label": title,
     onAnimationComplete: onAnimationEnd,
-    onAnimationStart: function onAnimationStart(event) {
-      return _onAnimationStart();
-    },
+    onAnimationStart: onAnimationStart,
     variants: variants.panelVariants,
     initial: "hidden",
     animate: "visible",
@@ -471,7 +474,8 @@ exports.SidePanel.propTypes = {
    *
    * See https://react.carbondesignsystem.com/?path=/docs/components-button--default#component-api
    */
-  actions: propsHelper.allPropTypes([ActionSet.ActionSet.validateActions(), index["default"].arrayOf(index["default"].shape(_rollupPluginBabelHelpers.objectSpread2(_rollupPluginBabelHelpers.objectSpread2({}, react.Button.propTypes), {}, {
+  actions: propsHelper.allPropTypes([/**@ts-ignore*/
+  ActionSet.ActionSet.validateActions(), index["default"].arrayOf(index["default"].shape(_rollupPluginBabelHelpers.objectSpread2(_rollupPluginBabelHelpers.objectSpread2({}, react.Button.propTypes), {}, {
     kind: index["default"].oneOf(['ghost', 'danger--ghost', 'secondary', 'danger', 'primary']),
     tooltipPosition: index["default"].oneOf(['top', 'right', 'bottom', 'left']),
     tooltipAlignment: index["default"].oneOf(['start', 'center', 'end']),
@@ -550,6 +554,7 @@ exports.SidePanel.propTypes = {
    * This is the selector to the element that contains all of the page content that will shrink if the panel is a slide in.
    * This prop is required when using the `slideIn` variant of the side panel.
    */
+  /**@ts-ignore*/
   selectorPageContent: index["default"].string.isRequired.if(function (_ref6) {
     var slideIn = _ref6.slideIn;
     return slideIn;
@@ -558,14 +563,17 @@ exports.SidePanel.propTypes = {
    * Specify a CSS selector that matches the DOM element that should
    * be focused when the side panel opens
    */
+  /**@ts-ignore*/
   selectorPrimaryFocus: index["default"].string,
   /**
    * Sets the size of the side panel
    */
+  /**@ts-ignore*/
   size: index["default"].oneOf(['xs', 'sm', 'md', 'lg', '2xl']),
   /**
    * Determines if this panel slides in
    */
+  /**@ts-ignore*/
   slideIn: index["default"].bool,
   /**
    *  **Experimental:** Provide a `Slug` component to be rendered inside the `SidePanel` component
@@ -578,6 +586,7 @@ exports.SidePanel.propTypes = {
   /**
    * Sets the title text
    */
+  /**@ts-ignore*/
   title: index["default"].string.isRequired.if(function (_ref7) {
     var labelText = _ref7.labelText;
     return labelText;

package/lib/components/StatusIcon/StatusIcon.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Copyright IBM Corp. 2021, 2022
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React, { PropsWithChildren } from 'react';
 /**
 The `StatusIcon` component follows the Carbon guidelines for status icons with
 some added specifications around illustration usage. For additional usage
@@ -7,5 +14,30 @@ _Status icons_ are an important method of communicating severity level
 information to users. The shapes and colors, communicate severity that enable
 users to quickly assess and identify status and respond accordingly.
  */
-export let StatusIcon: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+type Size = 'sm' | 'md' | 'lg' | 'xl';
+type Theme = 'light' | 'dark';
+type Kind = 'fatal' | 'critical' | 'major-warning' | 'minor-warning' | 'undefined' | 'unknown' | 'normal' | 'info' | 'in-progress' | 'running' | 'pending';
+interface StatusIconProps extends PropsWithChildren {
+    /**
+     * Provide an optional class to be applied to the modal root node.
+     */
+    className?: string;
+    /**
+     * A required prop that provides a title element and tooltip for the icon for accessibility purposes
+     */
+    iconDescription: string;
+    /**
+     * A required prop that displays the respective icon associated with the status
+     */
+    kind: Kind;
+    /**
+     * A required prop that displays the size of the icon associate with the status
+     */
+    size: Size;
+    /**
+     * A required prop that displays the theme of the icon associated with the status
+     */
+    theme: Theme;
+}
+export declare let StatusIcon: React.ForwardRefExoticComponent<StatusIconProps & React.RefAttributes<React.ReactSVGElement | null>>;
+export {};