@carbon/ibm-products 2.43.2-canary.30 → 2.43.2-canary.300

package/lib/components/CoachmarkOverlayElements/CoachmarkOverlayElements.js

@@ -7,27 +7,23 @@
 
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
 var _rollupPluginBabelHelpers = require('../../_virtual/_rollupPluginBabelHelpers.js');
+var react = require('@carbon/react');
 var React = require('react');
-var index = require('../../node_modules/prop-types/index.js');
+var Carousel = require('../Carousel/Carousel.js');
+require('../Carousel/CarouselItem.js');
+var index = require('../../_virtual/index.js');
+var SteppedAnimatedMedia = require('../SteppedAnimatedMedia/SteppedAnimatedMedia.js');
+var lodash = require('lodash');
 var cx = require('classnames');
 var devtools = require('../../global/js/utils/devtools.js');
-var settings = require('../../settings.js');
-var react = require('@carbon/react');
-var lodash = require('lodash');
 var pconsole = require('../../global/js/utils/pconsole.js');
+var settings = require('../../settings.js');
+require('../Coachmark/Coachmark.js');
 var context = require('../Coachmark/utils/context.js');
-var SteppedAnimatedMedia = require('../SteppedAnimatedMedia/SteppedAnimatedMedia.js');
-var Carousel = require('../Carousel/Carousel.js');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
-var cx__default = /*#__PURE__*/_interopDefaultLegacy(cx);
 
 var _excluded = ["className", "children", "isVisible", "media", "nextButtonText", "previousButtonLabel", "closeButtonLabel"];
+
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(settings.pkg.prefix, "--coachmark-overlay-elements");
 var componentName = 'CoachmarkOverlayElements';
@@ -53,7 +49,7 @@ var defaults = {
  * Composable container to allow for the displaying of CoachmarkOverlayElement
  * components in a carousel fashion.
  */
-exports.CoachmarkOverlayElements = /*#__PURE__*/React__default["default"].forwardRef(function (_ref, ref) {
+exports.CoachmarkOverlayElements = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var className = _ref.className,
     children = _ref.children,
     _ref$isVisible = _ref.isVisible,
@@ -80,7 +76,8 @@ exports.CoachmarkOverlayElements = /*#__PURE__*/React__default["default"].forwar
   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);
@@ -103,10 +100,10 @@ exports.CoachmarkOverlayElements = /*#__PURE__*/React__default["default"].forwar
     }, 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."));
+    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."));
   }
