@carbon/ibm-products 1.61.0 → 1.62.0

package/es/global/js/hooks/index.js

@@ -1,5 +1,5 @@
 /**
- * Copyright IBM Corp. 2020, 2021
+ * Copyright IBM Corp. 2020, 2023
  *
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
@@ -15,4 +15,5 @@ export { usePreviousValue } from './usePreviousValue';
 export { useResetCreateComponent } from './useResetCreateComponent';
 export { useRetrieveStepData } from './useRetrieveStepData';
 export { useValidCreateStepCount } from './useValidCreateStepCount';
-export { useControllableState } from './useControllableState';
+export { useControllableState } from './useControllableState';
+export { usePrefix } from './usePrefix';

package/es/global/js/hooks/usePrefix.js

@@ -0,0 +1,11 @@
+/**
+ * Copyright IBM Corp. 2023, 2023
+ *
+ * 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 pkg from '../package-settings';
+export var usePrefix = function usePrefix() {
+  return pkg.prefix;
+};

package/es/global/js/package-settings.js

@@ -25,6 +25,7 @@ var defaults = {
     CreateTearsheet: true,
     CreateTearsheetStep: true,
     CreateTearsheetDivider: true,
+    Datagrid: true,
     EditInPlace: true,
     EmptyState: true,
     ErrorEmptyState: true,
@@ -65,7 +66,6 @@ var defaults = {
     EditSidePanel: false,
     CancelableTextEdit: false,
     DataSpreadsheet: false,
-    Datagrid: false,
     EditTearsheet: false,
     EditTearsheetNarrow: false,
     EditFullPage: false,
@@ -73,7 +73,12 @@ var defaults = {
     ButtonMenu: false,
     // Novice to pro components not yet reviewed and released:
     InlineTip: false,
+    InlineTipButton: false,
+    InlineTipLink: false,
     Guidebanner: false,
+    GuidebannerElement: false,
+    GuidebannerElementButton: false,
+    GuidebannerElementLink: false,
     NonLinearReading: false,
     Checklist: false,
     Coachmark: false,
@@ -93,7 +98,6 @@ var defaults = {
     'Datagrid.useExpandedRow': false,
     'Datagrid.useNestedRows': false,
     'Datagrid.useInlineEdit': false,
-    'Datagrid.useActionsColumn': false,
     'Datagrid.useFiltering': false,
     'Datagrid.useCustomizeColumns': false,
     'ExampleComponent.secondaryIcon': false,

package/lib/components/Coachmark/Coachmark.js

@@ -25,6 +25,7 @@ function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "functio
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(_settings.pkg.prefix, "--coachmark");
+var overlayBlockClass = "".concat(blockClass, "-overlay");
 var componentName = 'Coachmark';
 var defaults = {
   align: 'bottom',
@@ -86,7 +87,18 @@ var Coachmark = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
   var closeOverlay = function closeOverlay() {
     setIsOpen(false);
   };
-  var handleClose = function handleClose() {
+  var escFunction = (0, _react.useCallback)(function (event) {
+    if (event.key === 'Escape') {
+      handleClose();
+    }
+  }, [handleClose]);
+  (0, _react.useEffect)(function () {
+    document.addEventListener('keydown', escFunction, false);
+    return function () {
+      document.removeEventListener('keydown', escFunction, false);
+    };
+  }, [escFunction]);
+  var handleClose = (0, _react.useCallback)(function () {
     if (isStacked) {
       // If stacked, do not unmount,
       // only call its ("parent") onClose method.
@@ -95,7 +107,7 @@ var Coachmark = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
       setIsOpen(false);
       onClose();
     }
-  };
+  }, [isStacked, onClose]);
   var handleTargetClick = function handleTargetClick(e) {
     setTargetRect(e.target.getBoundingClientRect());
     setTargetOffset({
@@ -116,6 +128,7 @@ var Coachmark = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
   var contextValue = {
     buttonProps: {
       'aria-expanded': isOpen,
+      tabIndex: 0,
       onClick: handleTargetClick,
       // Compensate for accidental open/close on double-click.
       // Only open on double-click.
@@ -167,7 +180,7 @@ var Coachmark = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
     kind: overlayKind,
     onClose: handleClose,
     theme: theme,
-    className: overlayClassName
+    className: (0, _classnames.default)(overlayClassName, "".concat(overlayBlockClass, "--is-visible"))
   }, children), portalNode)));
 });
 
@@ -189,7 +202,6 @@ Coachmark.propTypes = {
    * @see COACHMARK_ALIGNMENT
    */
   align: _propTypes.default.oneOf(['bottom', 'bottom-left', 'bottom-right', 'left', 'left-top', 'left-bottom', 'right', 'right-top', 'right-bottom', 'top', 'top-left', 'top-right']),
