@carbon/ibm-products 2.23.0 → 2.24.0

package/lib/components/Coachmark/CoachmarkDragbar.js

@@ -0,0 +1,151 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CoachmarkDragbar = 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 _icons = require("@carbon/react/icons");
+var _react2 = require("@carbon/react");
+var _devtools = require("../../global/js/utils/devtools");
+var _settings = require("../../settings");
+var _excluded = ["a11yKeyboardHandler", "closeIconDescription", "onClose", "onDrag", "showCloseButton", "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 blockClass = "".concat(_settings.pkg.prefix, "--coachmark-dragbar");
+var overlayBlockClass = "".concat(_settings.pkg.prefix, "--coachmark-overlay");
+var componentName = 'CoachmarkDragbar';
+var defaults = {
+  closeIconDescription: 'Close',
+  onDrag: function onDrag() {},
+  onClose: function onClose() {},
+  showCloseButton: true,
+  theme: 'light'
+};
+
+/**
+ * DO NOT USE. This component is for the exclusive use
+ * of other Novice to Pro components.
+ */
+var CoachmarkDragbar = exports.CoachmarkDragbar = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
+  var a11yKeyboardHandler = _ref.a11yKeyboardHandler,
+    _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$onDrag = _ref.onDrag,
+    onDrag = _ref$onDrag === void 0 ? defaults.onDrag : _ref$onDrag,
+    _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);
+  var _useState = (0, _react.useState)(false),
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    isDragging = _useState2[0],
+    setIsDragging = _useState2[1];
+  (0, _react.useEffect)(function () {
+    var handleDragStop = function handleDragStop() {
+      return setIsDragging(false);
+    };
+    window.addEventListener('mouseup', handleDragStop);
+    return function () {
+      window.removeEventListener('mouseup', handleDragStop);
+    };
+  }, []);
+  (0, _react.useEffect)(function () {
+    var handleDrag = function handleDrag(event) {
+      onDrag(event.movementX, event.movementY);
+    };
+    if (isDragging) {
+      window.addEventListener('mousemove', handleDrag);
+    }
+    return function () {
+      window.removeEventListener('mousemove', handleDrag);
+    };
+  }, [isDragging, onDrag]);
+  var handleDragStart = function handleDragStart() {
+    return setIsDragging(true);
+  };
+  return /*#__PURE__*/_react.default.createElement("header", (0, _extends2.default)({}, rest, {
+    className: (0, _classnames.default)(blockClass, // Apply the block class to the main HTML element
+    "".concat(blockClass, "__").concat(theme),
+    // 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("button", {
+    type: "button",
+    className: "".concat(overlayBlockClass, "__handle"),
+    onMouseDown: handleDragStart,
+    onKeyDown: a11yKeyboardHandler
+  }, /*#__PURE__*/_react.default.createElement(_icons.Draggable, {
+    size: "16"
+  })), showCloseButton && /*#__PURE__*/_react.default.createElement(_react2.Button, {
+    kind: "ghost",
+    size: "sm",
+    renderIcon: _icons.Close,
+    iconDescription: closeIconDescription,
+    hasIconOnly: true,
+    className: "".concat(overlayBlockClass, "--close-btn"),
+    onClick: onClose
+  }));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.CoachmarkDragbar = CoachmarkDragbar = _settings.pkg.checkComponentEnabled(CoachmarkDragbar, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+CoachmarkDragbar.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.
+CoachmarkDragbar.propTypes = {
+  /**
+   * Handler to manage keyboard interactions with the dragbar.
+   */
+  a11yKeyboardHandler: _propTypes.default.func.isRequired,
+  /**
+   * 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,
+  /**
+   * Function to call when the user clicks and drags the Coachmark.
+   * For internal use only by the parent CoachmarkOverlay.
+   */
+  onDrag: _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/CoachmarkHeader.js

@@ -0,0 +1,95 @@
+"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 _icons = require("@carbon/react/icons");
+var _react2 = require("@carbon/react");
+var _devtools = require("../../global/js/utils/devtools");
+var _settings = require("../../settings");
+var _excluded = ["closeIconDescription", "onClose", "showCloseButton", "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.
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(_settings.pkg.prefix, "--coachmark-header");
+var overlayBlockClass = "".concat(_settings.pkg.prefix, "--coachmark-overlay");
+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 = exports.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("div", {
+    className: "".concat(overlayBlockClass, "--close-btn-container")
+  }, /*#__PURE__*/_react.default.createElement(_react2.Button, {
+    kind: "ghost",
+    size: "sm",
+    renderIcon: _icons.Close,
+    iconDescription: closeIconDescription,
+    hasIconOnly: true,
+    className: "".concat(overlayBlockClass, "--close-btn"),
+    onClick: onClose
+  })));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+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,243 @@
+"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 _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+var _react = _interopRequireWildcard(require("react"));
+var _uuidv = _interopRequireDefault(require("../../global/js/utils/uuidv4"));
+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"];
+/**
+ * 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; }
+// 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 = exports.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 _useWindowDimensions = useWindowDimensions(),
+    winHeight = _useWindowDimensions.winHeight,
+    winWidth = _useWindowDimensions.winWidth;
+  var _useState = (0, _react.useState)(false),
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    a11yDragMode = _useState2[0],
+    setA11yDragMode = _useState2[1];
+  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 isVisible = className && className.includes('is-visible');
+  var handleKeyPress = function handleKeyPress(event) {
+    var shiftKey = event.shiftKey,
+      key = event.key;
+    if (key === 'Enter' || key === ' ') {
+      setA11yDragMode(function (prevVal) {
+        return !prevVal;
+      });
+    } else if (a11yDragMode) {
+      var distanceToMove = shiftKey ? 128 : 32;
+      switch (key) {
+        case 'ArrowLeft':
+          handleDrag(distanceToMove * -1, 0);
+          break;
+        case 'ArrowRight':
+          handleDrag(distanceToMove, 0);
+          break;
+        case 'ArrowUp':
+          handleDrag(0, distanceToMove * -1);
+          break;
+        case 'ArrowDown':
+          handleDrag(0, distanceToMove);
+          break;
+        default:
+          break;
+      }
+    }
+  };
+  var styledTune = {};
+  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 handleDragBounds(x, y) {
+    var xRes = x;
+    var yRes = y;
+    var xMax = winWidth - 288;
+    var yMax = winHeight - 150;
+    if (xRes < 0) {
+      xRes = 0;
+    } else if (xRes > xMax) {
+      xRes = xMax;
+    }
+    if (yRes < 0) {
+      yRes = 0;
+    } else if (yRes > yMax) {
+      yRes = yMax;
+    }
+    return {
+      targetX: xRes,
+      targetY: yRes
+    };
+  }
+  function handleDrag(movementX, movementY) {
+    var overlay = overlayRef.current;
+    var _overlay$getBoundingC = overlay.getBoundingClientRect(),
+      x = _overlay$getBoundingC.x,
+      y = _overlay$getBoundingC.y;
+    var _handleDragBounds = handleDragBounds(x + movementX, y + movementY),
+      targetX = _handleDragBounds.targetX,
+      targetY = _handleDragBounds.targetY;
+    overlay.style.transform = 'none';
+    overlay.style.position = 'fixed';
+    overlay.style.left = "".concat(targetX, "px");
+    overlay.style.top = "".concat(targetY, "px");
+    overlay.style.bottom = 'auto';
+  }
+  var contentId = (0, _uuidv.default)();
+  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"), a11yDragMode && "".concat(blockClass, "--is-dragmode"), className),
+    ref: overlayRef,
+    style: styledTune,
+    "aria-labelledby": contentId,
+    tabIndex: -1
+  }, (0, _devtools.getDevtoolsProps)(componentName)), isDraggable ? /*#__PURE__*/_react.default.createElement(_CoachmarkDragbar.CoachmarkDragbar, {
+    a11yKeyboardHandler: handleKeyPress,
+    onBlur: function onBlur() {
+      return setA11yDragMode(false);
+    },
+    onDrag: handleDrag,
+    theme: theme,
+    onClose: onClose
+  }) : /*#__PURE__*/_react.default.createElement(_CoachmarkHeader.CoachmarkHeader, {
+    onClose: onClose
+  }), /*#__PURE__*/_react.default.createElement("div", {
+    className: "".concat(blockClass, "__body"),
+    ref: ref,
+    id: contentId
+  }, _react.default.Children.map(children, function (child) {
+    return /*#__PURE__*/_react.default.cloneElement(child, {
+      isVisible: isVisible
+    });
+  })), isBeacon && /*#__PURE__*/_react.default.createElement("span", {
+    className: "".concat(blockClass, "__caret")
+  }));
+});
+function getWindowDimensions() {
+  var _window = window,
+    winWidth = _window.innerWidth,
+    winHeight = _window.innerHeight;
+  return {
+    winWidth: winWidth,
+    winHeight: winHeight
+  };
+}
+var useWindowDimensions = function useWindowDimensions() {
+  var _useState3 = (0, _react.useState)(getWindowDimensions()),
+    _useState4 = (0, _slicedToArray2.default)(_useState3, 2),
+    windowDimensions = _useState4[0],
+    setWindowDimensions = _useState4[1];
+  (0, _react.useEffect)(function () {
+    function handleResize() {
+      setWindowDimensions(getWindowDimensions());
+    }
+    window.addEventListener('resize', handleResize);
+    return function () {
+      return window.removeEventListener('resize', handleResize);
+    };
+  }, []);
+  return windowDimensions;
+};
+
+// Return a placeholder if not released and not enabled by feature flag
+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,101 @@
+"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 _react2 = require("@carbon/react");
+var _context = require("./utils/context");
+var _devtools = require("../../global/js/utils/devtools");
+var _settings = require("../../settings");
+var _excluded = ["closeIconDescription", "onClose", "theme", "title"];
+/**
+ * Copyright IBM Corp. 2023, 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+// Import portions of React that are needed.
+// Other standard imports.
+// 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 = exports.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.Idea, {
+    size: 16
+  })), /*#__PURE__*/_react.default.createElement("div", null, title)), /*#__PURE__*/_react.default.createElement("div", {
+    className: "".concat(blockClass, "--close-btn-container")
+  }, /*#__PURE__*/_react.default.createElement(_react2.Button, {
+    kind: "ghost",
+    size: "sm",
+    renderIcon: _iconsReact.Close,
+    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 = _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");