@carbon/ibm-products 2.22.0 → 2.24.0

package/lib/components/CoachmarkBeacon/CoachmarkBeacon.js

@@ -0,0 +1,97 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CoachmarkBeacon = 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 _Coachmark = require("../Coachmark");
+var _devtools = require("../../global/js/utils/devtools");
+var _settings = require("../../settings");
+var _excluded = ["label", "className", "kind"];
+/**
+ * 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.
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(_settings.pkg.prefix, "--coachmark-beacon");
+var componentName = 'CoachmarkBeacon';
+var defaults = {
+  kind: 'default'
+};
+
+/**
+ * Use beacon for the target prop of a Coachmark component.
+ */
+var CoachmarkBeacon = exports.CoachmarkBeacon = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
+  var _coachmark$positionTu, _coachmark$positionTu2, _coachmark$positionTu3, _coachmark$positionTu4;
+  var label = _ref.label,
+    className = _ref.className,
+    _ref$kind = _ref.kind,
+    kind = _ref$kind === void 0 ? defaults.kind : _ref$kind,
+    rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  var coachmark = (0, _Coachmark.useCoachmark)();
+  if (!coachmark) {
+    return /*#__PURE__*/_react.default.createElement("div", null, "CoachmarkBeacon is to be use exclusively within the target prop of Coachmark");
+  }
+  var overlayPositionStyle = {
+    top: (_coachmark$positionTu = (_coachmark$positionTu2 = coachmark.positionTune) === null || _coachmark$positionTu2 === void 0 ? void 0 : _coachmark$positionTu2.y) !== null && _coachmark$positionTu !== void 0 ? _coachmark$positionTu : 0,
+    left: (_coachmark$positionTu3 = (_coachmark$positionTu4 = coachmark.positionTune) === null || _coachmark$positionTu4 === void 0 ? void 0 : _coachmark$positionTu4.x) !== null && _coachmark$positionTu3 !== void 0 ? _coachmark$positionTu3 : 0
+  };
+  return /*#__PURE__*/_react.default.createElement("span", (0, _extends2.default)({}, rest, {
+    className: (0, _classnames.default)(blockClass, "".concat(blockClass, "-").concat(kind), className),
+    ref: ref,
+    style: overlayPositionStyle
+  }, (0, _devtools.getDevtoolsProps)(componentName), {
+    role: "tooltip"
+  }), /*#__PURE__*/_react.default.createElement("button", (0, _extends2.default)({
+    tabIndex: 0,
+    type: "button"
+  }, coachmark.buttonProps, {
+    "aria-label": label,
+    className: "".concat(blockClass, "__target")
+  }), /*#__PURE__*/_react.default.createElement("svg", {
+    className: "".concat(blockClass, "__center"),
+    alt: ""
+  }, /*#__PURE__*/_react.default.createElement("circle", {
+    r: 1,
+    cx: 38,
+    cy: 38
+  }))));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.CoachmarkBeacon = CoachmarkBeacon = _settings.pkg.checkComponentEnabled(CoachmarkBeacon, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+CoachmarkBeacon.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.
+CoachmarkBeacon.propTypes = {
+  /**
+   * Optional class name for this component.
+   */
+  className: _propTypes.default.string,
+  /**
+   * What style of beacon.
+   * BEACON_KIND is an exported enum from the Coachmark and can be used for this value.
+   * @see {@link BEACON_KIND}
+   */
+  kind: _propTypes.default.oneOf(['default']),
+  /**
+   * The aria label.
+   */
+  label: _propTypes.default.string.isRequired
+};

package/lib/components/CoachmarkBeacon/index.js

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

package/lib/components/CoachmarkButton/CoachmarkButton.js

@@ -0,0 +1,93 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CoachmarkButton = 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 _react2 = require("@carbon/react");
+var _Coachmark = require("../Coachmark");
+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.
+// Other standard imports.
+// 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-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.
+ */
+var CoachmarkButton = exports.CoachmarkButton = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
+  var className = _ref.className,
+    label = _ref.label,
+    rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  var coachmark = (0, _Coachmark.useCoachmark)();
+  if (!coachmark) {
+    return /*#__PURE__*/_react.default.createElement("div", null, "CoachmarkButton is to be use exclusively within the target prop of Coachmark");
+  }
+  return /*#__PURE__*/_react.default.createElement(_react2.Button, (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: "button",
+    "aria-label": label
+  }, (0, _devtools.getDevtoolsProps)(componentName), coachmark.buttonProps), label);
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.CoachmarkButton = CoachmarkButton = _settings.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.default.string,
+  /**
+   * The aria label.
+   */
+  label: _propTypes.default.string.isRequired
+};

package/lib/components/CoachmarkButton/index.js

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

package/lib/components/CoachmarkFixed/CoachmarkFixed.js

@@ -0,0 +1,232 @@
+"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 _devtools = require("../../global/js/utils/devtools");
+var _settings = require("../../settings");
+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 _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.
+// 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 coachmarkClass = "".concat(_settings.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.
+ */
+var CoachmarkFixed = exports.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 prefersReducedMotion = window.matchMedia('(prefers-reduced-motion: reduce)');
+  var handleClose = (0, _react.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 = (0, _react.useCallback)(function (event) {
+    if (event.key === 'Escape') {
+      handleClose();
+    }
+  }, [handleClose]);
+  (0, _react.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
+  (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,
+    className: (0, _classnames.default)(fixedIsVisible && "".concat(overlayBlockClass, "--is-visible"), overlayBlockClass)
+  }, children), portalNode)));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+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,90 @@
+"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"];
+/**
+ * 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.
+// 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 = exports.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 = _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");