-  // TODO: UPDATE COMMENT HERE - UPDATE MDX TO HAVE DIRECTION TO USE ONLY OVERLAY ELEMENTS>...
   /**
    * Coachmark should use a single CoachmarkOverlayElements component as a child.
    * @see CoachmarkOverlayElements

package/lib/components/Coachmark/CoachmarkDragbar.js

@@ -16,7 +16,7 @@ var _iconsReact = require("@carbon/icons-react");
 var _carbonComponentsReact = require("carbon-components-react");
 var _devtools = require("../../global/js/utils/devtools");
 var _settings = require("../../settings");
-var _excluded = ["closeIconDescription", "onClose", "onDrag", "showCloseButton", "theme"];
+var _excluded = ["a11yKeyboardHandler", "closeIconDescription", "onClose", "onDrag", "showCloseButton", "theme"];
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 // Carbon and package components we use.
@@ -24,6 +24,7 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
 
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(_settings.pkg.prefix, "--coachmark-dragbar");
+var overlayBlockClass = "".concat(_settings.pkg.prefix, "--coachmark-overlay");
 var componentName = 'CoachmarkDragbar';
 var defaults = {
   closeIconDescription: 'Close',
@@ -38,7 +39,8 @@ var defaults = {
  * of other Novice to Pro components.
  */
 var CoachmarkDragbar = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
-  var _ref$closeIconDescrip = _ref.closeIconDescription,
+  var a11yKeyboardHandler = _ref.a11yKeyboardHandler,
+    _ref$closeIconDescrip = _ref.closeIconDescription,
     closeIconDescription = _ref$closeIconDescrip === void 0 ? defaults.closeIconDescription : _ref$closeIconDescrip,
     _ref$onClose = _ref.onClose,
     onClose = _ref$onClose === void 0 ? defaults.onClose : _ref$onClose,
@@ -88,15 +90,16 @@ var CoachmarkDragbar = /*#__PURE__*/_react.default.forwardRef(function (_ref, re
     // role="main"
   }, (0, _devtools.getDevtoolsProps)(componentName)), /*#__PURE__*/_react.default.createElement("button", {
     type: "button",
-    className: "".concat(blockClass, "__handle"),
-    onMouseDown: handleDragStart
+    className: "".concat(overlayBlockClass, "__handle"),
+    onMouseDown: handleDragStart,
+    onKeyDown: a11yKeyboardHandler
   }, /*#__PURE__*/_react.default.createElement(_iconsReact.Draggable16, null)), showCloseButton && /*#__PURE__*/_react.default.createElement(_carbonComponentsReact.Button, {
     kind: "ghost",
     size: "sm",
     renderIcon: _iconsReact.Close16,
     iconDescription: closeIconDescription,
     hasIconOnly: true,
-    className: "".concat(blockClass, "--close-btn"),
+    className: "".concat(overlayBlockClass, "--close-btn"),
     onClick: onClose
   }));
 });
