@carbon/ibm-products 1.55.2 → 1.57.0

package/lib/components/CoachmarkFixed/CoachmarkFixed.js

@@ -0,0 +1,201 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CoachmarkFixed = 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 _reactDom = require("react-dom");
+var _CoachmarkOverlay = require("../Coachmark/CoachmarkOverlay");
+var _CoachmarkTagline = require("../Coachmark/CoachmarkTagline");
+var _context = require("../Coachmark/utils/context");
+var _enums = require("../Coachmark/utils/enums");
+var _devtools = require("../../global/js/utils/devtools");
+var _settings = require("../../settings");
+var _excluded = ["children", "className", "onClose", "portalTarget", "tagline", "theme"];
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(_settings.pkg.prefix, "--coachmark-fixed");
+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.
+ */
+var CoachmarkFixed = /*#__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,
+    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 = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  var overlayRef = (0, _react.useRef)();
+  var portalNode = portalTarget ? (_document$querySelect = document.querySelector(portalTarget)) !== null && _document$querySelect !== void 0 ? _document$querySelect : document.querySelector('body') : document.querySelector('body');
+  var _useState = (0, _react.useState)(false),
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    isOpen = _useState2[0],
+    setIsOpen = _useState2[1];
+  var _useState3 = (0, _react.useState)(false),
+    _useState4 = (0, _slicedToArray2.default)(_useState3, 2),
+    shouldResetPosition = _useState4[0],
+    setShouldResetPosition = _useState4[1];
+  var _useState5 = (0, _react.useState)(),
+    _useState6 = (0, _slicedToArray2.default)(_useState5, 2),
+    targetRect = _useState6[0],
+    setTargetRect = _useState6[1];
+  var _useState7 = (0, _react.useState)({
+      x: 0,
+      y: 0
+    }),
+    _useState8 = (0, _slicedToArray2.default)(_useState7, 2),
+    targetOffset = _useState8[0],
+    setTargetOffset = _useState8[1];
+  var _useState9 = (0, _react.useState)(false),
+    _useState10 = (0, _slicedToArray2.default)(_useState9, 2),
+    fixedIsVisible = _useState10[0],
+    setFixedIsVisible = _useState10[1];
+  var handleClose = function handleClose() {
+    setFixedIsVisible(false);
+  };
+  var handleTransitionEnd = function handleTransitionEnd(e) {
+    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 contextValue = {
+    buttonProps: {
+      'aria-expanded': isOpen,
+      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
+  };
+
+  // instead of toggling on/off,
+  // keep open and reset to original position
+  (0, _react.useEffect)(function () {
+    if (shouldResetPosition) {
+      setShouldResetPosition(false);
+      setIsOpen(true);
+    }
+  }, [shouldResetPosition]);
+  (0, _react.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.
+  (0, _react.useEffect)(function () {
+    return function () {
+      return setIsOpen(false);
+    };
+  }, []);
+  return /*#__PURE__*/_react.default.createElement(_context.CoachmarkContext.Provider, {
+    value: contextValue
+  }, /*#__PURE__*/_react.default.createElement("div", (0, _extends2.default)({}, rest, {
+    className: (0, _classnames.default)(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
+  }, (0, _devtools.getDevtoolsProps)(componentName)), /*#__PURE__*/_react.default.createElement(_CoachmarkTagline.CoachmarkTagline, {
+    title: tagline,
+    onClose: onClose
+  }), isOpen && /*#__PURE__*/(0, _reactDom.createPortal)( /*#__PURE__*/_react.default.createElement(_CoachmarkOverlay.CoachmarkOverlay, {
+    ref: overlayRef,
+    fixedIsVisible: fixedIsVisible,
+    kind: _enums.COACHMARK_OVERLAY_KIND.FIXED,
+    onClose: handleClose,
+    onTransitionEnd: handleTransitionEnd,
+    theme: theme
+  }, children), portalNode)));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.CoachmarkFixed = CoachmarkFixed;
+exports.CoachmarkFixed = CoachmarkFixed = _settings.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.default.node.isRequired,
+  /**
+   * Optional class name for this component.
+   */
+  className: _propTypes.default.string,
+  /**
+   * Function to call when the Coachmark closes.
+   */
+  onClose: _propTypes.default.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.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'])
+};

