@carbon/ibm-products 2.43.2-canary.15 → 2.43.2-canary.150

package/es/components/Coachmark/Coachmark.js

@@ -5,20 +5,23 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import { objectWithoutProperties as _objectWithoutProperties, slicedToArray as _slicedToArray, extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import { objectWithoutProperties as _objectWithoutProperties, slicedToArray as _slicedToArray, extends as _extends, objectSpread2 as _objectSpread2, defineProperty as _defineProperty } from '../../_virtual/_rollupPluginBabelHelpers.js';
 import React__default, { forwardRef, useState, useRef, useCallback, useEffect } from 'react';
-import cx from 'classnames';
+import { useClickOutsideElement, useWindowEvent } from './utils/hooks.js';
+import { COACHMARK_OVERLAY_KIND } from './utils/enums.js';
+import { CoachmarkContext } from './utils/context.js';
+import { CoachmarkOverlay } from './CoachmarkOverlay.js';
 import PropTypes from '../../node_modules/prop-types/index.js';
 import { createPortal } from 'react-dom';
-import { CoachmarkOverlay } from './CoachmarkOverlay.js';
-import { CoachmarkContext } from './utils/context.js';
-import { COACHMARK_OVERLAY_KIND } from './utils/enums.js';
-import { useClickOutsideElement, useWindowEvent } from './utils/hooks.js';
+import cx from 'classnames';
 import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
 import { pkg } from '../../settings.js';
 import { throttle } from 'lodash';
+import { Popover, PopoverContent } from '@carbon/react';
+import { useIsomorphicEffect } from '../../global/js/hooks/useIsomorphicEffect.js';
+
+var _excluded = ["align", "autoAlign", "children", "className", "onClose", "overlayClassName", "overlayKind", "overlayRef", "positionTune", "portalTarget", "target", "theme"];
 
-var _excluded = ["align", "children", "className", "onClose", "overlayClassName", "overlayKind", "overlayRef", "portalTarget", "positionTune", "target", "theme"];
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(pkg.prefix, "--coachmark");
 var overlayBlockClass = "".concat(blockClass, "-overlay");
@@ -36,9 +39,10 @@ var defaults = {
  */
 
 var Coachmark = /*#__PURE__*/forwardRef(function (_ref, ref) {
-  var _document$querySelect;
+  var _positionTune$y, _positionTune$x;
   var _ref$align = _ref.align,
     align = _ref$align === void 0 ? defaults.align : _ref$align,
+    autoAlign = _ref.autoAlign,
     children = _ref.children,
     className = _ref.className,
     _ref$onClose = _ref.onClose,
@@ -47,15 +51,14 @@ var Coachmark = /*#__PURE__*/forwardRef(function (_ref, ref) {
     _ref$overlayKind = _ref.overlayKind,
     overlayKind = _ref$overlayKind === void 0 ? defaults.overlayKind : _ref$overlayKind,
     overlayRef = _ref.overlayRef,
-    portalTarget = _ref.portalTarget,
     positionTune = _ref.positionTune,
+    portalTarget = _ref.portalTarget,
     target = _ref.target,
     _ref$theme = _ref.theme,
     theme = _ref$theme === void 0 ? defaults.theme : _ref$theme,
     rest = _objectWithoutProperties(_ref, _excluded);
   var isBeacon = overlayKind === COACHMARK_OVERLAY_KIND.TOOLTIP;
   var isStacked = overlayKind === COACHMARK_OVERLAY_KIND.STACKED;
-  var portalNode = portalTarget ? (_document$querySelect = document.querySelector(portalTarget)) !== null && _document$querySelect !== void 0 ? _document$querySelect : document.querySelector('body') : document.querySelector('body');
   var _useState = useState(isStacked),
     _useState2 = _slicedToArray(_useState, 2),
     isOpen = _useState2[0],
@@ -79,6 +82,11 @@ var Coachmark = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var backupRef = useRef();
   var _coachmarkRef = ref || backupRef;
   var _overlayRef = overlayRef || overlayBackupRef;
+  var portalNode = useRef(null);
+  useIsomorphicEffect(function () {
+    var _document$querySelect, _document, _document2, _document3;
+    portalNode.current = portalTarget ? (_document$querySelect = (_document = document) === null || _document === void 0 ? void 0 : _document.querySelector(portalTarget)) !== null && _document$querySelect !== void 0 ? _document$querySelect : (_document2 = document) === null || _document2 === void 0 ? void 0 : _document2.querySelector('body') : (_document3 = document) === null || _document3 === void 0 ? void 0 : _document3.querySelector('body');
+  }, [portalTarget]);
   var closeOverlay = function closeOverlay() {
     setIsOpen(false);
   };
@@ -120,6 +128,10 @@ var Coachmark = /*#__PURE__*/forwardRef(function (_ref, ref) {
       setShouldResetPosition(true);
     }
   };
+  var overlayPositionStyle = {
+    top: ((_positionTune$y = positionTune === null || positionTune === void 0 ? void 0 : positionTune.y) !== null && _positionTune$y !== void 0 ? _positionTune$y : 0) - 16,
+    left: ((_positionTune$x = positionTune === null || positionTune === void 0 ? void 0 : positionTune.x) !== null && _positionTune$x !== void 0 ? _positionTune$x : 0) - 16
+  };
   var contextValue = {
     buttonProps: {
       'aria-expanded': isOpen,
@@ -135,7 +147,8 @@ var Coachmark = /*#__PURE__*/forwardRef(function (_ref, ref) {
     targetRect: targetRect,
     targetOffset: targetOffset,
     align: align,
-    positionTune: positionTune
+    positionTune: positionTune,
+    isOpen: isOpen
   };
   var handleResize = throttle(function () {
     closeOverlay();
@@ -169,18 +182,35 @@ var Coachmark = /*#__PURE__*/forwardRef(function (_ref, ref) {
   }, /*#__PURE__*/React__default.createElement("div", _extends({
     className: cx(blockClass, "".concat(blockClass, "__").concat(theme), className),
     ref: _coachmarkRef
-  }, rest, getDevtoolsProps(componentName)), target, isOpen && /*#__PURE__*/createPortal( /*#__PURE__*/React__default.createElement(CoachmarkOverlay, {
+  }, rest, getDevtoolsProps(componentName)), overlayKind !== 'tooltip' ? /*#__PURE__*/React__default.createElement(React__default.Fragment, null, target, isOpen && (portalNode === null || portalNode === void 0 ? void 0 : portalNode.current) && /*#__PURE__*/createPortal( /*#__PURE__*/React__default.createElement(CoachmarkOverlay, {
     ref: _overlayRef,
     fixedIsVisible: false,
     kind: overlayKind,
     onClose: handleClose,
     theme: theme,
     className: cx(overlayClassName, "".concat(overlayBlockClass, "--is-visible"))
-  }, children),
-  // Default to `document.body` when `portalNode` is `null`
-  portalNode || document.body)));
+  }, children), // Default to `document.body` when `portalNode` is `null`
+  portalNode === null || portalNode === void 0 ? void 0 : portalNode.current)) : /*#__PURE__*/React__default.createElement(Popover, {
+    highContrast: true,
+    caret: true,
+    style: _objectSpread2({
+      position: 'absolute'
+    }, overlayPositionStyle),
+    align: align,
+    autoAlign: autoAlign,
+    open: isOpen
+  }, target, /*#__PURE__*/React__default.createElement(PopoverContent, null, isOpen && /*#__PURE__*/React__default.createElement(CoachmarkOverlay, {
+    ref: _overlayRef,
+    fixedIsVisible: false,
+    kind: overlayKind,
+    onClose: handleClose,
+    theme: theme,
+    className: cx(overlayClassName, _defineProperty({}, "".concat(overlayBlockClass, "--is-visible"), isOpen))
+  }, children)))));
 });
-var overlayRefType = typeof HTMLElement === 'undefined' ? PropTypes.object : PropTypes.instanceOf(HTMLElement);
+var overlayRefType = typeof HTMLElement === 'undefined' ? PropTypes.object :
+// eslint-disable-next-line ssr-friendly/no-dom-globals-in-module-scope
+PropTypes.instanceOf(HTMLElement);
 
 // Return a placeholder if not released and not enabled by feature flag
 Coachmark = pkg.checkComponentEnabled(Coachmark, componentName);
@@ -199,6 +229,11 @@ Coachmark.propTypes = {
    * @see COACHMARK_ALIGNMENT
    */
   align: PropTypes.oneOf(['bottom', 'bottom-left', 'bottom-right', 'left', 'left-top', 'left-bottom', 'right', 'right-top', 'right-bottom', 'top', 'top-left', 'top-right']),
+  /**
+   * Auto aligns the coachmark based on screen boundaries
+   * Applies only to Tooltip Coachmarks.
+   */
+  autoAlign: PropTypes.bool,
   /**
    * Coachmark should use a single CoachmarkOverlayElements component as a child.
    * @see CoachmarkOverlayElements
@@ -237,6 +272,7 @@ Coachmark.propTypes = {
   /**
    * Fine tune the position of the target in pixels. Applies only to Beacons.
    */
+  // @ts-ignore
   positionTune: PropTypes.shape({
     x: PropTypes.number,
     y: PropTypes.number

package/es/components/Coachmark/CoachmarkOverlay.js

@@ -55,7 +55,7 @@ var CoachmarkOverlay = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var coachmark = useCoachmark();
   var isBeacon = kind === COACHMARK_OVERLAY_KIND.TOOLTIP;
   var isDraggable = kind === COACHMARK_OVERLAY_KIND.FLOATING;
-  var isVisible = className && className.includes('is-visible');
+  var isVisible = className === null || className === void 0 ? void 0 : className.includes('is-visible');
   var handleKeyPress = function handleKeyPress(event) {
     var shiftKey = event.shiftKey,
       key = event.key;
@@ -163,9 +163,7 @@ var CoachmarkOverlay = /*#__PURE__*/forwardRef(function (_ref, ref) {
     return /*#__PURE__*/React__default.cloneElement(child, {
       isVisible: isVisible
     });
-  })), isBeacon && /*#__PURE__*/React__default.createElement("span", {
-    className: "".concat(blockClass, "__caret")
-  }));
+  })));
 });
 function getWindowDimensions() {
   var _window = window,

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

@@ -1,3 +1,10 @@
-export { Coachmark } from "./Coachmark";
-export { useCoachmark } from "./utils/context";
-export { BEACON_KIND, COACHMARK_OVERLAY_KIND, COACHMARK_ALIGNMENT } from "./utils/enums";
+/**
+ * Copyright IBM Corp. 2023, 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 { Coachmark } from './Coachmark';
+export { BEACON_KIND, COACHMARK_OVERLAY_KIND, COACHMARK_ALIGNMENT, } from './utils/enums';
+export { useCoachmark } from './utils/context';
+export type { CoachmarkProps } from './Coachmark';

package/es/components/Coachmark/utils/enums.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Copyright IBM Corp. 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.
+ */
 /**
  * Reserved for future expansion, i.e. "RING".
  */

package/es/components/CoachmarkBeacon/CoachmarkBeacon.d.ts

@@ -4,9 +4,9 @@
  * 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 from 'react';
 import { BEACON_KIND } from '../Coachmark';
-interface CoachmarkBeaconProps {
+import React from 'react';
+export interface CoachmarkBeaconProps {
     /**
      * Optional class name for this component.
      */
@@ -26,4 +26,3 @@ interface CoachmarkBeaconProps {
  * Use beacon for the target prop of a Coachmark component.
  */
 export declare let CoachmarkBeacon: React.ForwardRefExoticComponent<CoachmarkBeaconProps & React.RefAttributes<HTMLDivElement>>;
-export {};

package/es/components/CoachmarkBeacon/CoachmarkBeacon.js

@@ -6,12 +6,13 @@
  */
 
 import { objectWithoutProperties as _objectWithoutProperties, extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
-import React__default from 'react';
+import '../Coachmark/Coachmark.js';
+import { useCoachmark } from '../Coachmark/utils/context.js';
 import PropTypes from '../../node_modules/prop-types/index.js';
+import React__default from 'react';
 import cx from 'classnames';
 import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
 import { pkg } from '../../settings.js';
-import { useCoachmark } from '../Coachmark/utils/context.js';
 
 var _div, _circle;
 var _excluded = ["label", "className", "kind"];
@@ -26,7 +27,6 @@ var defaults = {
  * Use beacon for the target prop of a Coachmark component.
  */
 var CoachmarkBeacon = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
-  var _coachmark$positionTu, _coachmark$positionTu2, _coachmark$positionTu3, _coachmark$positionTu4;
   var label = _ref.label,
     className = _ref.className,
     _ref$kind = _ref.kind,
@@ -36,14 +36,9 @@ var CoachmarkBeacon = /*#__PURE__*/React__default.forwardRef(function (_ref, ref
   if (!coachmark) {
     return _div || (_div = /*#__PURE__*/React__default.createElement("div", null, "CoachmarkBeacon is to be use exclusively within the target prop of Coachmark"));
   }
-  var overlayPositionStyle = {
-    top: (_coachmark$positionTu = (_coachmark$positionTu2 = coachmark.positionTune) === null || _coachmark$positionTu2 === void 0 ? void 0 : _coachmark$positionTu2.y) !== null && _coachmark$positionTu !== void 0 ? _coachmark$positionTu : 0,
-    left: (_coachmark$positionTu3 = (_coachmark$positionTu4 = coachmark.positionTune) === null || _coachmark$positionTu4 === void 0 ? void 0 : _coachmark$positionTu4.x) !== null && _coachmark$positionTu3 !== void 0 ? _coachmark$positionTu3 : 0
-  };
   return /*#__PURE__*/React__default.createElement("span", _extends({}, rest, {
     className: cx(blockClass, "".concat(blockClass, "-").concat(kind), className),
-    ref: ref,
-    style: overlayPositionStyle
+    ref: ref
   }, getDevtoolsProps(componentName), {
     role: "tooltip"
   }), /*#__PURE__*/React__default.createElement("button", _extends({
@@ -54,7 +49,7 @@ var CoachmarkBeacon = /*#__PURE__*/React__default.forwardRef(function (_ref, ref
     className: "".concat(blockClass, "__target")
   }), /*#__PURE__*/React__default.createElement("svg", {
     className: "".concat(blockClass, "__center")
-  }, _circle || (_circle = /*#__PURE__*/React__default.createElement("circle", {
+  }, /*#__PURE__*/React__default.createElement("title", null, label), _circle || (_circle = /*#__PURE__*/React__default.createElement("circle", {
     r: 1,
     cx: 38,
     cy: 38

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

@@ -1 +1,8 @@
-export { CoachmarkBeacon } from "./CoachmarkBeacon";
+/**
+ * Copyright IBM Corp. 2023, 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 { CoachmarkBeacon } from './CoachmarkBeacon';
+export type { CoachmarkBeaconProps } from './CoachmarkBeacon';

package/es/components/CoachmarkButton/CoachmarkButton.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
-interface CoachmarkButtonProps {
+export interface CoachmarkButtonProps {
     /**
      * Provide an optional class to be applied to the containing node.
      */
@@ -19,4 +19,3 @@ interface CoachmarkButtonProps {
  * Use CoachmarkButton for the target prop of a Coachmark component.
  */
 export declare let CoachmarkButton: React.ForwardRefExoticComponent<CoachmarkButtonProps & React.RefAttributes<HTMLButtonElement>>;
-export {};

package/es/components/CoachmarkButton/CoachmarkButton.js

@@ -6,16 +6,18 @@
  */
 
 import { objectWithoutProperties as _objectWithoutProperties, extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
-import React__default from 'react';
+import { Button } from '@carbon/react';
 import PropTypes from '../../node_modules/prop-types/index.js';
+import React__default from 'react';
 import cx from 'classnames';
 import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
 import { pkg } from '../../settings.js';
-import { Button } from '@carbon/react';
+import '../Coachmark/Coachmark.js';
 import { useCoachmark } from '../Coachmark/utils/context.js';
 
 var _div;
 var _excluded = ["className", "label"];
+
 // Carbon and package components we use.
 /* TODO: @import(s) of carbon components and other package components. */
 

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

@@ -1 +1,8 @@
-export { CoachmarkButton } from "./CoachmarkButton";
+/**
+ * Copyright IBM Corp. 2023, 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 { CoachmarkButton } from './CoachmarkButton';
+export type { CoachmarkButtonProps } from './CoachmarkButton';

package/es/components/CoachmarkFixed/CoachmarkFixed.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React, { ReactNode } from 'react';
-interface CoachmarkFixedProps {
+export interface CoachmarkFixedProps {
     /**
      * CoachmarkFixed should use a single CoachmarkOverlayElements component as a child.
      */
@@ -45,4 +45,3 @@ interface CoachmarkFixedProps {
  * This variant allows the a coachmark overlay to be displayed by interacting with the tagline.
  */
 export declare let CoachmarkFixed: React.ForwardRefExoticComponent<CoachmarkFixedProps & React.RefAttributes<HTMLDivElement>>;
-export {};

package/es/components/CoachmarkFixed/CoachmarkFixed.js

@@ -7,17 +7,20 @@
 
 import { objectWithoutProperties as _objectWithoutProperties, slicedToArray as _slicedToArray, extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
 import React__default, { useRef, useState, useCallback, useEffect } from 'react';
+import { COACHMARK_OVERLAY_KIND } from '../Coachmark/utils/enums.js';
+import { CoachmarkContext } from '../Coachmark/utils/context.js';
+import { CoachmarkOverlay } from '../Coachmark/CoachmarkOverlay.js';
+import { CoachmarkTagline } from '../Coachmark/CoachmarkTagline.js';
 import PropTypes from '../../node_modules/prop-types/index.js';
+import { createPortal } from 'react-dom';
 import cx from 'classnames';
 import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
 import { pkg } from '../../settings.js';
-import { createPortal } from 'react-dom';
-import { CoachmarkOverlay } from '../Coachmark/CoachmarkOverlay.js';
-import { CoachmarkTagline } from '../Coachmark/CoachmarkTagline.js';
-import { CoachmarkContext } from '../Coachmark/utils/context.js';
-import { COACHMARK_OVERLAY_KIND } from '../Coachmark/utils/enums.js';
+import { useReducedMotion } from 'framer-motion';
+import { useIsomorphicEffect } from '../../global/js/hooks/useIsomorphicEffect.js';
 
 var _excluded = ["children", "className", "onClose", "portalTarget", "tagline", "theme"];
+
 // Carbon and package components we use.
 /* TODO: @import(s) of carbon components and other package components. */
 
@@ -39,7 +42,6 @@ var defaults = {
  * This variant allows the a coachmark overlay to be displayed by interacting with the tagline.
  */
 var CoachmarkFixed = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
-  var _document$querySelect;
   var children = _ref.children,
     className = _ref.className,
     _ref$onClose = _ref.onClose,
@@ -51,7 +53,7 @@ var CoachmarkFixed = /*#__PURE__*/React__default.forwardRef(function (_ref, ref)
     theme = _ref$theme === void 0 ? defaults.theme : _ref$theme,
     rest = _objectWithoutProperties(_ref, _excluded);
   var overlayRef = useRef(null);
-  var portalNode = portalTarget ? (_document$querySelect = document.querySelector(portalTarget)) !== null && _document$querySelect !== void 0 ? _document$querySelect : document.querySelector('body') : document.querySelector('body');
+  var portalNode = useRef(null);
   var _useState = useState(false),
     _useState2 = _slicedToArray(_useState, 2),
     isOpen = _useState2[0],
@@ -75,17 +77,19 @@ var CoachmarkFixed = /*#__PURE__*/React__default.forwardRef(function (_ref, ref)
     _useState10 = _slicedToArray(_useState9, 2),
     fixedIsVisible = _useState10[0],
     setFixedIsVisible = _useState10[1];
-  var prefersReducedMotion = window.matchMedia('(prefers-reduced-motion: reduce)');
+  var shouldReduceMotion = useReducedMotion();
+  useIsomorphicEffect(function () {
+    var _document$querySelect, _document, _document2, _document3;
+    portalNode.current = portalTarget ? (_document$querySelect = (_document = document) === null || _document === void 0 ? void 0 : _document.querySelector(portalTarget)) !== null && _document$querySelect !== void 0 ? _document$querySelect : (_document2 = document) === null || _document2 === void 0 ? void 0 : _document2.querySelector('body') : (_document3 = document) === null || _document3 === void 0 ? void 0 : _document3.querySelector('body');
+  }, [portalTarget]);
   var handleClose = useCallback(function () {
-    console.log('HANDLING CLOSE HERE...');
-    if (prefersReducedMotion.matches) {
+    if (shouldReduceMotion) {
       setIsOpen(false);
     } else {
       setFixedIsVisible(false);
     }
-  }, [prefersReducedMotion.matches]);
+  }, [shouldReduceMotion]);
   var handleTransitionEnd = function handleTransitionEnd(e) {
-    console.log('Here at transition end... ', e.propertyName === 'transform' && !fixedIsVisible);
     if (e.propertyName === 'transform' && !fixedIsVisible) {
       setIsOpen(false);
       onClose();
@@ -164,7 +168,7 @@ var CoachmarkFixed = /*#__PURE__*/React__default.forwardRef(function (_ref, ref)
   }, getDevtoolsProps(componentName)), /*#__PURE__*/React__default.createElement(CoachmarkTagline, {
     title: tagline,
     onClose: onClose
-  }), isOpen && /*#__PURE__*/createPortal( /*#__PURE__*/React__default.createElement(CoachmarkOverlay, {
+  }), isOpen && (portalNode === null || portalNode === void 0 ? void 0 : portalNode.current) && /*#__PURE__*/createPortal( /*#__PURE__*/React__default.createElement(CoachmarkOverlay, {
     ref: overlayRef,
     fixedIsVisible: fixedIsVisible,
     kind: COACHMARK_OVERLAY_KIND.FIXED,
@@ -172,9 +176,8 @@ var CoachmarkFixed = /*#__PURE__*/React__default.forwardRef(function (_ref, ref)
     onTransitionEnd: handleTransitionEnd,
     theme: theme,
     className: cx(fixedIsVisible && "".concat(overlayBlockClass, "--is-visible"), overlayBlockClass)
-  }, children),
-  // Default to `document.body` when `portalNode` is `null`
-  portalNode || document.body)));
+  }, children), // Default to `document.body` when `portalNode` is `null`
+  portalNode === null || portalNode === void 0 ? void 0 : portalNode.current)));
 });
 
 // Return a placeholder if not released and not enabled by feature flag

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

@@ -1 +1,8 @@
-export { CoachmarkFixed } from "./CoachmarkFixed";
+/**
+ * Copyright IBM Corp. 2023, 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 { CoachmarkFixed } from './CoachmarkFixed';
+export type { CoachmarkFixedProps } from './CoachmarkFixed';

package/es/components/CoachmarkOverlayElement/CoachmarkOverlayElement.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React, { ReactNode } from 'react';
-interface CoachmarkOverlayElementProps {
+export interface CoachmarkOverlayElementProps {
     /**
      * An optional button can be rendered below the description.
      * This can be a link, button, Coachmark button, etc.
@@ -30,4 +30,3 @@ interface CoachmarkOverlayElementProps {
  * in a carousel fashion.
  */
 export declare let CoachmarkOverlayElement: React.ForwardRefExoticComponent<CoachmarkOverlayElementProps & React.RefAttributes<HTMLDivElement>>;
-export {};

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

@@ -1 +1,8 @@
-export { CoachmarkOverlayElement } from "./CoachmarkOverlayElement";
+/**
+ * Copyright IBM Corp. 2023, 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 { CoachmarkOverlayElement } from './CoachmarkOverlayElement';
+export type { CoachmarkOverlayElementProps } from './CoachmarkOverlayElement';

package/es/components/CoachmarkOverlayElements/CoachmarkOverlayElements.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React, { ReactNode } from 'react';
-interface CoachmarkOverlayElementsProps {
+export interface CoachmarkOverlayElementsProps {
     /**
      * CoachmarkOverlayElements should be used with one or many CoachmarkOverlayElement components as children.
      * @see CoachmarkOverlayElement
@@ -47,4 +47,3 @@ interface CoachmarkOverlayElementsProps {
  * components in a carousel fashion.
  */
 export declare let CoachmarkOverlayElements: React.ForwardRefExoticComponent<CoachmarkOverlayElementsProps & React.RefAttributes<HTMLDivElement>>;
-export {};

package/es/components/CoachmarkOverlayElements/CoachmarkOverlayElements.js

@@ -6,19 +6,22 @@
  */
 
 import { objectWithoutProperties as _objectWithoutProperties, slicedToArray as _slicedToArray, extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import { Button } from '@carbon/react';
 import React__default, { useRef, useState, Children, useEffect } from 'react';
+import { Carousel } from '../Carousel/Carousel.js';
+import '../Carousel/CarouselItem.js';
 import PropTypes from '../../node_modules/prop-types/index.js';
+import { SteppedAnimatedMedia } from '../SteppedAnimatedMedia/SteppedAnimatedMedia.js';
+import { clamp } from 'lodash';
 import cx from 'classnames';
 import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
-import { pkg } from '../../settings.js';
-import { Button } from '@carbon/react';
-import { clamp } from 'lodash';
 import pconsole from '../../global/js/utils/pconsole.js';
+import { pkg } from '../../settings.js';
+import '../Coachmark/Coachmark.js';
 import { useCoachmark } from '../Coachmark/utils/context.js';
-import { SteppedAnimatedMedia } from '../SteppedAnimatedMedia/SteppedAnimatedMedia.js';
-import { Carousel } from '../Carousel/Carousel.js';
 
 var _excluded = ["className", "children", "isVisible", "media", "nextButtonText", "previousButtonLabel", "closeButtonLabel"];
+
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(pkg.prefix, "--coachmark-overlay-elements");
 var componentName = 'CoachmarkOverlayElements';
@@ -71,7 +74,8 @@ var CoachmarkOverlayElements = /*#__PURE__*/React__default.forwardRef(function (
   var setCurrentProgStep = function setCurrentProgStep(value) {
     if (currentProgStep > 0 && value === 0 && buttonFocusRef.current) {
       setTimeout(function () {
-        buttonFocusRef.current.focus();
+        var _buttonFocusRef$curre;
+        (_buttonFocusRef$curre = buttonFocusRef.current) === null || _buttonFocusRef$curre === void 0 || _buttonFocusRef$curre.focus();
       }, 1000);
     }
     _setCurrentProgStep(value);

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

@@ -1 +1,8 @@
-export { CoachmarkOverlayElements } from "./CoachmarkOverlayElements";
+/**
+ * Copyright IBM Corp. 2023, 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 { CoachmarkOverlayElements } from './CoachmarkOverlayElements';
+export type { CoachmarkOverlayElementsProps } from './CoachmarkOverlayElements';

package/es/components/CoachmarkStack/CoachmarkStack.d.ts

@@ -1,8 +1,73 @@
+/**
+ * Copyright IBM Corp. 2023, 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.
+ */
+import React, { ReactNode } from 'react';
+type Media = {
+    render?: () => ReactNode;
+} | {
+    filePaths?: string[];
+};
+interface CoachmarkStackProps {
+    /**
+     * CoachmarkStack should use a single CoachmarkOverlayElements component as a child.
+     */
+    children: ReactNode;
+    /**
+     * Provide an optional class to be applied to the containing node.
+     */
+    className?: string;
+    /**
+     * The label for the button that will close the Stack
+     */
+    closeButtonLabel?: string;
+    /**
+     * The description of the Coachmark.
+     */
+    description: ReactNode;
+    /**
+     * The object describing an image in one of two shapes.
+     *
+     * If a single media element is required, use `{render}`.
+     *
+     * If a stepped animation is required, use `{filePaths}`.
+     *
+     * @see {@link MEDIA_PROP_TYPE}.
+     */
+    media?: Media;
+    /**
+     * The labels used to link to the stackable Coachmarks.
+     */
+    navLinkLabels: string[];
+    /**
+     * Function to call when the CoachmarkStack closes.
+     */
+    onClose?: () => void;
+    /**
+     * Where in the DOM to render the stack.
+     * The default is `document.body`.
+     */
+    portalTarget?: string;
+    /**
+     * The tagline title which will be fixed to the bottom right of the window and will serve as the display trigger.
+     */
+    tagline: string;
+    /**
+     * Determines the theme of the component.
+     */
+    theme?: 'light' | 'dark';
+    /**
+     * The title of the Coachmark.
+     */
+    title: string;
+}
 /**
  * Stacked coachmarks are used to call out specific functionality or concepts
  * within the UI that may not be intuitive but are important for the
  * user to gain understanding of the product's main value and discover new use cases.
  * This variant allows the stacking of multiple coachmark overlays to be displayed by interacting with the tagline.
  */
-export let CoachmarkStack: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let CoachmarkStack: React.ForwardRefExoticComponent<CoachmarkStackProps & React.RefAttributes<HTMLDivElement>>;
+export {};