@@ -113,6 +116,10 @@ CoachmarkDragbar.displayName = componentName;
 // in alphabetical order (for consistency).
 // See https://www.npmjs.com/package/prop-types#usage.
 CoachmarkDragbar.propTypes = {
+  /**
+   * Handler to manage keyboard interactions with the dragbar.
+   */
+  a11yKeyboardHandler: _propTypes.default.func.isRequired,
   /**
    * Tooltip text and aria label for the Close button icon.
    */

package/lib/components/Coachmark/CoachmarkHeader.js

@@ -17,6 +17,7 @@ var _settings = require("../../settings");
 var _excluded = ["closeIconDescription", "onClose", "showCloseButton", "theme"];
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(_settings.pkg.prefix, "--coachmark-header");
+var overlayBlockClass = "".concat(_settings.pkg.prefix, "--coachmark-overlay");
 var componentName = 'CoachmarkHeader';
 var defaults = {
   closeIconDescription: 'Close',
@@ -49,7 +50,7 @@ var CoachmarkHeader = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref
     renderIcon: _iconsReact.Close16,
     iconDescription: closeIconDescription,
     hasIconOnly: true,
-    className: "".concat(blockClass, "--close-btn"),
+    className: "".concat(overlayBlockClass, "--close-btn"),
     onClick: onClose
   }));
 });

package/lib/components/Coachmark/CoachmarkOverlay.js

@@ -7,8 +7,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.CoachmarkOverlay = void 0;
 var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
 var _react = _interopRequireWildcard(require("react"));