package/lib/components/CoachmarkFixed/index.js

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

package/lib/components/CoachmarkOverlayElement/CoachmarkOverlayElement.js

@@ -0,0 +1,83 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CoachmarkOverlayElement = void 0;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+var _react = _interopRequireDefault(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 _excluded = ["button", "className", "description", "title"];
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(_settings.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.
+ */
+var CoachmarkOverlayElement = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
+  var button = _ref.button,
+    className = _ref.className,
+    description = _ref.description,
+    title = _ref.title,
+    rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  return /*#__PURE__*/_react.default.createElement("div", (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)), /*#__PURE__*/_react.default.createElement("div", {
+    className: "".concat(blockClass, "__content")
+  }, title && /*#__PURE__*/_react.default.createElement("h2", {
+    className: "".concat(blockClass, "__title")
+  }, title), description && /*#__PURE__*/_react.default.createElement("p", {
+    className: "".concat(blockClass, "__body")
+  }, description)), button && /*#__PURE__*/_react.default.createElement("div", {
+    className: "".concat(blockClass, "__button")
+  }, button));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.CoachmarkOverlayElement = CoachmarkOverlayElement;
+exports.CoachmarkOverlayElement = CoachmarkOverlayElement = _settings.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.default.node,
+  /**
+   * Optional class name for this component.
+   */
+  className: _propTypes.default.string,
+  /**
+   * The description of the Coachmark.
+   */
+  description: _propTypes.default.node.isRequired,
+  /**
+   * The title of the Coachmark.
+   */
+  title: _propTypes.default.string.isRequired
+};

package/lib/components/CoachmarkOverlayElement/index.js

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

package/lib/components/CoachmarkOverlayElements/CoachmarkOverlayElements.js

@@ -0,0 +1,176 @@
+"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 _carbonComponentsReact = require("carbon-components-react");
+var _classnames = _interopRequireDefault(require("classnames"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+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 _devtools = require("../../global/js/utils/devtools");
+var _settings = require("../../settings");
+var _excluded = ["className", "children", "media", "nextButtonText", "previousButtonLabel", "closeButtonLabel"];
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(_settings.pkg.prefix, "--coachmark-overlay-elements");
+var componentName = 'CoachmarkOverlayElements';
+var defaults = {
+  nextButtonText: 'Next',
+  previousButtonLabel: 'Back',
+  closeButtonLabel: 'Got it'
+};
+
+/**
+ * Composable container to allow for the displaying of CoachmarkOverlayElement
+ * components in a carousel fashion.
+ */
+var CoachmarkOverlayElements = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
+  var className = _ref.className,
+    children = _ref.children,
+    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 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();
+    }
+  }, []);
+  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(_carbonComponentsReact.Button, (0, _extends2.default)({
+    size: "sm"
+  }, coachmark.closeButtonProps), closeButtonLabel))) : /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement(_Carousel.Carousel, {
+    disableArrowScroll: true,
+    ref: scrollRef
+  }, children), /*#__PURE__*/_react.default.createElement("div", {
+    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(_carbonComponentsReact.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).then(function (scrollPercentage) {
+        setScrollPosition(scrollPercentage);
+      });
+      setCurrentProgStep(targetStep);
+    }
+  }, previousButtonLabel), currentProgStep < progStepCeil ? /*#__PURE__*/_react.default.createElement(_carbonComponentsReact.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).then(function (scrollPercentage) {
+        setScrollPosition(scrollPercentage);
+      });
+      setCurrentProgStep(targetStep);
+    }
+  }, nextButtonText) : closeButtonLabel && /*#__PURE__*/_react.default.createElement(_carbonComponentsReact.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;
+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 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");