@carbon/ibm-products 2.22.0 → 2.24.0

package/lib/components/CoachmarkOverlayElements/CoachmarkOverlayElements.js

@@ -0,0 +1,222 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CoachmarkOverlayElements = 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 _propTypes = _interopRequireDefault(require("prop-types"));
+var _classnames = _interopRequireDefault(require("classnames"));
+var _devtools = require("../../global/js/utils/devtools");
+var _settings = require("../../settings");
+var _react2 = require("@carbon/react");
+var _Coachmark = require("../Coachmark");
+var _lodash = require("lodash");
+var _pconsole = _interopRequireDefault(require("../../global/js/utils/pconsole"));
+var _Carousel = require("../Carousel");
+var _SteppedAnimatedMedia = require("../SteppedAnimatedMedia");
+var _excluded = ["className", "children", "isVisible", "media", "nextButtonText", "previousButtonLabel", "closeButtonLabel"];
+/**
+ * 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 portions of React that are needed.
+// Other standard imports.
+// Carbon and package components we use.
+//TODO THIS PATH WILL NEED TO BE UPDATED ONCE IN IBM PRODUCTS
+//TODO THIS PATH WILL NEED TO BE UPDATED ONCE IN IBM PRODUCTS
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(_settings.pkg.prefix, "--coachmark-overlay-elements");
+var componentName = 'CoachmarkOverlayElements';
+
+// NOTE: the component SCSS is not imported here: it is rolled up separately.
+
+// Default values can be included here and then assigned to the prop params,
+// e.g. prop = defaults.prop,
+// This gathers default values together neatly and ensures non-primitive
+// values are initialized early to avoid react making unnecessary re-renders.
+// Note that default values are not required for props that are 'required',
+// nor for props where the component can apply undefined values reasonably.
+// Default values should be provided when the component needs to make a choice
+// or assumption when a prop is not supplied.
+
+// Default values for props
+var defaults = {
+  isVisible: false,
+  nextButtonText: 'Next',
+  previousButtonLabel: 'Back',
+  closeButtonLabel: 'Got it'
+};
+/**
+ * Composable container to allow for the displaying of CoachmarkOverlayElement
+ * components in a carousel fashion.
+ */
+var CoachmarkOverlayElements = exports.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,
+    _ref$previousButtonLa = _ref.previousButtonLabel,
+    previousButtonLabel = _ref$previousButtonLa === void 0 ? defaults.previousButtonLabel : _ref$previousButtonLa,
+    _ref$closeButtonLabel = _ref.closeButtonLabel,
+    closeButtonLabel = _ref$closeButtonLabel === void 0 ? defaults.closeButtonLabel : _ref$closeButtonLabel,
+    rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  var buttonFocusRef = (0, _react.useRef)();
+  var scrollRef = (0, _react.useRef)();
+  var _useState = (0, _react.useState)(0),
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    scrollPosition = _useState2[0],
+    setScrollPosition = _useState2[1];
+  var _useState3 = (0, _react.useState)(0),
+    _useState4 = (0, _slicedToArray2.default)(_useState3, 2),
+    currentProgStep = _useState4[0],
+    _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;
+  (0, _react.useEffect)(function () {
+    // On mount, one of the two primary buttons ("next" or "close")
+    // will be rendered and must have focus. (a11y)
+    if (buttonFocusRef.current) {
+      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."));
+  }
+  return /*#__PURE__*/_react.default.createElement("section", (0, _extends2.default)({}, rest, {
+    className: (0, _classnames.default)(blockClass,
+    // Apply the block class to the main HTML element
+    className,
+    // Apply any supplied class names to the main HTML element.
+    // example: `${blockClass}__template-string-class-${kind}-n-${size}`,
+    {
+      // switched classes dependant on props or state
+      // example: [`${blockClass}__here-if-small`]: size === 'sm',
+    }),
+    ref: ref
+    // role="main"
+  }, (0, _devtools.getDevtoolsProps)(componentName)), media && (media.render ? media.render() : /*#__PURE__*/_react.default.createElement(_SteppedAnimatedMedia.SteppedAnimatedMedia, {
+    className: "".concat(blockClass, "__element-stepped-media"),
+    filePaths: media.filePaths,
+    playStep: currentProgStep
+  })), numProgSteps === 1 ? /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, children, closeButtonLabel && /*#__PURE__*/_react.default.createElement("div", {
+    className: (0, _classnames.default)("".concat(blockClass, "__footer"), 'coachmark-carousel-controls')
+  }, /*#__PURE__*/_react.default.createElement(_react2.Button, (0, _extends2.default)({
+    size: "sm"
+  }, coachmark.closeButtonProps, {
+    ref: buttonFocusRef
+  }), closeButtonLabel))) : /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement(_Carousel.Carousel, {
+    disableArrowScroll: true,
+    ref: scrollRef,
+    onScroll: function onScroll(scrollPercent) {
+      setScrollPosition(scrollPercent);
+    }
+  }, children), /*#__PURE__*/_react.default.createElement("div", {
+    className: (0, _classnames.default)("".concat(blockClass, "__footer"))
+  }, /*#__PURE__*/_react.default.createElement("div", {
+    className: "".concat(blockClass, "--controls-progress")
+  }, "".concat(currentProgStep + 1, " / ").concat(numProgSteps)), scrollPosition > 0 && /*#__PURE__*/_react.default.createElement(_react2.Button, {
+    size: "sm",
+    kind: "ghost",
+    title: previousButtonLabel,
+    disabled: scrollPosition === 0,
+    onClick: function onClick() {
+      var targetStep = (0, _lodash.clamp)(currentProgStep - 1, progStepFloor, progStepCeil);
+      scrollRef.current.scrollToView(targetStep);
+      setCurrentProgStep(targetStep);
+    }
+  }, previousButtonLabel), currentProgStep < progStepCeil ? /*#__PURE__*/_react.default.createElement(_react2.Button, {
+    size: "sm",
+    ref: buttonFocusRef,
+    title: nextButtonText,
+    disabled: scrollPosition === 1,
+    onClick: function onClick() {
+      var targetStep = (0, _lodash.clamp)(currentProgStep + 1, progStepFloor, progStepCeil);
+      scrollRef.current.scrollToView(targetStep);
+      setCurrentProgStep(targetStep);
+    }
+  }, nextButtonText) : closeButtonLabel && /*#__PURE__*/_react.default.createElement(_react2.Button, (0, _extends2.default)({
+    size: "sm",
+    ref: buttonFocusRef
+  }, coachmark.closeButtonProps), closeButtonLabel))));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.CoachmarkOverlayElements = CoachmarkOverlayElements = _settings.pkg.checkComponentEnabled(CoachmarkOverlayElements, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+CoachmarkOverlayElements.displayName = componentName;
+
+// The types and DocGen commentary for the component props,
+// in alphabetical order (for consistency).
+// See https://www.npmjs.com/package/prop-types#usage.
+CoachmarkOverlayElements.propTypes = {
+  // TODO: UPDATE COMMENT HERE - UPDATE MDX TO HAVE DIRECTION TO USE ONLY OVERLAY ELEMENTS>...CoachmarkOverlayElements will accept only one or more CoachmarkOverlayElement as child components.
+
+  /**
+   * CoachmarkOverlayElements should be used with one or many CoachmarkOverlayElement components as children.
+   * @see CoachmarkOverlayElement
+   */
+  children: _propTypes.default.node.isRequired,
+  /**
+   * Optional class name for this component.
+   */
+  className: _propTypes.default.string,
+  /**
+   * 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}`.
+   * If a stepped animation is required, use `{filePaths}`.
+   */
+  media: _propTypes.default.oneOfType([_propTypes.default.shape({
+    render: _propTypes.default.func
+  }), _propTypes.default.shape({
+    filePaths: _propTypes.default.arrayOf(_propTypes.default.string)
+  })]),
+  /**
+   * The label for the Next button.
+   */
+  nextButtonText: _propTypes.default.string,
+  /**
+   * The label for the Previous button.
+   */
+  previousButtonLabel: _propTypes.default.string
+};

package/lib/components/CoachmarkOverlayElements/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "CoachmarkOverlayElements", {
+  enumerable: true,
+  get: function get() {
+    return _CoachmarkOverlayElements.CoachmarkOverlayElements;
+  }
+});
+var _CoachmarkOverlayElements = require("./CoachmarkOverlayElements");