+var _uuidv = _interopRequireDefault(require("../../global/js/utils/uuidv4"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _classnames = _interopRequireDefault(require("classnames"));
 var _devtools = require("../../global/js/utils/devtools");
@@ -46,12 +48,46 @@ var CoachmarkOverlay = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref)
     _ref$theme = _ref.theme,
     theme = _ref$theme === void 0 ? defaults.theme : _ref$theme,
     rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  var _useWindowDimensions = useWindowDimensions(),
+    winHeight = _useWindowDimensions.winHeight,
+    winWidth = _useWindowDimensions.winWidth;
+  var _useState = (0, _react.useState)(false),
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    a11yDragMode = _useState2[0],
+    setA11yDragMode = _useState2[1];
   var overlayRef = (0, _react.useRef)();
   var coachmark = (0, _context.useCoachmark)();
   var isBeacon = kind === _enums.COACHMARK_OVERLAY_KIND.TOOLTIP;
   var isDraggable = kind === _enums.COACHMARK_OVERLAY_KIND.FLOATING;
+  var isVisible = className && className.includes('is-visible');
+  var handleKeyPress = function handleKeyPress(event) {
+    var shiftKey = event.shiftKey,
+      key = event.key;
+    if (key === 'Enter' || key === ' ') {
+      setA11yDragMode(function (prevVal) {
+        return !prevVal;
+      });
+    } else if (a11yDragMode) {
+      var distanceToMove = shiftKey ? 128 : 32;
+      switch (key) {
+        case 'ArrowLeft':
+          handleDrag(distanceToMove * -1, 0);
+          break;
+        case 'ArrowRight':
+          handleDrag(distanceToMove, 0);
+          break;
+        case 'ArrowUp':
+          handleDrag(0, distanceToMove * -1);
+          break;
+        case 'ArrowDown':
+          handleDrag(0, distanceToMove);
+          break;
+        default:
+          break;
+      }
+    }
+  };
   var styledTune = {};
-  // TODO: check this... this feels like it should be in a hook with no dep array.
   if (isBeacon || isDraggable) {
     if (coachmark.targetRect) {
       styledTune = {
@@ -70,36 +106,97 @@ var CoachmarkOverlay = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref)
       styledTune.top += offsetTune.top;
     }
   }
+  function handleDragBounds(x, y) {
+    var xRes = x;
+    var yRes = y;
+    var xMax = winWidth - 288;
+    var yMax = winHeight - 150;
+    if (xRes < 0) {
+      xRes = 0;
+    } else if (xRes > xMax) {
+      xRes = xMax;
+    }
+    if (yRes < 0) {
+      yRes = 0;
+    } else if (yRes > yMax) {
+      yRes = yMax;
+    }
+    return {
+      targetX: xRes,
+      targetY: yRes
+    };
+  }
   function handleDrag(movementX, movementY) {
     var overlay = overlayRef.current;
     var _overlay$getBoundingC = overlay.getBoundingClientRect(),
       x = _overlay$getBoundingC.x,
       y = _overlay$getBoundingC.y;
+    var _handleDragBounds = handleDragBounds(x + movementX, y + movementY),
+      targetX = _handleDragBounds.targetX,
+      targetY = _handleDragBounds.targetY;
     overlay.style.transform = 'none';
     overlay.style.position = 'fixed';
-    overlay.style.left = "".concat(x + movementX, "px");
-    overlay.style.top = "".concat(y + movementY, "px");
+    overlay.style.left = "".concat(targetX, "px");
+    overlay.style.top = "".concat(targetY, "px");
     overlay.style.bottom = 'auto';
   }
+  var contentId = (0, _uuidv.default)();
   return /*#__PURE__*/_react.default.createElement("div", (0, _extends2.default)({}, rest, {
-    className: (0, _classnames.default)(blockClass, "".concat(blockClass, "--").concat(kind), "".concat(blockClass, "__").concat(theme), (isBeacon || isDraggable) && "".concat(blockClass, "--").concat(coachmark.align), fixedIsVisible && "".concat(blockClass, "--is-visible"), className),
+    className: (0, _classnames.default)(blockClass, "".concat(blockClass, "--").concat(kind), "".concat(blockClass, "__").concat(theme), (isBeacon || isDraggable) && "".concat(blockClass, "--").concat(coachmark.align), fixedIsVisible && "".concat(blockClass, "--is-visible"), a11yDragMode && "".concat(blockClass, "--is-dragmode"), className),
     ref: overlayRef,
-    style: styledTune
+    style: styledTune,
+    "aria-labelledby": contentId,
+    tabIndex: -1
   }, (0, _devtools.getDevtoolsProps)(componentName)), isDraggable ? /*#__PURE__*/_react.default.createElement(_CoachmarkDragbar.CoachmarkDragbar, {
+    a11yKeyboardHandler: handleKeyPress,
+    onBlur: function onBlur() {
+      return setA11yDragMode(false);
+    },
     onDrag: handleDrag,
+    theme: theme,
     onClose: onClose
   }) : /*#__PURE__*/_react.default.createElement(_CoachmarkHeader.CoachmarkHeader, {
     onClose: onClose
   }), /*#__PURE__*/_react.default.createElement("div", {
     className: "".concat(blockClass, "__body"),
-    ref: ref
-  }, children), isBeacon && /*#__PURE__*/_react.default.createElement("span", {
+    ref: ref,
+    id: contentId
+  }, _react.default.Children.map(children, function (child) {
+    return /*#__PURE__*/_react.default.cloneElement(child, {
+      isVisible: isVisible
+    });
+  })), isBeacon && /*#__PURE__*/_react.default.createElement("span", {
     className: "".concat(blockClass, "__caret")
   }));
 });
+exports.CoachmarkOverlay = CoachmarkOverlay;
+function getWindowDimensions() {
+  var _window = window,
+    winWidth = _window.innerWidth,
+    winHeight = _window.innerHeight;
+  return {
+    winWidth: winWidth,
+    winHeight: winHeight
+  };
+}
+var useWindowDimensions = function useWindowDimensions() {
+  var _useState3 = (0, _react.useState)(getWindowDimensions()),
+    _useState4 = (0, _slicedToArray2.default)(_useState3, 2),
+    windowDimensions = _useState4[0],
+    setWindowDimensions = _useState4[1];
+  (0, _react.useEffect)(function () {
+    function handleResize() {
+      setWindowDimensions(getWindowDimensions());
+    }
+    window.addEventListener('resize', handleResize);
+    return function () {
+      return window.removeEventListener('resize', handleResize);
+    };
+  }, []);
+  return windowDimensions;
+};
 
 // Return a placeholder if not released and not enabled by feature flag