-  return /*#__PURE__*/React__default["default"].createElement("section", _rollupPluginBabelHelpers["extends"]({}, rest, {
-    className: cx__default["default"](blockClass,
+  return /*#__PURE__*/React.createElement("section", _rollupPluginBabelHelpers.extends({}, rest, {
+    className: cx(blockClass,
     // Apply the block class to the main HTML element
     className,
     // Apply any supplied class names to the main HTML element.
@@ -116,28 +113,27 @@ exports.CoachmarkOverlayElements = /*#__PURE__*/React__default["default"].forwar
       // example: [`${blockClass}__here-if-small`]: size === 'sm',
     }),
     ref: ref
-    // role="main"
-  }, devtools.getDevtoolsProps(componentName)), media && (media.render ? media.render() : /*#__PURE__*/React__default["default"].createElement(SteppedAnimatedMedia.SteppedAnimatedMedia, {
+  }, devtools.getDevtoolsProps(componentName)), media && (media.render ? media.render() : /*#__PURE__*/React.createElement(SteppedAnimatedMedia.SteppedAnimatedMedia, {
     className: "".concat(blockClass, "__element-stepped-media"),
     filePaths: media.filePaths,
     playStep: currentProgStep
-  })), numProgSteps === 1 ? /*#__PURE__*/React__default["default"].createElement(React__default["default"].Fragment, null, children, closeButtonLabel && /*#__PURE__*/React__default["default"].createElement("div", {
-    className: cx__default["default"]("".concat(blockClass, "__footer"), 'coachmark-carousel-controls')
-  }, /*#__PURE__*/React__default["default"].createElement(react.Button, _rollupPluginBabelHelpers["extends"]({
+  })), numProgSteps === 1 ? /*#__PURE__*/React.createElement(React.Fragment, null, children, closeButtonLabel && /*#__PURE__*/React.createElement("div", {
+    className: cx("".concat(blockClass, "__footer"), 'coachmark-carousel-controls')
+  }, /*#__PURE__*/React.createElement(react.Button, _rollupPluginBabelHelpers.extends({
     size: "sm"
   }, coachmark.closeButtonProps, {
     ref: buttonFocusRef
-  }), closeButtonLabel))) : /*#__PURE__*/React__default["default"].createElement(React__default["default"].Fragment, null, /*#__PURE__*/React__default["default"].createElement(Carousel.Carousel, {
+  }), closeButtonLabel))) : /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Carousel.Carousel, {
     disableArrowScroll: true,
     ref: scrollRef,
     onScroll: function onScroll(scrollPercent) {
       setScrollPosition(scrollPercent);
     }
-  }, children), /*#__PURE__*/React__default["default"].createElement("div", {
-    className: cx__default["default"]("".concat(blockClass, "__footer"))
-  }, /*#__PURE__*/React__default["default"].createElement("div", {
+  }, children), /*#__PURE__*/React.createElement("div", {
+    className: cx("".concat(blockClass, "__footer"))
+  }, /*#__PURE__*/React.createElement("div", {
     className: "".concat(blockClass, "--controls-progress")
-  }, "".concat(currentProgStep + 1, " / ").concat(numProgSteps)), scrollPosition > 0 && /*#__PURE__*/React__default["default"].createElement(react.Button, {
+  }, "".concat(currentProgStep + 1, " / ").concat(numProgSteps)), scrollPosition > 0 && /*#__PURE__*/React.createElement(react.Button, {
     size: "sm",
     kind: "ghost",
     title: previousButtonLabel,
@@ -148,7 +144,7 @@ exports.CoachmarkOverlayElements = /*#__PURE__*/React__default["default"].forwar
       scrollRef === null || scrollRef === void 0 || (_scrollRef$current = scrollRef.current) === null || _scrollRef$current === void 0 || (_scrollRef$current$sc = _scrollRef$current.scrollToView) === null || _scrollRef$current$sc === void 0 || _scrollRef$current$sc.call(_scrollRef$current, targetStep);
       setCurrentProgStep(targetStep);
     }
-  }, previousButtonLabel), currentProgStep < progStepCeil ? /*#__PURE__*/React__default["default"].createElement(react.Button, {
+  }, previousButtonLabel), currentProgStep < progStepCeil ? /*#__PURE__*/React.createElement(react.Button, {
     size: "sm",
     ref: buttonFocusRef,
     title: nextButtonText,
@@ -159,7 +155,7 @@ exports.CoachmarkOverlayElements = /*#__PURE__*/React__default["default"].forwar
       scrollRef === null || scrollRef === void 0 || (_scrollRef$current2 = scrollRef.current) === null || _scrollRef$current2 === void 0 || (_scrollRef$current2$s = _scrollRef$current2.scrollToView) === null || _scrollRef$current2$s === void 0 || _scrollRef$current2$s.call(_scrollRef$current2, targetStep);
       setCurrentProgStep(targetStep);
     }
-  }, nextButtonText) : closeButtonLabel && /*#__PURE__*/React__default["default"].createElement(react.Button, _rollupPluginBabelHelpers["extends"]({
+  }, nextButtonText) : closeButtonLabel && /*#__PURE__*/React.createElement(react.Button, _rollupPluginBabelHelpers.extends({
     size: "sm",
     ref: buttonFocusRef
   }, coachmark.closeButtonProps), closeButtonLabel))));
@@ -182,37 +178,37 @@ exports.CoachmarkOverlayElements.propTypes = {
    * CoachmarkOverlayElements should be used with one or many CoachmarkOverlayElement components as children.
    * @see CoachmarkOverlayElement
    */
-  children: index["default"].node.isRequired,
+  children: index.default.node.isRequired,
   /**
    * Optional class name for this component.
    */
-  className: index["default"].string,
+  className: index.default.string,
   /**
    * The label for the Close button.
    */
-  closeButtonLabel: index["default"].string,
+  closeButtonLabel: index.default.string,
   /**
    * The visibility of CoachmarkOverlayElements is
    * managed in the parent component.
    */
-  isVisible: index["default"].bool,
+  isVisible: index.default.bool,
   /**
    * 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}`.
    */
   /**@ts-ignore*/
-  media: index["default"].oneOfType([index["default"].shape({
-    render: index["default"].func
-  }), index["default"].shape({
-    filePaths: index["default"].arrayOf(index["default"].string)
+  media: index.default.oneOfType([index.default.shape({
+    render: index.default.func
+  }), index.default.shape({
+    filePaths: index.default.arrayOf(index.default.string)
   })]),
   /**
    * The label for the Next button.
    */
-  nextButtonText: index["default"].string,
+  nextButtonText: index.default.string,
   /**
    * The label for the Previous button.
    */
-  previousButtonLabel: index["default"].string
+  previousButtonLabel: index.default.string
 };

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

package/lib/components/CoachmarkStack/CoachmarkStack.js

@@ -7,12 +7,10 @@
 
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
 var _rollupPluginBabelHelpers = require('../../_virtual/_rollupPluginBabelHelpers.js');
 var React = require('react');
 var reactDom = require('react-dom');
-var index = require('../../node_modules/prop-types/index.js');
+var index = require('../../_virtual/index.js');
 var cx = require('classnames');
 var devtools = require('../../global/js/utils/devtools.js');
 var settings = require('../../settings.js');
@@ -21,11 +19,7 @@ var CoachmarkStackHome = require('./CoachmarkStackHome.js');
 var CoachmarkTagline = require('../Coachmark/CoachmarkTagline.js');
 var context = require('../Coachmark/utils/context.js');
 var enums = require('../Coachmark/utils/enums.js');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
-var cx__default = /*#__PURE__*/_interopDefaultLegacy(cx);
+var useIsomorphicEffect = require('../../global/js/hooks/useIsomorphicEffect.js');
 
 var _excluded = ["children", "className", "onClose", "description", "media", "navLinkLabels", "portalTarget", "closeButtonLabel", "tagline", "theme", "title"];
 
@@ -39,7 +33,8 @@ var elementBlockClass = "".concat(settings.pkg.prefix, "--coachmark-stack-elemen
 var defaults = {
   onClose: function onClose() {},
   // Pass through to CoachmarkStackHome
-  theme: 'light'
+  theme: 'light',
+  portalTarget: 'body'
 };
 
 // NOTE
@@ -55,8 +50,7 @@ var defaults = {
  * 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.
  */
-exports.CoachmarkStack = /*#__PURE__*/React__default["default"].forwardRef(function (_ref, ref) {
-  var _document$querySelect;
+exports.CoachmarkStack = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var children = _ref.children,
     className = _ref.className,
     _ref$onClose = _ref.onClose,
@@ -72,8 +66,12 @@ exports.CoachmarkStack = /*#__PURE__*/React__default["default"].forwardRef(funct
     theme = _ref$theme === void 0 ? defaults.theme : _ref$theme,
     title = _ref.title,
     rest = _rollupPluginBabelHelpers.objectWithoutProperties(_ref, _excluded);
-  var portalNode = portalTarget ? (_document$querySelect = document.querySelector(portalTarget)) !== null && _document$querySelect !== void 0 ? _document$querySelect : document.querySelector('body') : document.querySelector('body');
-  var stackHomeRef = React.useRef();
+  var portalNode = React.useRef(null);
+  useIsomorphicEffect.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 stackHomeRef = React.useRef(null);
   var stackedCoachmarkRefs = React.useRef([]);
   var _useState = React.useState(false),
     _useState2 = _rollupPluginBabelHelpers.slicedToArray(_useState, 2),
@@ -87,7 +85,7 @@ exports.CoachmarkStack = /*#__PURE__*/React__default["default"].forwardRef(funct
     selectedItemNumber = _useState4[0],
     setSelectedItemNumber = _useState4[1];
   // // The parent height and width values to return to after unstacked
-  var _useState5 = React.useState(null),
+  var _useState5 = React.useState(),
     _useState6 = _rollupPluginBabelHelpers.slicedToArray(_useState5, 2),
     parentHeight = _useState6[0],
     setParentHeight = _useState6[1];
@@ -168,18 +166,24 @@ exports.CoachmarkStack = /*#__PURE__*/React__default["default"].forwardRef(funct
     if (!parentHeight) {
       return;
     }
-    stackHomeRef.current.style.height = "".concat(parentHeight, "px");
+    if (stackHomeRef.current) {
+      stackHomeRef.current.style.height = "".concat(parentHeight, "px");
+    }
     if (!isOpen || targetSelectedItem < 0) {
-      stackHomeRef.current.focus();
+      if (stackHomeRef.current) {
+        stackHomeRef.current.focus();
+      }
       return;
     }
     var targetHomeHeight = stackedCoachmarkRefs.current[targetSelectedItem].clientHeight;
-    stackHomeRef.current.style.height = "".concat(targetHomeHeight, "px");
-    stackedCoachmarkRefs.current[targetSelectedItem].focus();
+    if (stackHomeRef.current) {
+      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") : '';
-    return /*#__PURE__*/React__default["default"].createElement(CoachmarkOverlay.CoachmarkOverlay, {
+    return /*#__PURE__*/React.createElement(CoachmarkOverlay.CoachmarkOverlay, {
       key: idx,
       ref: function ref(_ref2) {
         return stackedCoachmarkRefs.current[idx] = _ref2;
@@ -190,20 +194,20 @@ exports.CoachmarkStack = /*#__PURE__*/React__default["default"].forwardRef(funct
       },
       theme: theme,
       fixedIsVisible: false,
-      className: cx__default["default"](elementBlockClass, mountedClass, idx === selectedItemNumber - 1 && "".concat(elementBlockClass, "--is-visible"), mountedRef.current && "".concat(elementBlockClass, "--is-mounted"))
+      className: cx(elementBlockClass, mountedClass, idx === selectedItemNumber - 1 && "".concat(elementBlockClass, "--is-visible"), mountedRef.current && "".concat(elementBlockClass, "--is-mounted"))
     }, child);
   });
-  return /*#__PURE__*/React__default["default"].createElement(context.CoachmarkContext.Provider, {
+  return /*#__PURE__*/React.createElement(context.CoachmarkContext.Provider, {
     value: contextValue
-  }, /*#__PURE__*/React__default["default"].createElement("div", _rollupPluginBabelHelpers["extends"]({}, rest, {
-    className: cx__default["default"](blockClass, "".concat(settings.pkg.prefix, "--coachmark-overlay--stack"), className),
+  }, /*#__PURE__*/React.createElement("div", _rollupPluginBabelHelpers.extends({}, rest, {
+    className: cx(blockClass, "".concat(settings.pkg.prefix, "--coachmark-overlay--stack"), className),
     ref: ref
-  }, devtools.getDevtoolsProps(componentName)), /*#__PURE__*/React__default["default"].createElement(CoachmarkTagline.CoachmarkTagline, {
+  }, devtools.getDevtoolsProps(componentName)), /*#__PURE__*/React.createElement(CoachmarkTagline.CoachmarkTagline, {
     title: tagline,
     onClose: onClose
-  }), /*#__PURE__*/React__default["default"].createElement(CoachmarkStackHome.CoachmarkStackHome, {
+  }), /*#__PURE__*/React.createElement(CoachmarkStackHome.CoachmarkStackHome, {
     ref: stackHomeRef,
-    className: cx__default["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")),
+    className: cx("".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,
@@ -215,7 +219,7 @@ exports.CoachmarkStack = /*#__PURE__*/React__default["default"].forwardRef(funct
     portalTarget: portalTarget,
     closeButtonLabel: closeButtonLabel,
     title: title
-  }), /*#__PURE__*/reactDom.createPortal(wrappedChildren, portalNode)));
+  }), portalNode !== null && portalNode !== void 0 && portalNode.current ? /*#__PURE__*/reactDom.createPortal(wrappedChildren, portalNode === null || portalNode === void 0 ? void 0 : portalNode.current) : null));
 });
 
 // Return a placeholder if not released and not enabled by feature flag
@@ -232,20 +236,20 @@ exports.CoachmarkStack.propTypes = {
   /**
    * CoachmarkStack should use a single CoachmarkOverlayElements component as a child.
    */
-  children: index["default"].node.isRequired,
+  children: index.default.node.isRequired,
   /**
    * Provide an optional class to be applied to the containing node.
    */
-  className: index["default"].string,
+  className: index.default.string,
   /**
    * The label for the button that will close the Stack
    */
-  closeButtonLabel: index["default"].string,
+  closeButtonLabel: index.default.string,
   // Pass through to CoachmarkStackHome
   /**
    * The description of the Coachmark.
    */
-  description: index["default"].node.isRequired,
+  description: index.default.node.isRequired,
   /**
    * The object describing an image in one of two shapes.
    *
@@ -255,34 +259,34 @@ exports.CoachmarkStack.propTypes = {
    *
    * @see {@link MEDIA_PROP_TYPE}.
    */
-  media: index["default"].oneOfType([index["default"].shape({
-    render: index["default"].func
-  }), index["default"].shape({
-    filePaths: index["default"].arrayOf(index["default"].string)
+  media: index.default.oneOfType([index.default.shape({
+    render: index.default.func
+  }), index.default.shape({
+    filePaths: index.default.arrayOf(index.default.string)
   })]),
   /**
    * The labels used to link to the stackable Coachmarks.
    */
-  navLinkLabels: index["default"].arrayOf(index["default"].string).isRequired,
+  navLinkLabels: index.default.arrayOf(index.default.string.isRequired).isRequired,
   /**
    * Function to call when the CoachmarkStack closes.
    */
-  onClose: index["default"].func,
+  onClose: index.default.func,
   /**
    * Where in the DOM to render the stack.
    * The default is `document.body`.
    */
-  portalTarget: index["default"].string,
+  portalTarget: index.default.string,
   /**
    * The tagline title which will be fixed to the bottom right of the window and will serve as the display trigger.
    */
-  tagline: index["default"].string.isRequired,
+  tagline: index.default.string.isRequired,
   /**
    * Determines the theme of the component.
    */
-  theme: index["default"].oneOf(['light', 'dark']),
+  theme: index.default.oneOf(['light', 'dark']),
   /**
    * The title of the Coachmark.
    */
-  title: index["default"].string.isRequired
+  title: index.default.string.isRequired
 };

package/lib/components/CoachmarkStack/CoachmarkStackHome.d.ts

@@ -1,6 +1,75 @@
+/**
+ * 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?: never;
+} | {
+    render?: never;
+    filePaths?: string[];
+};
+interface CoachmarkStackHomeProps {
+    /**
+     * Optional class name for this component.
+     */
+    className?: string;
+    /**
+     * The label for the button that will close the stack
+     */
+    closeButtonLabel?: string;
+    /**
+     * The description of the Coachmark.
+     */
+    description: React.ReactNode;
+    /**
+     * If the stack home is open.
+     */
+    isOpen: boolean;
+    /**
+     * 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[];
+    /**
+     * For internal use only by CoachmarkStack and CoachmarkStackHome.
+     */
+    onClickNavItem: (index: number) => void;
+    /**
+     * Function to call when the stack closes.
+     */
+    onClose: () => void;
+    /**
+     * By default, the CoachmarkStackHome will be appended to the end of `document.body`.
+     * The CoachmarkStackHome will remain persistent as the user navigates the app until
+     * the user closes the CoachmarkStackHome.
+     *
+     * Alternatively, the app developer can tightly couple the CoachmarkStackHome to a DOM
+     * element or other component by specifying a CSS selector. The CoachmarkStackHome will
+     * remain visible as long as that element remains visible or mounted. When the
+     * element is hidden or component is unmounted, the CoachmarkStackHome will disappear.
+     */
+    portalTarget?: string;
+    /**
+     * The title of the Coachmark.
+     */
+    title: string;
+}
 /**
  * DO NOT USE. This component is for the exclusive use
  * of other Onboarding components.
  */
-export let CoachmarkStackHome: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let CoachmarkStackHome: React.ForwardRefExoticComponent<CoachmarkStackHomeProps & React.RefAttributes<HTMLDivElement>>;
+export {};