package/lib/components/CoachmarkStack/CoachmarkStack.js

@@ -0,0 +1,288 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CoachmarkStack = 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 _reactDom = require("react-dom");
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _classnames = _interopRequireDefault(require("classnames"));
+var _devtools = require("../../global/js/utils/devtools");
+var _settings = require("../../settings");
+var _CoachmarkOverlay = require("../Coachmark/CoachmarkOverlay");
+var _CoachmarkStackHome = require("./CoachmarkStackHome");
+var _CoachmarkTagline = require("../Coachmark/CoachmarkTagline");
+var _context = require("../Coachmark/utils/context");
+var _enums = require("../Coachmark/utils/enums");
+var _excluded = ["children", "className", "onClose", "description", "media", "navLinkLabels", "portalTarget", "closeButtonLabel", "tagline", "theme", "title"];
+/**
+ * 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 portions of React that are needed.
+// Other standard imports.
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+// Carbon and package components we use.
+/* TODO: @import(s) of carbon components and other package components. */ // The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(_settings.pkg.prefix, "--coachmark-stack");
+var componentName = 'CoachmarkStack';
+var elementBlockClass = "".concat(_settings.pkg.prefix, "--coachmark-stack-element");
+var defaults = {
+  onClose: function onClose() {},
+  // Pass through to CoachmarkStackHome
+  theme: 'light'
+};
+
+// NOTE
+// The stack is limited to a depth of two Coachmarks:
+// - a single parent CoachmarkStackHome
+// - a single child Coachmark when stacked
+// The parent will include links to all the children.
+// No child Coachmark will include links to any other child Coachmarks.
+
+/**
+ * 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.
+ */
+var CoachmarkStack = exports.CoachmarkStack = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
+  var _document$querySelect;
+  var children = _ref.children,
+    className = _ref.className,
+    _ref$onClose = _ref.onClose,
+    onClose = _ref$onClose === void 0 ? defaults.onClose : _ref$onClose,
+    description = _ref.description,
+    media = _ref.media,
+    navLinkLabels = _ref.navLinkLabels,
+    _ref$portalTarget = _ref.portalTarget,
+    portalTarget = _ref$portalTarget === void 0 ? defaults.portalTarget : _ref$portalTarget,
+    closeButtonLabel = _ref.closeButtonLabel,
+    tagline = _ref.tagline,
+    _ref$theme = _ref.theme,
+    theme = _ref$theme === void 0 ? defaults.theme : _ref$theme,
+    title = _ref.title,
+    rest = (0, _objectWithoutProperties2.default)(_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 = (0, _react.useRef)();
+  var stackedCoachmarkRefs = (0, _react.useRef)([]);
+  var _useState = (0, _react.useState)(false),
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    isOpen = _useState2[0],
+    setIsOpen = _useState2[1];
+  // selectedItemNumber -1 = parent close button was clicked, remove entire stack
+  // selectedItemNumber 0 = (default) the parent is visible, all children are hidden
+  // selectedItemNumber 1+ = a child is visible and stacked atop the parent
+  var _useState3 = (0, _react.useState)(0),
+    _useState4 = (0, _slicedToArray2.default)(_useState3, 2),
+    selectedItemNumber = _useState4[0],
+    setSelectedItemNumber = _useState4[1];
+  // // The parent height and width values to return to after unstacked
+  var _useState5 = (0, _react.useState)(null),
+    _useState6 = (0, _slicedToArray2.default)(_useState5, 2),
+    parentHeight = _useState6[0],
+    setParentHeight = _useState6[1];
+  // parent height = child height when stacked behind a child that is shorter
+  var childArray = _react.Children.toArray(children);
+  var mountedRef = (0, _react.useRef)();
+  // same value as CSS animation speed
+  var delayMs = 240;
+
+  // Unmount or unstack a child
+  var handleClickNavItem = function handleClickNavItem(itemNumber) {
+    setSelectedItemNumber(itemNumber);
+  };
+  var handleClose = (0, _react.useCallback)(function (isParentCloseButton) {
+    if (isParentCloseButton) {
+      // Trigger slide-out animation
+      setSelectedItemNumber(-1);
+
+      // Unmount after animation is complete
+      var timer = setTimeout(function () {
+        setIsOpen(false);
+        onClose();
+      }, delayMs);
+      return function () {
+        return clearTimeout(timer);
+      };
+    } else {
+      // Unstack child
+      setSelectedItemNumber(0);
+    }
+  }, [onClose]);
+  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 contextValue = {
+    buttonProps: {
+      tabIndex: 0,
+      'aria-expanded': isOpen,
+      onClick: function onClick() {
+        setIsOpen(true);
+      },
+      // Compensate for accidental open/close on double-click.
+      // Only open on double-click.
+      onDoubleClick: function onDoubleClick() {
+        setIsOpen(true);
+      }
+    },
+    closeButtonProps: {
+      onClick: function onClick() {
+        return handleClose(false);
+      }
+    },
+    isOpen: isOpen
+  };
+  (0, _react.useEffect)(function () {
+    mountedRef.current = true;
+    return function () {
+      mountedRef.current = false;
+    };
+  }, []);
+  (0, _react.useEffect)(function () {
+    setTimeout(function () {
+      if (stackHomeRef.current) {
+        setParentHeight(stackHomeRef.current.clientHeight + 16);
+      }
+    }, 0);
+  }, [stackHomeRef]);
+  (0, _react.useEffect)(function () {
+    var targetSelectedItem = selectedItemNumber - 1;
+    if (!parentHeight) {
+      return;
+    }
+    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") : '';
+    return /*#__PURE__*/_react.default.createElement(_CoachmarkOverlay.CoachmarkOverlay, {
+      key: idx,
+      ref: function ref(_ref2) {
+        return stackedCoachmarkRefs.current[idx] = _ref2;
+      },
+      kind: _enums.COACHMARK_OVERLAY_KIND.STACKED,
+      onClose: function onClose() {
+        return handleClose(false);
+      },
+      theme: theme,
+      fixedIsVisible: false,
+      className: (0, _classnames.default)(elementBlockClass, mountedClass, idx === selectedItemNumber - 1 && "".concat(elementBlockClass, "--is-visible"), mountedRef.current && "".concat(elementBlockClass, "--is-mounted"))
+    }, child);
+  });
+  return /*#__PURE__*/_react.default.createElement(_context.CoachmarkContext.Provider, {
+    value: contextValue
+  }, /*#__PURE__*/_react.default.createElement("div", (0, _extends2.default)({}, rest, {
+    className: (0, _classnames.default)(blockClass, "".concat(_settings.pkg.prefix, "--coachmark-overlay--stack"), className),
+    ref: ref
+  }, (0, _devtools.getDevtoolsProps)(componentName)), /*#__PURE__*/_react.default.createElement(_CoachmarkTagline.CoachmarkTagline, {
+    title: tagline,
+    onClose: onClose
+  }), /*#__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,
+    onClickNavItem: handleClickNavItem,
+    onClose: function onClose() {
+      handleClose(true);
+    },
+    portalTarget: portalTarget,
+    closeButtonLabel: closeButtonLabel,
+    title: title
+  }), /*#__PURE__*/(0, _reactDom.createPortal)(wrappedChildren, portalNode)));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.CoachmarkStack = CoachmarkStack = _settings.pkg.checkComponentEnabled(CoachmarkStack, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+CoachmarkStack.displayName = componentName;
+
+// The types and DocGen commentary for the component props,
+// in alphabetical order (for consistency).
+// See https://www.npmjs.com/package/prop-types#usage.
+CoachmarkStack.propTypes = {
+  /**
+   * CoachmarkStack should use a single CoachmarkOverlayElements component as a child.
+   */
+  children: _propTypes.default.node.isRequired,
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: _propTypes.default.string,
+  /**
+   * The label for the button that will close the Stack
+   */
+  closeButtonLabel: _propTypes.default.string,
+  // Pass through to CoachmarkStackHome
+  /**
+   * The description of the Coachmark.
+   */
+  description: _propTypes.default.node.isRequired,
+  /**
+   * 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: _propTypes.default.oneOfType([_propTypes.default.shape({
+    render: _propTypes.default.func
+  }), _propTypes.default.shape({
+    filePaths: _propTypes.default.arrayOf(_propTypes.default.string)
+  })]),
+  /**
+   * The labels used to link to the stackable Coachmarks.
+   */
+  navLinkLabels: _propTypes.default.arrayOf(_propTypes.default.string).isRequired,
+  /**
+   * Function to call when the CoachmarkStack closes.
+   */
+  onClose: _propTypes.default.func,
+  /**
+   * Where in the DOM to render the stack.
+   * The default is `document.body`.
+   */
+  portalTarget: _propTypes.default.string,
+  /**
+   * The tagline title which will be fixed to the bottom right of the window and will serve as the display trigger.
+   */
+  tagline: _propTypes.default.string.isRequired,
+  /**
+   * Determines the theme of the component.
+   */
+  theme: _propTypes.default.oneOf(['light', 'dark']),
+  /**
+   * The title of the Coachmark.
+   */
+  title: _propTypes.default.string.isRequired
+};