-exports.CoachmarkOverlay = CoachmarkOverlay;
 exports.CoachmarkOverlay = CoachmarkOverlay = _settings.pkg.checkComponentEnabled(CoachmarkOverlay, componentName);
 
 // The display name of the component, used by React. Note that displayName

package/lib/components/CoachmarkBeacon/CoachmarkBeacon.js

@@ -43,14 +43,17 @@ var CoachmarkBeacon = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref
     className: (0, _classnames.default)(blockClass, "".concat(blockClass, "-").concat(kind), className),
     ref: ref,
     style: overlayPositionStyle
-  }, (0, _devtools.getDevtoolsProps)(componentName)), /*#__PURE__*/_react.default.createElement("button", (0, _extends2.default)({
+  }, (0, _devtools.getDevtoolsProps)(componentName), {
+    role: "tooltip"
+  }), /*#__PURE__*/_react.default.createElement("button", (0, _extends2.default)({
     tabIndex: 0,
     type: "button"
   }, coachmark.buttonProps, {
     "aria-label": label,
     className: "".concat(blockClass, "__target")
   }), /*#__PURE__*/_react.default.createElement("svg", {
-    className: "".concat(blockClass, "__center")
+    className: "".concat(blockClass, "__center"),
+    alt: ""
   }, /*#__PURE__*/_react.default.createElement("circle", {
     r: 1,
     cx: 38,

package/lib/components/CoachmarkFixed/CoachmarkFixed.js

@@ -23,7 +23,9 @@ var _excluded = ["children", "className", "onClose", "portalTarget", "tagline",
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 // The block part of our conventional BEM class names (blockClass__E--M).
-var blockClass = "".concat(_settings.pkg.prefix, "--coachmark-fixed");
+var coachmarkClass = "".concat(_settings.pkg.prefix, "--coachmark");
+var blockClass = "".concat(coachmarkClass, "-fixed");
+var overlayBlockClass = "".concat(coachmarkClass, "-overlay");
 var componentName = 'CoachmarkFixed';
 var defaults = {
   onClose: function onClose() {},
@@ -74,9 +76,14 @@ var CoachmarkFixed = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref)
     _useState10 = (0, _slicedToArray2.default)(_useState9, 2),
     fixedIsVisible = _useState10[0],
     setFixedIsVisible = _useState10[1];
-  var handleClose = function handleClose() {
-    setFixedIsVisible(false);
-  };
+  var prefersReducedMotion = window.matchMedia('(prefers-reduced-motion: reduce)');
+  var handleClose = (0, _react.useCallback)(function () {
+    if (prefersReducedMotion.matches) {
+      setIsOpen(false);
+    } else {
+      setFixedIsVisible(false);
+    }
+  }, [prefersReducedMotion.matches]);
   var handleTransitionEnd = function handleTransitionEnd(e) {
     if (e.propertyName === 'transform' && !fixedIsVisible) {
       setIsOpen(false);
@@ -93,9 +100,21 @@ var CoachmarkFixed = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref)
     setIsOpen(false);
     setShouldResetPosition(true);
   };
+  var escFunction = (0, _react.useCallback)(function (event) {
+    if (event.key === 'Escape') {
+      handleClose();
+    }
+  }, [handleClose]);
+  (0, _react.useEffect)(function () {
+    document.addEventListener('keydown', escFunction, false);
+    return function () {
+      document.removeEventListener('keydown', escFunction, false);
+    };
+  }, [escFunction]);
   var contextValue = {
     buttonProps: {
       'aria-expanded': isOpen,
+      tabIndex: 0,
       onClick: handleTargetClick,
       // Compensate for accidental open/close on double-click.
       // Only open on double-click.
@@ -150,7 +169,8 @@ var CoachmarkFixed = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref)
     kind: _enums.COACHMARK_OVERLAY_KIND.FIXED,
     onClose: handleClose,
     onTransitionEnd: handleTransitionEnd,
-    theme: theme
+    theme: theme,
+    className: (0, _classnames.default)(fixedIsVisible && "".concat(overlayBlockClass, "--is-visible"), overlayBlockClass)
   }, children), portalNode)));
 });
 

