@carbon/ibm-products 2.32.0 → 2.34.0

package/es/components/SidePanel/SidePanel.d.ts

@@ -1,5 +1,147 @@
+/**
+ * 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.
+ */
+/// <reference path="../../../src/custom-typings/index.d.ts" />
+import React, { ReactNode } from 'react';
+import { ButtonProps } from '@carbon/react';
+type SidePanelBaseProps = {
+    /**
+     * Sets the action toolbar buttons
+     */
+    actionToolbarButtons?: ButtonProps[];
+    /**
+     * The primary actions to be shown in the side panel. Each action is
+     * specified as an object that will render expressive Buttons. Any Button
+     * props can be passed in and any other fields in the object will be
+     * passed through to the button element as HTML attributes.
+     *
+     * See https://react.carbondesignsystem.com/?path=/docs/components-button--default#component-api
+     */
+    actions?: ButtonProps[];
+    /**
+     * Determines if the title will animate on scroll
+     */
+    animateTitle?: boolean;
+    /**
+     * Sets the body content of the side panel
+     */
+    children: ReactNode;
+    /**
+     * Sets an optional className to be added to the side panel outermost element
+     */
+    className?: string;
+    /**
+     * Sets the close button icon description
+     */
+    closeIconDescription?: string;
+    /**
+     * Determines whether the side panel should render the condensed version (affects action buttons primarily)
+     */
+    condensedActions?: boolean;
+    /**
+     * Sets the current step of the side panel
+     */
+    currentStep?: number;
+    /**
+     * Unique identifier
+     */
+    id?: string;
+    /**
+     * Determines whether the side panel should render with an overlay
+     */
+    includeOverlay?: boolean;
+    /**
+     * Sets the label text which will display above the title text
+     */
+    labelText?: string;
+    /**
+     * Sets the icon description for the navigation back icon button
+     */
+    navigationBackIconDescription?: string;
+    /**
+     * Changes the current side panel page to the previous page
+     */
+    onNavigationBack?(): void;
+    /**
+     * Specify a handler for closing the side panel.
+     * This handler closes the modal, e.g. changing `open` prop.
+     */
+    onRequestClose?(): void;
+    /**
+     * Optional function called when the side panel exit animation is complete.
+     * This handler can be used for any state cleanup needed before the panel is removed from the DOM.
+     */
+    onUnmount?(): void;
+    /**
+     * Determines whether the side panel should render or not
+     */
+    open: boolean;
+    /**
+     * Determines if the side panel is on the right or left
+     */
+    placement?: 'left' | 'right';
+    /**
+     * Prevent closing on click outside of the panel
+     */
+    preventCloseOnClickOutside?: boolean;
+    /**
+     * 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.
+     */
+    selectorPageContent?: string;
+    /**
+     * Specify a CSS selector that matches the DOM element that should
+     * be focused when the side panel opens
+     */
+    selectorPrimaryFocus?: string;
+    /**
+     * Sets the size of the side panel
+     */
+    size: 'xs' | 'sm' | 'md' | 'lg' | '2xl';
+    /**
+     * Determines if this panel slides in
+     */
+    slideIn?: boolean;
+    /**
+     *  **Experimental:** Provide a `Slug` component to be rendered inside the `SidePanel` component
+     */
+    slug?: ReactNode;
+    /**
+     * Sets the subtitle text
+     */
+    subtitle?: ReactNode;
+    /**
+     * Sets the title text
+     */
+    title?: string;
+};
+type SidePanelSlideInProps = {
+    /**
+     * Determines if this panel slides in
+     */
+    slideIn?: false;
+    /**
+     * 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.
+     */
+    selectorPageContent?: string;
+} | {
+    /**
+     * Determines if this panel slides in
+     */
+    slideIn: true;
+    /**
+     * 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. Required for slideIn panels.
+     */
+    selectorPageContent: string;
+};
+type SidePanelProps = SidePanelBaseProps & SidePanelSlideInProps;
 /**
  * Side panels keep users in-context of a page while performing tasks like navigating, editing, viewing details, or configuring something new.
  */
-export let SidePanel: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let SidePanel: React.ForwardRefExoticComponent<SidePanelProps & React.RefAttributes<HTMLDivElement>>;
+export {};

package/es/components/SidePanel/SidePanel.js

@@ -14,7 +14,6 @@ import { useResizeObserver } from '../../global/js/hooks/useResizeObserver.js';
 import { moderate02 } from '@carbon/motion';
 import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
 import { allPropTypes } from '../../global/js/utils/props-helper.js';
