@carbon/ibm-products 2.43.2-canary.22 → 2.43.2-canary.222

package/es/components/PageHeader/PageHeader.js

@@ -5,20 +5,20 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import { objectWithoutProperties as _objectWithoutProperties, slicedToArray as _slicedToArray, objectSpread2 as _objectSpread2, defineProperty as _defineProperty, extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import { objectSpread2 as _objectSpread2, objectWithoutProperties as _objectWithoutProperties, slicedToArray as _slicedToArray, defineProperty as _defineProperty, extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import { Button, Tooltip, Tag, usePrefix, FlexGrid, Row, Column } from '@carbon/react';
 import React__default, { useState, useRef, useEffect } from 'react';
-import PropTypes from '../../node_modules/prop-types/index.js';
+import { string_required_if_more_than_10_tags, TagSet } from '../TagSet/TagSet.js';
 import { breakpoints, spacing10, baseFontSize } from '@carbon/layout';
-import cx from 'classnames';
-import { useResizeObserver } from '../../global/js/hooks/useResizeObserver.js';
-import { FlexGrid, Row, Column, Button, Tooltip, Tag } from '@carbon/react';
-import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
+import { blockClass, utilSetCollapsed, utilGetBreadcrumbItemForTitle, utilCheckUpdateVerticalSpace } from './PageHeaderUtils.js';
 import { deprecateProp, prepareProps } from '../../global/js/utils/props-helper.js';
-import { pkg } from '../../settings.js';
-import { TagSet, string_required_if_more_than_10_tags } from '../TagSet/TagSet.js';
 import { ChevronUp } from '@carbon/react/icons';
-import { blockClass, utilSetCollapsed, utilGetBreadcrumbItemForTitle, utilCheckUpdateVerticalSpace } from './PageHeaderUtils.js';
 import { PageHeaderTitle } from './PageHeaderTitle.js';
+import PropTypes from '../../node_modules/prop-types/index.js';
+import cx from 'classnames';
+import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
+import { pkg } from '../../settings.js';
+import { useResizeObserver } from '../../global/js/hooks/useResizeObserver.js';
 import { useNearestScroll } from '../../global/js/hooks/useWindowScroll.js';
 import { useWindowResize } from '../../global/js/hooks/useWindowResize.js';
 import { BreadcrumbWithOverflow } from '../BreadcrumbWithOverflow/BreadcrumbWithOverflow.js';
@@ -27,6 +27,7 @@ import { ButtonSetWithOverflow } from '../ButtonSetWithOverflow/ButtonSetWithOve
 
 var _excluded = ["actionBarItems", "actionBarMenuOptionsClass", "actionBarOverflowAriaLabel", "allTagsModalSearchLabel", "allTagsModalSearchPlaceholderText", "allTagsModalTitle", "hasBackgroundAlways", "breadcrumbOverflowAriaLabel", "breadcrumbs", "children", "className", "collapseHeader", "collapseHeaderIconDescription", "collapseTitle", "disableBreadcrumbScroll", "enableBreadcrumbScroll", "expandHeaderIconDescription", "fullWidthGrid", "hasCollapseHeaderToggle", "narrowGrid", "navigation", "pageActions", "pageActionsOverflowLabel", "pageActionsMenuOptionsClass", "showAllTagsLabel", "subtitle", "tags", "title", "withoutBackground", "breadcrumbOverflowTooltipAlign"];
 var componentName = 'PageHeader';
+pkg._silenceWarnings(true);
 pkg.component.ActionBar = true;
 
 // Default values for props
@@ -92,6 +93,7 @@ var PageHeader = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
   var headerRef = ref || localHeaderRef;
   var sizingContainerRef = useRef(null);
   var offsetTopMeasuringRef = useRef(null);
+  var overflowMenuRef = useRef(null);
 
   // state based on props only
   var hasActionBar = actionBarItems && actionBarItems.length > 0;
@@ -165,14 +167,22 @@ var PageHeader = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
     _useState26 = _slicedToArray(_useState25, 2),
     widthIsNarrow = _useState26[0],
     setWidthIsNarrow = _useState26[1];
+  var prefix = usePrefix();
 
   // handlers
   var handleActionBarWidthChange = function handleActionBarWidthChange(_ref2) {
+    var _overflowMenuRef$curr;
     var minWidth = _ref2.minWidth,
       maxWidth = _ref2.maxWidth;
+    var overflowMenuWidth = 0;
+    var overflowMenu = overflowMenuRef === null || overflowMenuRef === void 0 || (_overflowMenuRef$curr = overflowMenuRef.current) === null || _overflowMenuRef$curr === void 0 ? void 0 : _overflowMenuRef$curr.querySelector(".".concat(prefix, "--overflow-menu"));
+    if (overflowMenu) {
+      overflowMenuWidth = overflowMenu.offsetWidth;
+    }
+
     /* don't know how to test resize */
     /* istanbul ignore next */
-    setActionBarMaxWidth(maxWidth);
+    setActionBarMaxWidth(maxWidth + overflowMenuWidth);
     /* don't know how to test resize */
     /* istanbul ignore next */
     setActionBarMinWidth(minWidth);
@@ -390,6 +400,7 @@ var PageHeader = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
     menuOptionsClass: "".concat(cx(actionBarMenuOptionsClass, "".concat(blockClass, "__action-bar-menu-options"))),
     onWidthChange: handleActionBarWidthChange,
     overflowAriaLabel: actionBarOverflowAriaLabel,
+    overflowMenuRef: overflowMenuRef,
     rightAlign: true
   })) : widthIsNarrow && thePageActions(true, pageActionsInBreadcrumbRow))))) : null, !collapseTitle && (title || pageActions) ? /*#__PURE__*/React__default.createElement(Row, {
     className: cx("".concat(blockClass, "__title-row"), _defineProperty(_defineProperty(_defineProperty(_defineProperty({}, "".concat(blockClass, "__title-row--no-breadcrumb-row"), !hasBreadcrumbRow), "".concat(blockClass, "__title-row--under-action-bar"), hasActionBar || widthIsNarrow), "".concat(blockClass, "__title-row--has-page-actions"), !!pageActions), "".concat(blockClass, "__title-row--sticky"), !!pageActions && !actionBarItems && hasBreadcrumbRow))

package/es/components/PageHeader/PageHeaderUtils.js

@@ -72,7 +72,7 @@ var utilCheckUpdateVerticalSpace = function utilCheckUpdateVerticalSpace(headerR
 
     // The header offset calculation is either going to work out at 0 if we have no gap between scrolling container
     // top and the measuring ref top, or the difference between.
-    update.headerOffset = offsetMeasuringTop === 0 ? offsetMeasuringTop - scrollableContainerTop : 0;
+    update.headerOffset = offsetMeasuringTop !== 0 ? offsetMeasuringTop - scrollableContainerTop : 0;
 
     /* istanbul ignore next */
     update.breadcrumbRowHeight = breadcrumbRowEl ? breadcrumbRowEl.clientHeight : 0;
@@ -98,11 +98,6 @@ var utilCheckUpdateVerticalSpace = function utilCheckUpdateVerticalSpace(headerR
       // adjust top for sticky with navigation
       update.headerTopValue += update.navigationRowHeight;
     }
-    if (!hasActionBar && !widthIsNarrow) {
-      // Add difference between $spacing-08 and $spacing-07 to ensure space below breadcrumb is correct on scroll
-      // $spacing-07 is used as size for breadcrumb when no action bar otherwise $spacing-08
-      update.headerTopValue += 8;
-    }
     if (!enableBreadcrumbScroll || !navigation) {
       // adjust sticky top if no navigation or breadcrumb is to stay on screen
       update.headerTopValue += update.breadcrumbRowHeight;

package/es/components/PageHeader/index.d.ts

@@ -1 +1,2 @@
-export { PageHeader } from "./PageHeader";
+export { PageHeader } from './PageHeader';
+export type { PageHeaderProps } from './PageHeader';

package/es/components/ProductiveCard/ProductiveCard.d.ts

@@ -16,7 +16,7 @@ type overflowAction = {
 };
 type PlacementType = 'top' | 'bottom';
 type ClickZoneType = 'one' | 'two' | 'three';
-interface ProductiveCardProps extends PropsWithChildren {
+export interface ProductiveCardProps extends PropsWithChildren {
     /**
      * Icons that are displayed on card. Refer to design documentation for implementation guidelines. Note- href will supersede onClick
      */
@@ -110,6 +110,10 @@ interface ProductiveCardProps extends PropsWithChildren {
      * Determines title size
      */
     titleSize?: 'default' | 'large';
+    /**
+     * Tooltip icon description
+     */
+    iconDescription?: string;
 }
 export declare let ProductiveCard: React.ForwardRefExoticComponent<ProductiveCardProps & React.RefAttributes<HTMLDivElement>>;
 export {};

package/es/components/ProductiveCard/ProductiveCard.js

@@ -9,18 +9,20 @@ import { objectWithoutProperties as _objectWithoutProperties, extends as _extend
 import React__default, { forwardRef } from 'react';
 import PropTypes from '../../node_modules/prop-types/index.js';
 import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
-import { prepareProps } from '../../global/js/utils/props-helper.js';
 import { pkg } from '../../settings.js';
+import { prepareProps } from '../../global/js/utils/props-helper.js';
 import { Card } from '../Card/Card.js';
 
-var _excluded = ["actionsPlacement"];
+var _excluded = ["actionsPlacement", "iconDescription"];
 var componentName = 'ProductiveCard';
 var ProductiveCard = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var _ref$actionsPlacement = _ref.actionsPlacement,
     actionsPlacement = _ref$actionsPlacement === void 0 ? 'top' : _ref$actionsPlacement,
+    iconDescription = _ref.iconDescription,
     rest = _objectWithoutProperties(_ref, _excluded);
   var validProps = prepareProps(rest, ['media', 'mediaPosition', 'pictogram', 'primaryButtonClick', 'productive', 'secondaryButtonKind']);
   return /*#__PURE__*/React__default.createElement(Card, _extends({}, _objectSpread2(_objectSpread2({}, validProps), {}, {
+    iconDescription: iconDescription,
     actionsPlacement: actionsPlacement,
     ref: ref,
     productive: true
@@ -62,6 +64,10 @@ ProductiveCard.propTypes = {
    * Optional header description
    */
   description: PropTypes.oneOfType([PropTypes.string, PropTypes.object, PropTypes.node]),
+  /**
+   * Tooltip icon description
+   */
+  iconDescription: PropTypes.string,
   /**
    * Optional label for the top of the card
    */

package/es/components/ProductiveCard/index.d.ts

@@ -1 +1,2 @@
-export { ProductiveCard } from "./ProductiveCard";
+export { ProductiveCard } from './ProductiveCard';
+export type { ProductiveCardProps } from './ProductiveCard';

package/es/components/RemoveModal/RemoveModal.d.ts

@@ -1,11 +1,11 @@
 /// <reference path="../../../src/custom-typings/index.d.ts" />
-import React, { ReactNode } from 'react';
 import { ComposedModal } from '@carbon/react';
-interface RemoveModalProps extends React.ComponentProps<typeof ComposedModal> {
+import React, { ReactNode } from 'react';
+export interface RemoveModalProps extends React.ComponentProps<typeof ComposedModal> {
     /**
      * The content to be displayed in the body of the modal
      */
-    body: string;
+    body: ReactNode;
     /**
      * Optional classname
      */
@@ -58,6 +58,10 @@ interface RemoveModalProps extends React.ComponentProps<typeof ComposedModal> {
      * Specify the text for the primary button
      */
     primaryButtonText?: string;
+    /**
+     * Specify the danger description on the primary button
+     */
+    primaryDangerDescription?: string;
     /**
      * The name of the resource being acted upon
      */
@@ -78,4 +82,3 @@ interface RemoveModalProps extends React.ComponentProps<typeof ComposedModal> {
 export declare let RemoveModal: React.ForwardRefExoticComponent<RemoveModalProps & {
     children?: React.ReactNode;
 } & React.RefAttributes<unknown>>;
-export {};

package/es/components/RemoveModal/RemoveModal.js

@@ -6,17 +6,17 @@
  */
 
 import { objectWithoutProperties as _objectWithoutProperties, slicedToArray as _slicedToArray, extends as _extends, objectSpread2 as _objectSpread2 } from '../../_virtual/_rollupPluginBabelHelpers.js';
-import React__default, { forwardRef, useState, useRef, useEffect } from 'react';
-import cx from 'classnames';
 import { ComposedModal, ModalHeader, ModalBody, TextInput, ModalFooter, Button } from '@carbon/react';
+import React__default, { forwardRef, useState, useRef, useEffect } from 'react';
 import PropTypes from '../../node_modules/prop-types/index.js';
+import cx from 'classnames';
 import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
-import uuidv4 from '../../global/js/utils/uuidv4.js';
 import { pkg } from '../../settings.js';
 import { usePortalTarget } from '../../global/js/hooks/usePortalTarget.js';
+import uuidv4 from '../../global/js/utils/uuidv4.js';
 import { usePreviousValue } from '../../global/js/hooks/usePreviousValue.js';
 
-var _excluded = ["body", "className", "iconDescription", "inputInvalidText", "inputLabelText", "inputPlaceholderText", "label", "onClose", "onRequestSubmit", "open", "portalTarget", "preventCloseOnClickOutside", "primaryButtonDisabled", "primaryButtonText", "resourceName", "secondaryButtonText", "textConfirmation", "title"];
+var _excluded = ["body", "className", "iconDescription", "inputInvalidText", "inputLabelText", "inputPlaceholderText", "label", "onClose", "onRequestSubmit", "open", "portalTarget", "preventCloseOnClickOutside", "primaryButtonDisabled", "primaryButtonText", "primaryDangerDescription", "resourceName", "secondaryButtonText", "textConfirmation", "title"];
 var componentName = 'RemoveModal';
 
 /**
@@ -40,6 +40,7 @@ var RemoveModal = /*#__PURE__*/forwardRef(function (_ref, ref) {
     preventCloseOnClickOutside = _ref.preventCloseOnClickOutside,
     primaryButtonDisabled = _ref.primaryButtonDisabled,
     primaryButtonText = _ref.primaryButtonText,
+    primaryDangerDescription = _ref.primaryDangerDescription,
     resourceName = _ref.resourceName,
     secondaryButtonText = _ref.secondaryButtonText,
     textConfirmation = _ref.textConfirmation,
@@ -90,9 +91,9 @@ var RemoveModal = /*#__PURE__*/forwardRef(function (_ref, ref) {
     title: title,
     label: label,
     iconDescription: iconDescription
-  }), /*#__PURE__*/React__default.createElement(ModalBody, null, /*#__PURE__*/React__default.createElement("p", {
+  }), /*#__PURE__*/React__default.createElement(ModalBody, null, typeof body === 'string' ? /*#__PURE__*/React__default.createElement("p", {
     className: "".concat(blockClass, "__body")
-  }, body), textConfirmation && /*#__PURE__*/React__default.createElement(TextInput, {
+  }, body) : body, textConfirmation && /*#__PURE__*/React__default.createElement(TextInput, {
     id: "".concat(idRef.current, "-confirmation-input"),
     className: "".concat(blockClass, "__input"),
     invalidText: inputInvalidText,
@@ -109,6 +110,7 @@ var RemoveModal = /*#__PURE__*/forwardRef(function (_ref, ref) {
   }, secondaryButtonText), /*#__PURE__*/React__default.createElement(Button, {
     type: "submit",
     kind: "danger",
+    dangerDescription: primaryDangerDescription,
     onClick: onRequestSubmit,
     disabled: primaryButtonStatus
   }, primaryButtonText))));
@@ -120,7 +122,7 @@ RemoveModal.propTypes = {
   /**
    * The content to be displayed in the body of the modal
    */
-  body: PropTypes.string.isRequired,
+  body: PropTypes.node.isRequired,
   /**
    * Optional classname
    */
@@ -173,6 +175,10 @@ RemoveModal.propTypes = {
    * Specify the text for the primary button
    */
   primaryButtonText: PropTypes.string,
+  /**
+   * Specify the danger description on the primary button
+   */
+  primaryDangerDescription: PropTypes.string,
   /**
    * The name of the resource being acted upon
    */

package/es/components/RemoveModal/index.d.ts

@@ -1 +1,2 @@
-export { RemoveModal } from "./RemoveModal";
+export { RemoveModal } from './RemoveModal';
+export type { RemoveModalProps } from './RemoveModal';

package/es/components/Saving/Saving.d.ts

@@ -7,7 +7,7 @@
 import React from 'react';
 type Type = 'manual' | 'auto';
 type Status = 'default' | 'in-progress' | 'success' | 'fail';
-interface SavingProps {
+export interface SavingProps {
     /**
      * Provide an optional class to be applied to the containing node.
      */

package/es/components/Saving/Saving.js

@@ -6,11 +6,11 @@
  */
 
 import { objectWithoutProperties as _objectWithoutProperties, defineProperty as _defineProperty, extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
-import React__default, { forwardRef } from 'react';
-import cx from 'classnames';
 import { InlineLoading, Button } from '@carbon/react';
-import { Save, CheckmarkOutline, ErrorFilled, ErrorOutline } from '@carbon/react/icons';
+import { ErrorOutline, Save, CheckmarkOutline, ErrorFilled } from '@carbon/react/icons';
+import React__default, { forwardRef } from 'react';
 import PropTypes from '../../node_modules/prop-types/index.js';
+import cx from 'classnames';
 import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
 import { pkg } from '../../settings.js';
 

package/es/components/Saving/index.d.ts

@@ -1 +1,2 @@
-export { Saving } from "./Saving";
+export { Saving } from './Saving';
+export type { SavingProps } from './Saving';

package/es/components/SearchBar/SearchBar.d.ts

@@ -7,7 +7,7 @@
 import React, { PropsWithChildren } from 'react';
 import PropTypes from 'prop-types';
 type Scopes = string[] | object[];
-interface SearchBarProps extends PropsWithChildren {
+export interface SearchBarProps extends PropsWithChildren {
     /** @type {string} Optional additional class name. */
     className?: string;
     /** @type {string} The label text for the search text input. */
@@ -17,7 +17,7 @@ interface SearchBarProps extends PropsWithChildren {
      */
     hideScopesLabel?: boolean;
     /** @type {string} The label text for the search text input. */
-    labelText?: string;
+    labelText: string;
     /** @type {Function} Function handler for when the user changes their query search. */
     onChange?: (event: any) => void;
     /** @type {Function} Function handler for when the user submits a search. */

package/es/components/SearchBar/SearchBar.js

@@ -5,13 +5,13 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import { objectWithoutProperties as _objectWithoutProperties, slicedToArray as _slicedToArray, extends as _extends, defineProperty as _defineProperty, objectSpread2 as _objectSpread2 } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import { objectSpread2 as _objectSpread2, objectWithoutProperties as _objectWithoutProperties, slicedToArray as _slicedToArray, extends as _extends, defineProperty as _defineProperty } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import { MultiSelect, Search, Button } from '@carbon/react';
 import React__default, { useState, useEffect } from 'react';
 import PropTypes from '../../node_modules/prop-types/index.js';
 import cx from 'classnames';
 import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
 import { pkg } from '../../settings.js';
-import { MultiSelect, Search, Button } from '@carbon/react';
 
 var _excluded = ["className", "clearButtonLabelText", "hideScopesLabel", "labelText", "onChange", "onSubmit", "placeholderText", "scopes", "scopesTypeLabel", "scopeToString", "selectedScopes", "sortItems", "submitLabel", "translateWithId", "value"];
 
@@ -135,7 +135,7 @@ var SearchBar = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
   })) : null, /*#__PURE__*/React__default.createElement(Search, {
     className: "".concat(blockClass, "__input"),
     closeButtonLabelText: clearButtonLabelText,
-    labelText: labelText || '',
+    labelText: labelText,
     name: "search-input",
     onChange: handleInputChange,
     placeholder: placeholderText,
@@ -188,7 +188,7 @@ SearchBar.propTypes = _objectSpread2({
    */
   hideScopesLabel: PropTypes.bool,
   /** @type {string} The label text for the search text input. */
-  labelText: PropTypes.string,
+  labelText: PropTypes.string.isRequired,
   /** @type {Function} Function handler for when the user changes their query search. */
   onChange: PropTypes.func,
   /** @type {Function} Function handler for when the user submits a search. */

package/es/components/SearchBar/index.d.ts

@@ -1 +1,8 @@
-export { SearchBar } from "./SearchBar";
+/**
+ * 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.
+ */
+export { SearchBar } from './SearchBar';
+export type { SearchBarProps } from './SearchBar';

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

@@ -143,7 +143,7 @@ type SidePanelSlideInProps = {
      */
     selectorPageContent: string;
 };
-type SidePanelProps = SidePanelBaseProps & SidePanelSlideInProps;
+export 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.
  */

package/es/components/SidePanel/SidePanel.js

@@ -5,23 +5,24 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import { objectWithoutProperties as _objectWithoutProperties, slicedToArray as _slicedToArray, defineProperty as _defineProperty, extends as _extends, objectSpread2 as _objectSpread2 } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import { objectSpread2 as _objectSpread2, objectWithoutProperties as _objectWithoutProperties, slicedToArray as _slicedToArray, defineProperty as _defineProperty, extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import { motion, AnimatePresence } from 'framer-motion';
+import { ArrowLeft, Close } from '@carbon/react/icons';
+import { Button, IconButton } from '@carbon/react';
 import React__default, { useState, useRef, useEffect, useCallback } from 'react';
-import { motion, useReducedMotion, AnimatePresence } from 'framer-motion';
+import { actionSetVariants, overlayVariants, panelVariants } from './motion/variants.js';
+import { ActionSet } from '../ActionSet/ActionSet.js';
 import PropTypes from '../../node_modules/prop-types/index.js';
+import { SIDE_PANEL_SIZES } from './constants.js';
+import { allPropTypes } from '../../global/js/utils/props-helper.js';
 import cx from 'classnames';
-import { moderate02 } from '@carbon/motion';
 import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
-import { allPropTypes } from '../../global/js/utils/props-helper.js';
-import { pkg } from '../../settings.js';
-import { SIDE_PANEL_SIZES } from './constants.js';
-import { Button, IconButton } from '@carbon/react';
-import { ArrowLeft, Close } from '@carbon/react/icons';
-import { actionSetVariants, overlayVariants, panelVariants } from './motion/variants.js';
+import { moderate02 } from '@carbon/motion';
 import pconsole from '../../global/js/utils/pconsole.js';
-import { ActionSet } from '../ActionSet/ActionSet.js';
+import { pkg } from '../../settings.js';
+import usePrefersReducedMotion from '../../global/js/hooks/usePrefersReducedMotion.js';
+import { useFocus, getSpecificElement } from '../../global/js/hooks/useFocus.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", "launcherButtonRef"],
   _excluded2 = ["label", "kind", "hasIconOnly", "icon", "renderIcon", "tooltipPosition", "tooltipAlignment", "leading", "disabled", "className", "onClick"];
@@ -44,7 +45,6 @@ var defaults = {
  * Side panels keep users in-context of a page while performing tasks like navigating, editing, viewing details, or configuring something new.
  */
 var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
-  var _window;
   var actionToolbarButtons = _ref.actionToolbarButtons,
     actions = _ref.actions,
     _ref$animateTitle = _ref.animateTitle,
@@ -111,13 +111,18 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
     keyDownListener = _useFocus.keyDownListener;
   var panelRefValue = sidePanelRef.current;
   var previousOpen = usePreviousValue(open);
-  var shouldReduceMotion = useReducedMotion();
+  var shouldReduceMotion = usePrefersReducedMotion();
 
   // Title animation on scroll related state
   var _useState7 = useState(0),
     _useState8 = _slicedToArray(_useState7, 2),
     labelTextHeight = _useState8[0],
     setLabelTextHeight = _useState8[1];
+  var handleEscapeKey = function handleEscapeKey(event) {
+    if (event.key === 'Escape' && open) {
+      onRequestClose === null || onRequestClose === void 0 || onRequestClose();
+    }
+  };
   useEffect(function () {
     if (open && !(titleRef !== null && titleRef !== void 0 && titleRef.current)) {
       setDoAnimateTitle(false);
@@ -154,9 +159,6 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
       titleItemsStyles(animationProgress);
     }
   }, [doAnimateTitle, panelRefValue === null || panelRefValue === void 0 ? void 0 : panelRefValue.style, scrollAnimationDistance, titleItemsStyles]);
-  var reducedMotion = typeof document !== '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 () {
@@ -193,7 +195,7 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
   }, [launcherButtonRef, open, previousOpen]);
   var checkSetDoAnimateTitle = function checkSetDoAnimateTitle() {
     var canDoAnimateTitle = false;
-    if (panelRefValue && 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 && !shouldReduceMotion) {
       var _labelTextRef$current3, _labelTextRef$current4, _subtitleRef$current$, _subtitleRef$current;
       var titleEl = titleRef.current;
       var labelHeight = (_labelTextRef$current3 = labelTextRef === null || labelTextRef === void 0 || (_labelTextRef$current4 = labelTextRef.current) === null || _labelTextRef$current4 === void 0 ? void 0 : _labelTextRef$current4.offsetHeight) !== null && _labelTextRef$current3 !== void 0 ? _labelTextRef$current3 : 0;
@@ -209,8 +211,8 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
       panelRefValue === null || panelRefValue === void 0 || panelRefValue.style.setProperty("--".concat(blockClass, "--scroll-animation-distance"), _scrollAnimationDistance.toString());
       var scrollEl = innerContentRef.current;
       if (scrollEl) {
-        var _window2;
-        var innerComputed = (_window2 = window) === null || _window2 === void 0 ? void 0 : _window2.getComputedStyle(innerContentRef.current);
+        var _window;
+        var innerComputed = (_window = window) === null || _window === void 0 ? void 0 : _window.getComputedStyle(innerContentRef.current);
         var innerPaddingHeight = innerComputed ? parseFloat(innerComputed === null || innerComputed === void 0 ? void 0 : innerComputed.paddingTop) + parseFloat(innerComputed === null || innerComputed === void 0 ? void 0 : innerComputed.paddingBottom) : 0;
         canDoAnimateTitle = (!!labelText || !!actionToolbarButtons || !!subtitle) && scrollEl.scrollHeight - scrollEl.clientHeight >= _scrollAnimationDistance + innerPaddingHeight;
       }
@@ -228,12 +230,12 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
 
   // Calculate scroll distances
   useEffect(function () {
-    if (panelRefValue && 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 && !shouldReduceMotion) {
       checkSetDoAnimateTitle();
     }
 
     // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [open, doAnimateTitle /* use do instead of animateTitle directly */, animationComplete, handleScroll, title, size, reducedMotion.matches, id]);
+  }, [open, doAnimateTitle /* use do instead of animateTitle directly */, animationComplete, handleScroll, title, size, shouldReduceMotion, id]);
 
   // click outside functionality if `includeOverlay` prop is set
   useEffect(function () {
@@ -269,10 +271,10 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
   // Set the internal state `animationComplete` to true if
   // prefers reduced motion is true
   useEffect(function () {
-    if (reducedMotion.matches) {
+    if (shouldReduceMotion) {
       setAnimationComplete(true);
     }
-  }, [reducedMotion.matches]);
+  }, [shouldReduceMotion]);
 
   // initializes the side panel to open
   var onAnimationStart = function onAnimationStart() {
@@ -291,10 +293,10 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
     }
   }, [open, placement, selectorPageContent, slideIn]);
   useEffect(function () {
-    if (!open && previousState && previousState['open'] && reducedMotion.matches) {
+    if (!open && previousState && previousState['open'] && shouldReduceMotion) {
       onUnmount === null || onUnmount === void 0 || onUnmount();
     }
-  }, [open, onUnmount, reducedMotion.matches, previousState]);
+  }, [open, onUnmount, shouldReduceMotion, previousState]);
 
   // used to set margins of content for slide in panel version
   useEffect(function () {
@@ -307,22 +309,22 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
       }
       if (placement && placement === 'right' && pageContentElement) {
         pageContentElement.style.marginInlineEnd = '0';
-        pageContentElement.style.transition = !reducedMotion.matches ? "margin-inline-end ".concat(moderate02) : '';
+        pageContentElement.style.transition = !shouldReduceMotion ? "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) : '';
+        pageContentElement.style.transition = !shouldReduceMotion ? "margin-inline-start ".concat(moderate02) : '';
         pageContentElement.style.marginInlineStart = SIDE_PANEL_SIZES[size];
       }
     }
-  }, [slideIn, selectorPageContent, placement, size, reducedMotion.matches, open]);
+  }, [slideIn, selectorPageContent, placement, size, shouldReduceMotion, open]);
   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) {
+        if (selectorPrimaryFocus && getSpecificElement(sidePanelRef === null || sidePanelRef === void 0 ? void 0 : sidePanelRef.current, selectorPrimaryFocus)) {
+          var _window2;
+          var primeFocusEl = getSpecificElement(sidePanelRef === null || sidePanelRef === void 0 ? void 0 : sidePanelRef.current, selectorPrimaryFocus);
+          if (primeFocusEl && ((_window2 = window) === null || _window2 === void 0 || (_window2 = _window2.getComputedStyle(primeFocusEl)) === null || _window2 === void 0 ? void 0 : _window2.display) !== 'none') {
             primeFocusEl === null || primeFocusEl === void 0 || primeFocusEl.focus();
           }
         } else if (!slideIn) {
@@ -330,7 +332,7 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
         }
       }, 0);
     }
-  }, [animationComplete, firstElement, open, selectorPrimaryFocus, slideIn]);
+  }, [animationComplete, firstElement, open, selectorPrimaryFocus, sidePanelRef, slideIn]);
   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({}, "".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, "--has-overlay"), includeOverlay)]);
   var renderTitle = function renderTitle() {
@@ -341,7 +343,7 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
       className: "".concat(blockClass, "__title-text"),
       title: title,
       "aria-hidden": false
-    }, title), doAnimateTitle && !reducedMotion.matches && /*#__PURE__*/React__default.createElement("h2", {
+    }, title), doAnimateTitle && !shouldReduceMotion && /*#__PURE__*/React__default.createElement("h2", {
       className: "".concat(blockClass, "__collapsed-title-text"),
       title: title,
       "aria-hidden": true
@@ -358,10 +360,9 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
       });
     }
     return /*#__PURE__*/React__default.createElement("div", {
-      className: cx("".concat(blockClass, "__header"), _defineProperty(_defineProperty(_defineProperty(_defineProperty({}, "".concat(blockClass, "__header--on-detail-step"), currentStep > 0), "".concat(blockClass, "__header--no-title-animation"), !animateTitle), "".concat(blockClass, "__header--reduced-motion"), reducedMotion.matches), "".concat(blockClass, "__header--has-title"), title)),
+      className: cx("".concat(blockClass, "__header"), _defineProperty(_defineProperty(_defineProperty(_defineProperty({}, "".concat(blockClass, "__header--on-detail-step"), currentStep > 0), "".concat(blockClass, "__header--no-title-animation"), !animateTitle), "".concat(blockClass, "__header--reduced-motion"), shouldReduceMotion), "".concat(blockClass, "__header--has-title"), title)),
       ref: headerRef
     }, currentStep > 0 && /*#__PURE__*/React__default.createElement(Button, {
-      "aria-label": navigationBackIconDescription,
       kind: "ghost",
       size: slugCloseSize,
       disabled: false,
@@ -382,6 +383,7 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
       className: "".concat(blockClass, "__close-button"),
       label: closeIconDescription,
       onClick: onRequestClose,
+      onKeyDown: slideIn ? undefined : handleEscapeKey,
       title: closeIconDescription,
       "aria-label": closeIconDescription,
       ref: closeRef,
@@ -434,6 +436,12 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
       className: cx("".concat(blockClass, "__inner-content"), "".concat(blockClass, "--scrolls"), "".concat(!doAnimateTitle ? "".concat(blockClass, "__inner-content--no-animated-title") : ''))
     }, children);
   };
+  var handleKeyDown = function handleKeyDown(event) {
+    if (!slideIn) {
+      handleEscapeKey(event);
+      keyDownListener(event);
+    }
+  };
   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,
@@ -450,7 +458,7 @@ var SidePanel = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
       placement: placement,
       shouldReduceMotion: shouldReduceMotion
     },
-    onKeyDown: slideIn ? undefined : keyDownListener
+    onKeyDown: handleKeyDown
   }), /*#__PURE__*/React__default.createElement(React__default.Fragment, null, renderHeader(), renderMain()), /*#__PURE__*/React__default.createElement(MotionActionSet, {
     actions: actions !== null && actions !== void 0 ? actions : [],
     className: primaryActionContainerClassNames,

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

@@ -1 +1,8 @@
-export { SidePanel } from "./SidePanel";
+/**
+ * Copyright IBM Corp. 2020, 2021
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export { SidePanel } from './SidePanel';
+export type { SidePanelProps } from './SidePanel';