package/lib/components/CoachmarkOverlayElements/CoachmarkOverlayElements.js

@@ -20,13 +20,14 @@ var _Carousel = require("../Carousel");
 var _SteppedAnimatedMedia = require("../SteppedAnimatedMedia");
 var _devtools = require("../../global/js/utils/devtools");
 var _settings = require("../../settings");
-var _excluded = ["className", "children", "media", "nextButtonText", "previousButtonLabel", "closeButtonLabel"];
+var _excluded = ["className", "children", "isVisible", "media", "nextButtonText", "previousButtonLabel", "closeButtonLabel"];
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(_settings.pkg.prefix, "--coachmark-overlay-elements");
 var componentName = 'CoachmarkOverlayElements';
 var defaults = {
+  isVisible: false,
   nextButtonText: 'Next',
   previousButtonLabel: 'Back',
   closeButtonLabel: 'Got it'
@@ -39,6 +40,8 @@ var defaults = {
 var CoachmarkOverlayElements = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
   var className = _ref.className,
     children = _ref.children,
+    _ref$isVisible = _ref.isVisible,
+    isVisible = _ref$isVisible === void 0 ? defaults.isVisible : _ref$isVisible,
     media = _ref.media,
     _ref$nextButtonText = _ref.nextButtonText,
     nextButtonText = _ref$nextButtonText === void 0 ? defaults.nextButtonText : _ref$nextButtonText,
@@ -56,8 +59,16 @@ var CoachmarkOverlayElements = /*#__PURE__*/_react.default.forwardRef(function (
   var _useState3 = (0, _react.useState)(0),
     _useState4 = (0, _slicedToArray2.default)(_useState3, 2),
     currentProgStep = _useState4[0],
-    setCurrentProgStep = _useState4[1];
+    _setCurrentProgStep = _useState4[1];
   var coachmark = (0, _Coachmark.useCoachmark)();
+  var setCurrentProgStep = function setCurrentProgStep(value) {
+    if (currentProgStep > 0 && value === 0 && buttonFocusRef.current) {
+      setTimeout(function () {
+        buttonFocusRef.current.focus();
+      }, 1000);
+    }
+    _setCurrentProgStep(value);
+  };
   var numProgSteps = _react.Children.count(children);
   var progStepFloor = 0;
   var progStepCeil = numProgSteps - 1;
@@ -68,6 +79,13 @@ var CoachmarkOverlayElements = /*#__PURE__*/_react.default.forwardRef(function (
       buttonFocusRef.current.focus();
     }
   }, []);
+  (0, _react.useEffect)(function () {
+    setTimeout(function () {
+      if (buttonFocusRef.current && isVisible) {
+        buttonFocusRef.current.focus();
+      }
+    }, 100);
+  }, [isVisible]);
   if (!coachmark) {
     return _pconsole.default.warn("The ".concat(componentName, " is a composable container element which should be used only within the scope of a Coachmark or a CoachmarkFixed component."));
   }
@@ -91,7 +109,9 @@ var CoachmarkOverlayElements = /*#__PURE__*/_react.default.forwardRef(function (
     className: (0, _classnames.default)("".concat(blockClass, "__footer"), 'coachmark-carousel-controls')
   }, /*#__PURE__*/_react.default.createElement(_carbonComponentsReact.Button, (0, _extends2.default)({
     size: "sm"
-  }, coachmark.closeButtonProps), closeButtonLabel))) : /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement(_Carousel.Carousel, {
+  }, coachmark.closeButtonProps, {
+    ref: buttonFocusRef
+  }), closeButtonLabel))) : /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement(_Carousel.Carousel, {
     disableArrowScroll: true,
     ref: scrollRef
   }, children), /*#__PURE__*/_react.default.createElement("div", {
@@ -155,6 +175,11 @@ CoachmarkOverlayElements.propTypes = {
    * The label for the Close button.
    */
   closeButtonLabel: _propTypes.default.string,
+  /**
+   * The visibility of CoachmarkOverlayElements is
+   * managed in the parent component.
+   */
+  isVisible: _propTypes.default.bool,
   /**
    * The object describing an image in one of two shapes.
    * If a single media element is required, use `{render}`.

package/lib/components/CoachmarkStack/CoachmarkStack.js

@@ -91,7 +91,18 @@ var CoachmarkStack = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref)
   var handleClickNavItem = function handleClickNavItem(itemNumber) {
     setSelectedItemNumber(itemNumber);
   };
-  var handleClose = function handleClose(isParentCloseButton) {
+  var escFunction = (0, _react.useCallback)(function (event) {
+    if (event.key === 'Escape') {
+      selectedItemNumber === 0 ? handleClose(true) : handleClose(false);
+    }
+  }, [handleClose, selectedItemNumber]);
+  (0, _react.useEffect)(function () {
+    document.addEventListener('keydown', escFunction, false);
+    return function () {
+      document.removeEventListener('keydown', escFunction, false);
+    };
+  }, [escFunction]);
+  var handleClose = (0, _react.useCallback)(function (isParentCloseButton) {
     if (isParentCloseButton) {
       // Trigger slide-out animation
       setSelectedItemNumber(-1);
@@ -108,9 +119,10 @@ var CoachmarkStack = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref)
       // Unstack child
       setSelectedItemNumber(0);
     }
-  };
+  }, [onClose]);
   var contextValue = {
     buttonProps: {
+      tabIndex: 0,
       'aria-expanded': isOpen,
       onClick: function onClick() {
         setIsOpen(true);
@@ -137,7 +149,7 @@ var CoachmarkStack = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref)
   (0, _react.useEffect)(function () {
     setTimeout(function () {
       if (stackHomeRef.current) {
-        setParentHeight(stackHomeRef.current.clientHeight);
+        setParentHeight(stackHomeRef.current.clientHeight + 16);
       }
     }, 0);
   }, [stackHomeRef]);
@@ -148,10 +160,12 @@ var CoachmarkStack = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref)
     }
     stackHomeRef.current.style.height = "".concat(parentHeight, "px");
     if (!isOpen || targetSelectedItem < 0) {
+      stackHomeRef.current.focus();
       return;
     }
     var targetHomeHeight = stackedCoachmarkRefs.current[targetSelectedItem].clientHeight;
     stackHomeRef.current.style.height = "".concat(targetHomeHeight, "px");
+    stackedCoachmarkRefs.current[targetSelectedItem].focus();
   }, [selectedItemNumber, isOpen, parentHeight]);
   var wrappedChildren = _react.Children.map(childArray, function (child, idx) {
     var mountedClass = mountedRef.current ? "".concat(elementBlockClass, "--is-mounted") : '';
@@ -180,6 +194,7 @@ var CoachmarkStack = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref)
   }), /*#__PURE__*/_react.default.createElement(_CoachmarkStackHome.CoachmarkStackHome, {
     ref: stackHomeRef,
     className: (0, _classnames.default)("".concat(_settings.pkg.prefix, "--coachmark-overlay"), "".concat(_settings.pkg.prefix, "--coachmark-overlay__").concat(theme), elementBlockClass, selectedItemNumber > 0 && "".concat(elementBlockClass, "--is-stacked"), selectedItemNumber > 0 && "".concat(elementBlockClass, "--is-stacked__").concat(theme), isOpen && "".concat(elementBlockClass, "--is-visible"), mountedRef.current && "".concat(elementBlockClass, "--is-mounted")),
+    isOpen: isOpen && selectedItemNumber < 1,
     description: description,
     media: media,
     navLinkLabels: navLinkLabels,