-import wrapFocus from '../../global/js/utils/wrapFocus.js';
 import { pkg } from '../../settings.js';
 import { SIDE_PANEL_SIZES } from './constants.js';
 import { Button } from '@carbon/react';
@@ -23,13 +22,14 @@ import { actionSetVariants, overlayVariants, panelVariants } from './motion/vari
 import pconsole from '../../global/js/utils/pconsole.js';
 import { ActionSet } from '../ActionSet/ActionSet.js';
 import { usePreviousValue } from '../../global/js/hooks/usePreviousValue.js';
+import { useFocus } from '../../global/js/hooks/useFocus.js';
 
 var _excluded = ["actionToolbarButtons", "actions", "animateTitle", "children", "className", "closeIconDescription", "condensedActions", "currentStep", "id", "includeOverlay", "labelText", "navigationBackIconDescription", "onNavigationBack", "onRequestClose", "onUnmount", "open", "placement", "preventCloseOnClickOutside", "selectorPageContent", "selectorPrimaryFocus", "size", "slideIn", "slug", "subtitle", "title"],
   _excluded2 = ["label", "kind", "icon", "tooltipPosition", "tooltipAlignment", "leading", "disabled", "className", "onClick"];
 var blockClass = "".concat(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 = motion(ActionSet);
 
 // Default values for props
 var defaults = {
@@ -40,7 +40,6 @@ var defaults = {
   placement: 'right',
   size: 'md'
 };
-var MotionActionSet = motion(ActionSet);
 
 /**
  * Side panels keep users in-context of a page while performing tasks like navigating, editing, viewing details, or configuring something new.
@@ -84,18 +83,16 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
     _useState2 = _slicedToArray(_useState, 2),
     animationComplete = _useState2[0],
     setAnimationComplete = _useState2[1];
-  var localRef = useRef();
+  var localRef = useRef(null);
   var sidePanelRef = ref || localRef;
-  var overlayRef = useRef();
-  var startTrapRef = useRef();
-  var endTrapRef = useRef();
-  var innerContentRef = useRef();
-  var closeRef = useRef();
-  var animatedScrollRef = useRef();
-  var headerRef = useRef();
-  var titleRef = useRef();
-  var labelTextRef = useRef();
-  var subtitleRef = useRef();
+  var overlayRef = useRef(null);
+  var innerContentRef = useRef(null);
+  var closeRef = useRef(null);
+  var animatedScrollRef = useRef(null);
+  var headerRef = useRef(null);
+  var titleRef = useRef(null);
+  var labelTextRef = useRef(null);
+  var subtitleRef = useRef(null);
   var previousState = usePreviousValue({
     size: size,
     open: open
@@ -108,52 +105,39 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
     _useState6 = _slicedToArray(_useState5, 2),
     doAnimateTitle = _useState6[0],
     setDoAnimateTitle = _useState6[1];
+  var _useFocus = useFocus(sidePanelRef),
+    firstElement = _useFocus.firstElement,
+    keyDownListener = _useFocus.keyDownListener;
+  var panelRefValue = sidePanelRef.current;
   var shouldReduceMotion = useReducedMotion();
   useEffect(function () {
     setDoAnimateTitle(animateTitle);
   }, [animateTitle]);
   var handleScroll = 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
   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]);
-
-  // set initial focus when side panel opens
-  useEffect(function () {
-    var initialFocus = function initialFocus(focusContainerElement) {
-      var containerElement = focusContainerElement;
-      var primaryFocusElement = containerElement && containerElement.querySelector(selectorPrimaryFocus);
-      if (primaryFocusElement) {
-        return primaryFocusElement;
-      } else {
-        return closeRef && closeRef.current;
-      }
-    };
-    var focusButton = function focusButton(focusContainerElement) {
-      var target = initialFocus(focusContainerElement);
-      target === null || target === void 0 || target.focus();
-    };
-    if (open && animationComplete) {
-      focusButton(innerContentRef.current);
-    }
-  }, [selectorPrimaryFocus, open, animationComplete]);
+  }, [currentStep, sidePanelRef, size, previousState, id, panelRefValue]);
 
   // Add console warning if labelText is provided without a title.
   // This combination is not allowed.
@@ -164,7 +148,7 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
   }, [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;
@@ -177,7 +161,7 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
       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
@@ -202,9 +186,9 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
       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() {
@@ -213,7 +197,7 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
 
   // Calculate scroll distances
   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();
     }
 
@@ -223,7 +207,7 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
   // click outside functionality if `includeOverlay` prop is set
   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();
       }
     };
@@ -241,7 +225,7 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
       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() {
@@ -260,64 +244,62 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
   }, [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
   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]);
   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
   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.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(moderate02) : null;
+        pageContentElement.style.marginInlineEnd = '0';
+        pageContentElement.style.transition = !reducedMotion.matches ? "margin-inline-end ".concat(moderate02) : '';
         pageContentElement.style.marginInlineEnd = SIDE_PANEL_SIZES[size];
       } else if (pageContentElement) {
-        pageContentElement.style.marginInlineStart = 0;
-        pageContentElement.style.transition = !reducedMotion.matches ? "margin-inline-start ".concat(moderate02) : null;
+        pageContentElement.style.marginInlineStart = '0';
+        pageContentElement.style.transition = !reducedMotion.matches ? "margin-inline-start ".concat(moderate02) : '';
         pageContentElement.style.marginInlineStart = SIDE_PANEL_SIZES[size];
       }
     }
   }, [slideIn, selectorPageContent, placement, size, reducedMotion.matches, open]);
-
-  // adds focus trap functionality
-  /* istanbul ignore next */
-  var handleBlur = function handleBlur(_ref2) {
-    var oldActiveNode = _ref2.target,
-      currentActiveNode = _ref2.relatedTarget;
-    // focus trap should only be set if the side panel is a `slideOver` type
-    if (open && innerContentRef && !slideIn) {
-      wrapFocus({
-        bodyNode: innerContentRef.current,
-        startTrapRef: startTrapRef,
-        endTrapRef: endTrapRef,
-        currentActiveNode: currentActiveNode,
-        oldActiveNode: oldActiveNode
-      });
+  useEffect(function () {
+    if (open) {
+      setTimeout(function () {
+        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();
+        }
+      }, 0);
     }
-  };
+  }, [animationComplete, firstElement, open, selectorPrimaryFocus]);
   var primaryActionContainerClassNames = cx(["".concat(blockClass, "__actions-container"), _defineProperty({}, "".concat(blockClass, "__actions-container--condensed"), condensedActions)]);
   var mainPanelClassNames = cx([blockClass, className, "".concat(blockClass), "".concat(blockClass, "--").concat(size), _defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty({}, "".concat(blockClass, "--right-placement"), placement === 'right'), "".concat(blockClass, "--left-placement"), placement === 'left'), "".concat(blockClass, "--slide-in"), slideIn), "".concat(blockClass, "--has-slug"), slug), "".concat(blockClass, "--condensed-actions"), condensedActions), "".concat(blockClass, "--animated-title"), doAnimateTitle), "".concat(blockClass, "--has-overlay"), includeOverlay)]);
   var renderTitle = function renderTitle() {
@@ -338,7 +320,7 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
     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.cloneElement(slug, {
         // slug size is sm unless actions and size > md
         size: slugCloseSize
@@ -383,17 +365,17 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
       ref: subtitleRef
     }, subtitle), actionToolbarButtons && actionToolbarButtons.length && /*#__PURE__*/React__default.createElement("div", {
       className: "".concat(blockClass, "__action-toolbar")
-    }, actionToolbarButtons.map(function (_ref5) {
-      var label = _ref5.label,
-        kind = _ref5.kind,
-        icon = _ref5.icon,
-        tooltipPosition = _ref5.tooltipPosition,
-        tooltipAlignment = _ref5.tooltipAlignment,
-        leading = _ref5.leading,
-        disabled = _ref5.disabled,
-        className = _ref5.className,
-        onClick = _ref5.onClick,
-        rest = _objectWithoutProperties(_ref5, _excluded2);
+    }, actionToolbarButtons.map(function (_ref4) {
+      var label = _ref4.label,
+        kind = _ref4.kind,
+        icon = _ref4.icon,
+        tooltipPosition = _ref4.tooltipPosition,
+        tooltipAlignment = _ref4.tooltipAlignment,
+        leading = _ref4.leading,
+        disabled = _ref4.disabled,
+        className = _ref4.className,
+        onClick = _ref4.onClick,
+        rest = _objectWithoutProperties(_ref4, _excluded2);
       return /*#__PURE__*/React__default.createElement(Button, _extends({}, rest, {
         key: label,
         kind: kind || 'ghost',
@@ -419,14 +401,11 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
   return /*#__PURE__*/React__default.createElement(AnimatePresence, null, open && /*#__PURE__*/React__default.createElement(React__default.Fragment, null, /*#__PURE__*/React__default.createElement(motion.div, _extends({}, getDevtoolsProps(componentName), rest, {
     id: id,
     className: mainPanelClassNames,
-    onBlur: handleBlur,
     ref: sidePanelRef,
     role: "complementary",
     "aria-label": title,
     onAnimationComplete: onAnimationEnd,
-    onAnimationStart: function onAnimationStart(event) {
-      return _onAnimationStart();
-    },
+    onAnimationStart: onAnimationStart,
     variants: panelVariants,
     initial: "hidden",
     animate: "visible",
@@ -434,13 +413,9 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
     custom: {
       placement: placement,
       shouldReduceMotion: shouldReduceMotion
-    }
-  }), /*#__PURE__*/React__default.createElement("span", {
-    ref: startTrapRef,
-    tabIndex: "0",
-    role: "link",
-    className: "".concat(blockClass, "__visually-hidden")
-  }, "Focus sentinel"), doAnimateTitle ? /*#__PURE__*/React__default.createElement("div", {
+    },
+    onKeyDown: keyDownListener
+  }), doAnimateTitle ? /*#__PURE__*/React__default.createElement("div", {
     ref: animatedScrollRef,
     className: "".concat(blockClass, "__animated-scroll-wrapper ").concat(blockClass, "--scrolls")
   }, renderHeader(), renderMain()) : /*#__PURE__*/React__default.createElement(React__default.Fragment, null, renderHeader(), renderMain()), /*#__PURE__*/React__default.createElement(MotionActionSet, {
@@ -449,12 +424,7 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
     size: size === 'xs' ? 'sm' : size,
     custom: shouldReduceMotion,
     variants: actionSetVariants
-  }), /*#__PURE__*/React__default.createElement("span", {
-    ref: endTrapRef,
-    tabIndex: "0",
-    role: "link",
-    className: "".concat(blockClass, "__visually-hidden")
-  }, "Focus sentinel")), /*#__PURE__*/React__default.createElement(AnimatePresence, null, includeOverlay && /*#__PURE__*/React__default.createElement(motion.div, {
+  })), /*#__PURE__*/React__default.createElement(AnimatePresence, null, includeOverlay && /*#__PURE__*/React__default.createElement(motion.div, {
     variants: overlayVariants,
     initial: "hidden",
     animate: "visible",
@@ -495,7 +465,8 @@ SidePanel.propTypes = {
    *
    * See https://react.carbondesignsystem.com/?path=/docs/components-button--default#component-api
    */
-  actions: allPropTypes([ActionSet.validateActions(), PropTypes.arrayOf(PropTypes.shape(_objectSpread2(_objectSpread2({}, Button.propTypes), {}, {
+  actions: allPropTypes([/**@ts-ignore*/
+  ActionSet.validateActions(), PropTypes.arrayOf(PropTypes.shape(_objectSpread2(_objectSpread2({}, Button.propTypes), {}, {
     kind: PropTypes.oneOf(['ghost', 'danger--ghost', 'secondary', 'danger', 'primary']),
     tooltipPosition: PropTypes.oneOf(['top', 'right', 'bottom', 'left']),
     tooltipAlignment: PropTypes.oneOf(['start', 'center', 'end']),
@@ -574,22 +545,26 @@ 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.
    */
-  selectorPageContent: PropTypes.string.isRequired.if(function (_ref7) {
-    var slideIn = _ref7.slideIn;
+  /**@ts-ignore*/
+  selectorPageContent: PropTypes.string.isRequired.if(function (_ref6) {
+    var slideIn = _ref6.slideIn;
     return slideIn;
   }),
   /**
    * Specify a CSS selector that matches the DOM element that should
    * be focused when the side panel opens
    */
+  /**@ts-ignore*/
   selectorPrimaryFocus: PropTypes.string,
   /**
    * Sets the size of the side panel
    */
+  /**@ts-ignore*/
   size: PropTypes.oneOf(['xs', 'sm', 'md', 'lg', '2xl']),
   /**
    * Determines if this panel slides in
    */
+  /**@ts-ignore*/
   slideIn: PropTypes.bool,
   /**
    *  **Experimental:** Provide a `Slug` component to be rendered inside the `SidePanel` component
@@ -602,8 +577,9 @@ SidePanel.propTypes = {
   /**
    * Sets the title text
    */
-  title: PropTypes.string.isRequired.if(function (_ref8) {
-    var labelText = _ref8.labelText;
+  /**@ts-ignore*/
+  title: PropTypes.string.isRequired.if(function (_ref7) {
+    var labelText = _ref7.labelText;
     return labelText;
   })
 };

package/es/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 {};