@carbon/ibm-products 1.55.2 → 1.56.0

package/lib/components/Coachmark/CoachmarkHeader.js

@@ -0,0 +1,85 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CoachmarkHeader = 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 _iconsReact = require("@carbon/icons-react");
+var _carbonComponentsReact = require("carbon-components-react");
+var _devtools = require("../../global/js/utils/devtools");
+var _settings = require("../../settings");
+var _excluded = ["closeIconDescription", "onClose", "showCloseButton", "theme"];
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(_settings.pkg.prefix, "--coachmark-header");
+var componentName = 'CoachmarkHeader';
+var defaults = {
+  closeIconDescription: 'Close',
+  onClose: function onClose() {},
+  showCloseButton: true,
+  theme: 'light'
+};
+
+/**
+ * DO NOT USE. This component is for the exclusive use
+ * of other Novice to Pro components.
+ */
+var CoachmarkHeader = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
+  var _ref$closeIconDescrip = _ref.closeIconDescription,
+    closeIconDescription = _ref$closeIconDescrip === void 0 ? defaults.closeIconDescription : _ref$closeIconDescrip,
+    _ref$onClose = _ref.onClose,
+    onClose = _ref$onClose === void 0 ? defaults.onClose : _ref$onClose,
+    _ref$showCloseButton = _ref.showCloseButton,
+    showCloseButton = _ref$showCloseButton === void 0 ? defaults.showCloseButton : _ref$showCloseButton,
+    _ref$theme = _ref.theme,
+    theme = _ref$theme === void 0 ? defaults.theme : _ref$theme,
+    rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  return /*#__PURE__*/_react.default.createElement("header", (0, _extends2.default)({}, rest, {
+    className: (0, _classnames.default)(blockClass, "".concat(blockClass, "__").concat(theme)),
+    ref: ref
+    // role="main"
+  }, (0, _devtools.getDevtoolsProps)(componentName)), showCloseButton && /*#__PURE__*/_react.default.createElement(_carbonComponentsReact.Button, {
+    kind: "ghost",
+    size: "sm",
+    renderIcon: _iconsReact.Close16,
+    iconDescription: closeIconDescription,
+    hasIconOnly: true,
+    className: "".concat(blockClass, "--close-btn"),
+    onClick: onClose
+  }));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.CoachmarkHeader = CoachmarkHeader;
+exports.CoachmarkHeader = CoachmarkHeader = _settings.pkg.checkComponentEnabled(CoachmarkHeader, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+CoachmarkHeader.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.
+CoachmarkHeader.propTypes = {
+  /**
+   * Tooltip text and aria label for the Close button icon.
+   */
+  closeIconDescription: _propTypes.default.string,
+  /**
+   * Function to call when the close button is clicked.
+   */
+  onClose: _propTypes.default.func,
+  /**
+   * Show/hide the "X" close button.
+   */
+  showCloseButton: _propTypes.default.bool,
+  /**
+   * Determines the theme of the component.
+   */
+  theme: _propTypes.default.oneOf(['light', 'dark'])
+};

package/lib/components/Coachmark/CoachmarkOverlay.js

@@ -0,0 +1,139 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CoachmarkOverlay = void 0;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+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 _CoachmarkDragbar = require("./CoachmarkDragbar");
+var _CoachmarkHeader = require("./CoachmarkHeader");
+var _constants = require("./utils/constants");
+var _context = require("./utils/context");
+var _enums = require("./utils/enums");
+var _excluded = ["children", "onClose", "fixedIsVisible", "className", "kind", "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-overlay");
+var componentName = 'CoachmarkOverlay';
+
+// NOTE: the component SCSS is not imported here: it is rolled up separately.
+
+var defaults = {
+  kind: _enums.COACHMARK_OVERLAY_KIND.FLOATING,
+  theme: 'light'
+};
+
+/**
+ * DO NOT USE. This component is for the exclusive use
+ * of other Novice to Pro components.
+ */
+var CoachmarkOverlay = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
+  var children = _ref.children,
+    onClose = _ref.onClose,
+    fixedIsVisible = _ref.fixedIsVisible,
+    className = _ref.className,
+    _ref$kind = _ref.kind,
+    kind = _ref$kind === void 0 ? defaults.kind : _ref$kind,
+    _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 coachmark = (0, _context.useCoachmark)();
+  var isBeacon = kind === _enums.COACHMARK_OVERLAY_KIND.TOOLTIP;
+  var isDraggable = kind === _enums.COACHMARK_OVERLAY_KIND.FLOATING;
+  var styledTune = {};
+  // TODO: check this... this feels like it should be in a hook with no dep array.
+  if (isBeacon || isDraggable) {
+    if (coachmark.targetRect) {
+      styledTune = {
+        left: coachmark.targetRect.x + window.scrollX,
+        top: coachmark.targetRect.y + window.scrollY
+      };
+    }
+    if (isBeacon) {
+      // Compensate for radius of beacon
+      styledTune.left += 16;
+      styledTune.top += 16;
+    } else if (isDraggable) {
+      // Compensate for width and height of target element
+      var offsetTune = (0, _constants.getOffsetTune)(coachmark, kind);
+      styledTune.left += offsetTune.left;
+      styledTune.top += offsetTune.top;
+    }
+  }
+  function handleDrag(movementX, movementY) {
+    var overlay = overlayRef.current;
+    var _overlay$getBoundingC = overlay.getBoundingClientRect(),
+      x = _overlay$getBoundingC.x,
+      y = _overlay$getBoundingC.y;
+    overlay.style.transform = 'none';
+    overlay.style.position = 'fixed';
+    overlay.style.left = "".concat(x + movementX, "px");
+    overlay.style.top = "".concat(y + movementY, "px");
+    overlay.style.bottom = 'auto';
+  }
+  return /*#__PURE__*/_react.default.createElement("div", (0, _extends2.default)({}, rest, {
+    className: (0, _classnames.default)(blockClass, "".concat(blockClass, "--").concat(kind), "".concat(blockClass, "__").concat(theme), (isBeacon || isDraggable) && "".concat(blockClass, "--").concat(coachmark.align), fixedIsVisible && "".concat(blockClass, "--is-visible"), className),
+    ref: overlayRef,
+    style: styledTune
+  }, (0, _devtools.getDevtoolsProps)(componentName)), isDraggable ? /*#__PURE__*/_react.default.createElement(_CoachmarkDragbar.CoachmarkDragbar, {
+    onDrag: handleDrag,
+    onClose: onClose
+  }) : /*#__PURE__*/_react.default.createElement(_CoachmarkHeader.CoachmarkHeader, {
+    onClose: onClose
+  }), /*#__PURE__*/_react.default.createElement("div", {
+    className: "".concat(blockClass, "__body"),
+    ref: ref
+  }, children), isBeacon && /*#__PURE__*/_react.default.createElement("span", {
+    className: "".concat(blockClass, "__caret")
+  }));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.CoachmarkOverlay = CoachmarkOverlay;
+exports.CoachmarkOverlay = CoachmarkOverlay = _settings.pkg.checkComponentEnabled(CoachmarkOverlay, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+CoachmarkOverlay.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.
+CoachmarkOverlay.propTypes = {
+  /**
+   * The CoachmarkOverlayElements child components.
+   * Validation is handled in the parent Coachmark component.
+   */
+  children: _propTypes.default.node.isRequired,
+  /**
+   * Optional class name for this component.
+   */
+  className: _propTypes.default.string,
+  /**
+   * The visibility of CoachmarkOverlay is
+   * managed in the parent Coachmark component.
+   */
+  fixedIsVisible: _propTypes.default.bool.isRequired,
+  /**
+   * What kind or style of Coachmark to render.
+   */
+  kind: _propTypes.default.oneOf(Object.values(_enums.COACHMARK_OVERLAY_KIND)),
+  /**
+   * Function to call when the Coachmark closes.
+   */
+  onClose: _propTypes.default.func.isRequired,
+  /**
+   * Determines the theme of the component.
+   */
+  theme: _propTypes.default.oneOf(['light', 'dark'])
+};

package/lib/components/Coachmark/CoachmarkTagline.js

@@ -0,0 +1,90 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CoachmarkTagline = 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 _iconsReact = require("@carbon/icons-react");
+var _carbonComponentsReact = require("carbon-components-react");
+var _context = require("./utils/context");
+var _devtools = require("../../global/js/utils/devtools");
+var _settings = require("../../settings");
+var _excluded = ["closeIconDescription", "onClose", "theme", "title"];
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(_settings.pkg.prefix, "--coachmark-tagline");
+var componentName = 'CoachmarkTagline';
+var defaults = {
+  closeIconDescription: 'Close',
+  onClose: function onClose() {},
+  theme: 'light'
+};
+
+/**
+ * DO NOT USE. This component is for the exclusive use
+ * of other Novice to Pro components.
+ */
+var CoachmarkTagline = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
+  var _ref$closeIconDescrip = _ref.closeIconDescription,
+    closeIconDescription = _ref$closeIconDescrip === void 0 ? defaults.closeIconDescription : _ref$closeIconDescrip,
+    _ref$onClose = _ref.onClose,
+    onClose = _ref$onClose === void 0 ? defaults.onClose : _ref$onClose,
+    _ref$theme = _ref.theme,
+    theme = _ref$theme === void 0 ? defaults.theme : _ref$theme,
+    title = _ref.title,
+    rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  var coachmark = (0, _context.useCoachmark)();
+  return /*#__PURE__*/_react.default.createElement("div", (0, _extends2.default)({}, rest, {
+    className: (0, _classnames.default)(blockClass, "".concat(blockClass, "__").concat(theme), coachmark.isOpen && "".concat(blockClass, "--is-open")),
+    ref: ref
+  }, (0, _devtools.getDevtoolsProps)(componentName)), /*#__PURE__*/_react.default.createElement("button", (0, _extends2.default)({
+    // {...rest}
+    className: "".concat(blockClass, "__cta"),
+    type: "button"
+  }, coachmark.buttonProps), /*#__PURE__*/_react.default.createElement("div", {
+    className: "".concat(blockClass, "__idea")
+  }, /*#__PURE__*/_react.default.createElement(_iconsReact.Idea16, null)), /*#__PURE__*/_react.default.createElement("div", null, title)), /*#__PURE__*/_react.default.createElement(_carbonComponentsReact.Button, {
+    kind: "ghost",
+    size: "sm",
+    renderIcon: _iconsReact.Close16,
+    iconDescription: closeIconDescription,
+    hasIconOnly: true,
+    className: "".concat(blockClass, "--close-btn"),
+    onClick: onClose
+  }));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.CoachmarkTagline = CoachmarkTagline;
+exports.CoachmarkTagline = CoachmarkTagline = _settings.pkg.checkComponentEnabled(CoachmarkTagline, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+CoachmarkTagline.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.
+CoachmarkTagline.propTypes = {
+  /**
+   * Tooltip text and aria label for the Close button icon.
+   */
+  closeIconDescription: _propTypes.default.string,
+  /**
+   * Function to call when the close button is clicked.
+   */
+  onClose: _propTypes.default.func,
+  /**
+   * Determines the theme of the component.
+   */
+  theme: _propTypes.default.oneOf(['light', 'dark']),
+  /**
+   * The title of the tagline.
+   */
+  title: _propTypes.default.string.isRequired
+};

package/lib/components/Coachmark/index.js

@@ -0,0 +1,38 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "BEACON_KIND", {
+  enumerable: true,
+  get: function get() {
+    return _enums.BEACON_KIND;
+  }
+});
+Object.defineProperty(exports, "COACHMARK_ALIGNMENT", {
+  enumerable: true,
+  get: function get() {
+    return _enums.COACHMARK_ALIGNMENT;
+  }
+});
+Object.defineProperty(exports, "COACHMARK_OVERLAY_KIND", {
+  enumerable: true,
+  get: function get() {
+    return _enums.COACHMARK_OVERLAY_KIND;
+  }
+});
+Object.defineProperty(exports, "Coachmark", {
+  enumerable: true,
+  get: function get() {
+    return _Coachmark.Coachmark;
+  }
+});
+Object.defineProperty(exports, "useCoachmark", {
+  enumerable: true,
+  get: function get() {
+    return _context.useCoachmark;
+  }
+});
+var _Coachmark = require("./Coachmark");
+var _enums = require("./utils/enums");
+var _context = require("./utils/context");

package/lib/components/Coachmark/utils/constants.js

@@ -0,0 +1,82 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getOffsetTune = void 0;
+var _enums = require("./enums");
+/**
+ * If the coachmark's target is a link, button, etc. (i.e. not a beacon),
+ * this adjusts the coachmark's position based on the position and size of the target.
+ * @param {object} coachmark target reference
+ * @param {string} kind type of coachmark
+ * @returns {object} {top:number, left:number}
+ */
+
+var getOffsetTune = function getOffsetTune(coachmark, kind) {
+  // for future reference
+  // const coachmarkTarget = {
+  //   x: coachmark.targetOffset.x,
+  //   y: coachmark.targetOffset.y,
+  //   width: coachmark.targetRect.width,
+  //   height: coachmark.targetRect.height,
+  // };
+
+  var _coachmark$targetRect = coachmark.targetRect,
+    width = _coachmark$targetRect.width,
+    height = _coachmark$targetRect.height;
+  var distanceOffset = 24; // see also _coachmark-overlay.scss > $distance-offset
+  var top = 0;
+  var left = 0;
+  if (kind !== _enums.COACHMARK_OVERLAY_KIND.TOOLTIP) {
+    switch (coachmark.align) {
+      case _enums.COACHMARK_ALIGNMENT.TOP:
+        left = width / 2;
+        break;
+      case _enums.COACHMARK_ALIGNMENT.TOP_LEFT:
+        left = distanceOffset;
+        break;
+      case _enums.COACHMARK_ALIGNMENT.TOP_RIGHT:
+        left = width - distanceOffset;
+        break;
+      case _enums.COACHMARK_ALIGNMENT.BOTTOM:
+        top = height;
+        left = width / 2;
+        break;
+      case _enums.COACHMARK_ALIGNMENT.BOTTOM_LEFT:
+        top = height;
+        left = distanceOffset;
+        break;
+      case _enums.COACHMARK_ALIGNMENT.BOTTOM_RIGHT:
+        top = height;
+        left = width - distanceOffset;
+        break;
+      case _enums.COACHMARK_ALIGNMENT.LEFT:
+        top = height / 2;
+        break;
+      case _enums.COACHMARK_ALIGNMENT.LEFT_TOP:
+        top = distanceOffset;
+        break;
+      case _enums.COACHMARK_ALIGNMENT.LEFT_BOTTOM:
+        top = height - distanceOffset;
+        break;
+      case _enums.COACHMARK_ALIGNMENT.RIGHT:
+        top = height / 2;
+        left = width;
+        break;
+      case _enums.COACHMARK_ALIGNMENT.RIGHT_TOP:
+        top = distanceOffset;
+        left = width;
+        break;
+      case _enums.COACHMARK_ALIGNMENT.RIGHT_BOTTOM:
+        top = height - distanceOffset;
+        left = width;
+        break;
+    }
+  }
+  return {
+    top: top,
+    left: left
+  };
+};
+exports.getOffsetTune = getOffsetTune;

package/lib/components/Coachmark/utils/context.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useCoachmark = exports.CoachmarkContext = void 0;
+var _react = require("react");
+var CoachmarkContext = /*#__PURE__*/(0, _react.createContext)();
+exports.CoachmarkContext = CoachmarkContext;
+var useCoachmark = function useCoachmark() {
+  return (0, _react.useContext)(CoachmarkContext);
+};
+exports.useCoachmark = useCoachmark;

package/lib/components/Coachmark/utils/enums.js

@@ -0,0 +1,49 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.COACHMARK_OVERLAY_KIND = exports.COACHMARK_ALIGNMENT = exports.BEACON_KIND = void 0;
+/* eslint-disable max-len */
+
+/**
+ * Reserved for future expansion, i.e. "RING".
+ */
+var BEACON_KIND = {
+  DEFAULT: 'default'
+};
+
+/**
+ * Describes the style and behavior of a Coachmark.
+ * @param TOOLTIP includes a caret pointing to the animated beacon.
+ * @param FLOATING includes a drag handle across the top.
+ * @param FIXED is fixed to the bottom-right of the viewport.
+ * @param STACKED is fixed to the bottom-right of the viewport, includes links to show more, stackable Coachmarks if included.
+ */
+exports.BEACON_KIND = BEACON_KIND;
+var COACHMARK_OVERLAY_KIND = {
+  TOOLTIP: 'tooltip',
+  FLOATING: 'floating',
+  FIXED: 'fixed',
+  STACKED: 'stacked'
+};
+/**
+ * Where to render the Coachmark relative to its target.
+ * Applies only to Floating and Tooltip Coachmarks.
+ */
+exports.COACHMARK_OVERLAY_KIND = COACHMARK_OVERLAY_KIND;
+var COACHMARK_ALIGNMENT = {
+  BOTTOM: 'bottom',
+  BOTTOM_LEFT: 'bottom-left',
+  BOTTOM_RIGHT: 'bottom-right',
+  LEFT: 'left',
+  LEFT_TOP: 'left-top',
+  LEFT_BOTTOM: 'left-bottom',
+  RIGHT: 'right',
+  RIGHT_TOP: 'right-top',
+  RIGHT_BOTTOM: 'right-bottom',
+  TOP: 'top',
+  TOP_LEFT: 'top-left',
+  TOP_RIGHT: 'top-right'
+};
+exports.COACHMARK_ALIGNMENT = COACHMARK_ALIGNMENT;

package/lib/components/Coachmark/utils/helpers.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.clamp = clamp;
+/* eslint-disable max-len */
+
+/**
+ * Clamp the given value between the upper bound `max` and the lower bound `min`
+ * @param {number} max
+ * @param {number} min
+ * @param {number} value
+ */
+function clamp(max, min, value) {
+  return Math.min(max, Math.max(min, value));
+}

package/lib/components/Coachmark/utils/hooks.js

@@ -0,0 +1,60 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useClickOutsideElement = useClickOutsideElement;
+exports.useWindowEvent = void 0;
+var _react = require("react");
+var _enums = require("./enums");
+/**
+ * Detects when a user clicks outside of the element
+ * @param {object} coachmarkRef - The ref to the React element for the Coachmark to detect when the user clicks outside of its bounds.
+ * @param {object} overlayRef - The ref to the React element for the CoachmarkOverlay to detect when the user clicks outside of its bounds.
+ * @param {string} overlayKind - The overlayKind prop from the Coachmark. @see COACHMARK_OVERLAY_KIND
+ * @param {Function} callback The callback to call when the user mouses down.
+ */
+
+function useClickOutsideElement(coachmarkRef, overlayRef, overlayKind, callback) {
+  var cb = (0, _react.useRef)();
+  var isTooltip = overlayKind === _enums.COACHMARK_OVERLAY_KIND.TOOLTIP;
+  (0, _react.useLayoutEffect)(function () {
+    cb.current = callback;
+  }, [callback]);
+  (0, _react.useEffect)(function () {
+    function handleClickOutside(event) {
+      var isOverlayOutside = overlayRef.current && !overlayRef.current.contains(event.target);
+      var isOutsideCoachmark = coachmarkRef.current && !coachmarkRef.current.contains(event.target);
+      if (isOverlayOutside && isOutsideCoachmark) {
+        callCallback();
+      }
+    }
+    function callCallback() {
+      if (isTooltip) {
+        cb.current();
+      }
+    }
+    document.addEventListener('mousedown', handleClickOutside);
+    return function () {
+      document.removeEventListener('mousedown', handleClickOutside);
+    };
+  }, [coachmarkRef, overlayRef, isTooltip]);
+}
+var useWindowEvent = function useWindowEvent(eventName, callback) {
+  var savedCallback = (0, _react.useRef)(null);
+  (0, _react.useEffect)(function () {
+    savedCallback.current = callback;
+  });
+  (0, _react.useEffect)(function () {
+    function handler(event) {
+      if (savedCallback.current) {
+        savedCallback.current(event);
+      }
+    }
+    window.addEventListener(eventName, handler);
+    return function () {
+      window.removeEventListener(eventName, handler);
+    };
+  }, [eventName]);
+};
+exports.useWindowEvent = useWindowEvent;

package/lib/components/CoachmarkBeacon/CoachmarkBeacon.js

@@ -0,0 +1,87 @@
+"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"];
+// 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 = /*#__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)), /*#__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")
+  }, /*#__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;
+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");