@carbon/ibm-products 2.23.0 → 2.24.0

package/es/components/CoachmarkButton/CoachmarkButton.js

@@ -0,0 +1,90 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["className", "label"];
+/**
+ * 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.
+import React from 'react';
+
+// Other standard imports.
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { getDevtoolsProps } from '../../global/js/utils/devtools';
+import { pkg /*, carbon */ } from '../../settings';
+import { Button } from '@carbon/react';
+import { useCoachmark } from '../Coachmark';
+// 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(pkg.prefix, "--coachmark-button");
+var componentName = 'CoachmarkButton';
+
+// 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
+// const defaults = {
+//   /* TODO: add defaults for relevant props if needed */
+// };
+
+/**
+ * Use CoachmarkButton for the target prop of a Coachmark component.
+ */
+export var CoachmarkButton = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
+  var className = _ref.className,
+    label = _ref.label,
+    rest = _objectWithoutProperties(_ref, _excluded);
+  var coachmark = useCoachmark();
+  if (!coachmark) {
+    return /*#__PURE__*/React.createElement("div", null, "CoachmarkButton is to be use exclusively within the target prop of Coachmark");
+  }
+  return /*#__PURE__*/React.createElement(Button, _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.
+    // 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: "button",
+    "aria-label": label
+  }, getDevtoolsProps(componentName), coachmark.buttonProps), label);
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+CoachmarkButton = pkg.checkComponentEnabled(CoachmarkButton, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+CoachmarkButton.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.
+CoachmarkButton.propTypes = {
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: PropTypes.string,
+  /**
+   * The aria label.
+   */
+  label: PropTypes.string.isRequired
+};

package/es/components/CoachmarkButton/index.js

@@ -0,0 +1,8 @@
+/**
+ * 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';

package/es/components/CoachmarkFixed/CoachmarkFixed.js

@@ -0,0 +1,226 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["children", "className", "onClose", "portalTarget", "tagline", "theme"];
+/**
+ * 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.
+import React, { useEffect, useRef, useState, useCallback } from 'react';
+
+// Other standard imports.
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { getDevtoolsProps } from '../../global/js/utils/devtools';
+import { pkg /*, carbon */ } from '../../settings';
+import { createPortal } from 'react-dom';
+import { CoachmarkOverlay } from '../Coachmark/CoachmarkOverlay';
+import { CoachmarkTagline } from '../Coachmark/CoachmarkTagline';
+import { CoachmarkContext } from '../Coachmark/utils/context';
+import { COACHMARK_OVERLAY_KIND } from '../Coachmark/utils/enums';
+// 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 coachmarkClass = "".concat(pkg.prefix, "--coachmark");
+var blockClass = "".concat(coachmarkClass, "-fixed");
+var overlayBlockClass = "".concat(coachmarkClass, "-overlay");
+var componentName = 'CoachmarkFixed';
+var defaults = {
+  onClose: function onClose() {},
+  theme: 'light',
+  tagline: ''
+};
+
+/**
+ * Fixed 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 a coachmark overlay to be displayed by interacting with the tagline.
+ */
+export var CoachmarkFixed = /*#__PURE__*/React.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,
+    portalTarget = _ref.portalTarget,
+    _ref$tagline = _ref.tagline,
+    tagline = _ref$tagline === void 0 ? defaults.tagline : _ref$tagline,
+    _ref$theme = _ref.theme,
+    theme = _ref$theme === void 0 ? defaults.theme : _ref$theme,
+    rest = _objectWithoutProperties(_ref, _excluded);
+  var overlayRef = useRef();
+  var portalNode = portalTarget ? (_document$querySelect = document.querySelector(portalTarget)) !== null && _document$querySelect !== void 0 ? _document$querySelect : document.querySelector('body') : document.querySelector('body');
+  var _useState = useState(false),
+    _useState2 = _slicedToArray(_useState, 2),
+    isOpen = _useState2[0],
+    setIsOpen = _useState2[1];
+  var _useState3 = useState(false),
+    _useState4 = _slicedToArray(_useState3, 2),
+    shouldResetPosition = _useState4[0],
+    setShouldResetPosition = _useState4[1];
+  var _useState5 = useState(),
+    _useState6 = _slicedToArray(_useState5, 2),
+    targetRect = _useState6[0],
+    setTargetRect = _useState6[1];
+  var _useState7 = useState({
+      x: 0,
+      y: 0
+    }),
+    _useState8 = _slicedToArray(_useState7, 2),
+    targetOffset = _useState8[0],
+    setTargetOffset = _useState8[1];
+  var _useState9 = useState(false),
+    _useState10 = _slicedToArray(_useState9, 2),
+    fixedIsVisible = _useState10[0],
+    setFixedIsVisible = _useState10[1];
+  var prefersReducedMotion = window.matchMedia('(prefers-reduced-motion: reduce)');
+  var handleClose = useCallback(function () {
+    console.log('HANDLING CLOSE HERE...');
+    if (prefersReducedMotion.matches) {
+      setIsOpen(false);
+    } else {
+      setFixedIsVisible(false);
+    }
+  }, [prefersReducedMotion.matches]);
+  var handleTransitionEnd = function handleTransitionEnd(e) {
+    console.log('Hererrrrrreee at transition end... ', e.propertyName === 'transform' && !fixedIsVisible);
+    if (e.propertyName === 'transform' && !fixedIsVisible) {
+      setIsOpen(false);
+      onClose();
+    }
+  };
+  var handleTargetClick = function handleTargetClick(e) {
+    setTargetRect(e.target.getBoundingClientRect());
+    setTargetOffset({
+      x: e.target.offsetLeft,
+      y: e.target.offsetTop
+    });
+    // reset position for all other kinds
+    setIsOpen(false);
+    setShouldResetPosition(true);
+  };
+  var escFunction = useCallback(function (event) {
+    if (event.key === 'Escape') {
+      handleClose();
+    }
+  }, [handleClose]);
+  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.
+      onDoubleClick: handleTargetClick
+    },
+    closeButtonProps: {
+      onClick: handleClose
+    },
+    targetRect: targetRect,
+    targetOffset: targetOffset,
+    isOpen: isOpen,
+    tacos: 'tacos'
+  };
+
+  // instead of toggling on/off,
+  // keep open and reset to original position
+  useEffect(function () {
+    if (shouldResetPosition) {
+      setShouldResetPosition(false);
+      setIsOpen(true);
+    }
+  }, [shouldResetPosition]);
+  useEffect(function () {
+    setFixedIsVisible(isOpen);
+  }, [isOpen]);
+
+  // On unmount:
+  // - DO NOT "Close()" the coachmark.
+  //   - This triggers a "signal" to close it forever.
+  //   - "Closing" should only ever be a user-triggered event.
+  // - DO "hide" the coachmark.
+  //   - The app is doing the action for the user.
+  //   - The user will have the opportunity to open it again.
+  useEffect(function () {
+    return function () {
+      return setIsOpen(false);
+    };
+  }, []);
+  return /*#__PURE__*/React.createElement(CoachmarkContext.Provider, {
+    value: contextValue
+  }, /*#__PURE__*/React.createElement("div", _extends({}, rest, {
+    className: cx(blockClass, // Apply the block class to the main HTML element
+    "".concat(blockClass, "__").concat(theme), className // Apply any supplied class names to the main HTML element.
+    ),
+
+    ref: ref
+  }, getDevtoolsProps(componentName)), /*#__PURE__*/React.createElement(CoachmarkTagline, {
+    title: tagline,
+    onClose: onClose
+  }), isOpen && /*#__PURE__*/createPortal( /*#__PURE__*/React.createElement(CoachmarkOverlay, {
+    ref: overlayRef,
+    fixedIsVisible: fixedIsVisible,
+    kind: COACHMARK_OVERLAY_KIND.FIXED,
+    onClose: handleClose,
+    onTransitionEnd: handleTransitionEnd,
+    theme: theme,
+    className: cx(fixedIsVisible && "".concat(overlayBlockClass, "--is-visible"), overlayBlockClass)
+  }, children), portalNode)));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+CoachmarkFixed = pkg.checkComponentEnabled(CoachmarkFixed, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+CoachmarkFixed.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.
+CoachmarkFixed.propTypes = {
+  // TODO: Add this to MDX as will be done with Coachmark
+  /**
+   * CoachmarkFixed should use a single CoachmarkOverlayElements component as a child.
+   */
+  children: PropTypes.node.isRequired,
+  /**
+   * Optional class name for this component.
+   */
+  className: PropTypes.string,
+  /**
+   * Function to call when the Coachmark closes.
+   */
+  onClose: PropTypes.func,
+  /**
+   * By default, the Coachmark will be appended to the end of `document.body`.
+   * The Coachmark will remain persistent as the user navigates the app until
+   * the user closes the Coachmark.
+   *
+   * Alternatively, the app developer can tightly couple the Coachmark to a DOM
+   * element or other component by specifying a CSS selector. The Coachmark will
+   * remain visible as long as that element remains visible or mounted. When the
+   * element is hidden or component is unmounted, the Coachmark will disappear.
+   */
+  portalTarget: PropTypes.string,
+  /**
+   * The tagline title which will be fixed to the bottom right of the window and will serve as the display trigger.
+   */
+  tagline: PropTypes.string.isRequired,
+  /**
+   * Determines the theme of the component.
+   */
+  theme: PropTypes.oneOf(['light', 'dark'])
+};

package/es/components/CoachmarkFixed/index.js

@@ -0,0 +1,8 @@
+/**
+ * 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';

package/es/components/CoachmarkOverlayElement/CoachmarkOverlayElement.js

@@ -0,0 +1,86 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["button", "className", "description", "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.
+import React from 'react';
+
+// Other standard imports.
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { getDevtoolsProps } from '../../global/js/utils/devtools';
+import { pkg /*, carbon */ } from '../../settings';
+
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(pkg.prefix, "--coachmark-overlay-element");
+var componentName = 'CoachmarkOverlayElement';
+
+/**
+ * Component to be displayed within a CoachmarkOverlayElements container.
+ * Can be used 1 to N number, to display content in a Coachmark's overlay
+ * in a carousel fashion.
+ */
+export var CoachmarkOverlayElement = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
+  var button = _ref.button,
+    className = _ref.className,
+    description = _ref.description,
+    title = _ref.title,
+    rest = _objectWithoutProperties(_ref, _excluded);
+  return /*#__PURE__*/React.createElement("div", _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.
+    // 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"
+  }, getDevtoolsProps(componentName)), /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "__content")
+  }, title && /*#__PURE__*/React.createElement("h2", {
+    className: "".concat(blockClass, "__title")
+  }, title), description && /*#__PURE__*/React.createElement("p", {
+    className: "".concat(blockClass, "__body")
+  }, description)), button && /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "__button")
+  }, button));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+CoachmarkOverlayElement = pkg.checkComponentEnabled(CoachmarkOverlayElement, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+CoachmarkOverlayElement.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.
+CoachmarkOverlayElement.propTypes = {
+  /**
+   * An optional button can be rendered below the description.
+   * This can be a link, button, Coachmark button, etc.
+   */
+  button: PropTypes.node,
+  /**
+   * Optional class name for this component.
+   */
+  className: PropTypes.string,
+  /**
+   * The description of the Coachmark.
+   */
+  description: PropTypes.node.isRequired,
+  /**
+   * The title of the Coachmark.
+   */
+  title: PropTypes.string.isRequired
+};

package/es/components/CoachmarkOverlayElement/index.js

@@ -0,0 +1,8 @@
+/**
+ * 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';

package/es/components/CoachmarkOverlayElements/CoachmarkOverlayElements.js

@@ -0,0 +1,216 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+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.
+import React, { Children, useEffect, useRef, useState } from 'react';
+
+// Other standard imports.
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { getDevtoolsProps } from '../../global/js/utils/devtools';
+import { pkg /*, carbon */ } from '../../settings';
+
+// Carbon and package components we use.
+import { Button } from '@carbon/react';
+import { useCoachmark } from '../Coachmark';
+import { clamp } from 'lodash';
+import pconsole from '../../global/js/utils/pconsole';
+//TODO THIS PATH WILL NEED TO BE UPDATED ONCE IN IBM PRODUCTS
+import { Carousel } from '../Carousel';
+//TODO THIS PATH WILL NEED TO BE UPDATED ONCE IN IBM PRODUCTS
+import { SteppedAnimatedMedia } from '../SteppedAnimatedMedia';
+
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(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.
+ */
+export var CoachmarkOverlayElements = /*#__PURE__*/React.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 = _objectWithoutProperties(_ref, _excluded);
+  var buttonFocusRef = useRef();
+  var scrollRef = useRef();
+  var _useState = useState(0),
+    _useState2 = _slicedToArray(_useState, 2),
+    scrollPosition = _useState2[0],
+    setScrollPosition = _useState2[1];
+  var _useState3 = useState(0),
+    _useState4 = _slicedToArray(_useState3, 2),
+    currentProgStep = _useState4[0],
+    _setCurrentProgStep = _useState4[1];
+  var coachmark = useCoachmark();
+  var setCurrentProgStep = function setCurrentProgStep(value) {
+    if (currentProgStep > 0 && value === 0 && buttonFocusRef.current) {
+      setTimeout(function () {
+        buttonFocusRef.current.focus();
+      }, 1000);
+    }
+    _setCurrentProgStep(value);
+  };
+  var numProgSteps = Children.count(children);
+  var progStepFloor = 0;
+  var progStepCeil = numProgSteps - 1;
+  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();
+    }
+  }, []);
+  useEffect(function () {
+    setTimeout(function () {
+      if (buttonFocusRef.current && isVisible) {
+        buttonFocusRef.current.focus();
+      }
+    }, 100);
+  }, [isVisible]);
+  if (!coachmark) {
+    return pconsole.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.createElement("section", _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.
+    // 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"
+  }, getDevtoolsProps(componentName)), media && (media.render ? media.render() : /*#__PURE__*/React.createElement(SteppedAnimatedMedia, {
+    className: "".concat(blockClass, "__element-stepped-media"),
+    filePaths: media.filePaths,
+    playStep: currentProgStep
+  })), 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(Button, _extends({
+    size: "sm"
+  }, coachmark.closeButtonProps, {
+    ref: buttonFocusRef
+  }), closeButtonLabel))) : /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Carousel, {
+    disableArrowScroll: true,
+    ref: scrollRef,
+    onScroll: function onScroll(scrollPercent) {
+      setScrollPosition(scrollPercent);
+    }
+  }, 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.createElement(Button, {
+    size: "sm",
+    kind: "ghost",
+    title: previousButtonLabel,
+    disabled: scrollPosition === 0,
+    onClick: function onClick() {
+      var targetStep = clamp(currentProgStep - 1, progStepFloor, progStepCeil);
+      scrollRef.current.scrollToView(targetStep);
+      setCurrentProgStep(targetStep);
+    }
+  }, previousButtonLabel), currentProgStep < progStepCeil ? /*#__PURE__*/React.createElement(Button, {
+    size: "sm",
+    ref: buttonFocusRef,
+    title: nextButtonText,
+    disabled: scrollPosition === 1,
+    onClick: function onClick() {
+      var targetStep = clamp(currentProgStep + 1, progStepFloor, progStepCeil);
+      scrollRef.current.scrollToView(targetStep);
+      setCurrentProgStep(targetStep);
+    }
+  }, nextButtonText) : closeButtonLabel && /*#__PURE__*/React.createElement(Button, _extends({
+    size: "sm",
+    ref: buttonFocusRef
+  }, coachmark.closeButtonProps), closeButtonLabel))));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+CoachmarkOverlayElements = 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.node.isRequired,
+  /**
+   * Optional class name for this component.
+   */
+  className: PropTypes.string,
+  /**
+   * The label for the Close button.
+   */
+  closeButtonLabel: PropTypes.string,
+  /**
+   * The visibility of CoachmarkOverlayElements is
+   * managed in the parent component.
+   */
+  isVisible: PropTypes.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.oneOfType([PropTypes.shape({
+    render: PropTypes.func
+  }), PropTypes.shape({
+    filePaths: PropTypes.arrayOf(PropTypes.string)
+  })]),
+  /**
+   * The label for the Next button.
+   */
+  nextButtonText: PropTypes.string,
+  /**
+   * The label for the Previous button.
+   */
+  previousButtonLabel: PropTypes.string
+};

package/es/components/CoachmarkOverlayElements/index.js

@@ -0,0 +1,8 @@
+/**
+ * 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';