@carbon/ibm-products 1.55.2 → 1.56.0

package/es/components/Coachmark/CoachmarkTagline.js

@@ -0,0 +1,93 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["closeIconDescription", "onClose", "theme", "title"];
+/**
+ * Copyright IBM Corp. 2023, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+// Import portions of React that are needed.
+import React from 'react';
+
+// Other standard imports.
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { Close16, Idea16 } from '@carbon/icons-react';
+import { Button } from 'carbon-components-react';
+import { useCoachmark } from './utils/context';
+import { getDevtoolsProps } from '../../global/js/utils/devtools';
+import { pkg /*, carbon */ } from '../../settings';
+
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(pkg.prefix, "--coachmark-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.
+ */
+export var CoachmarkTagline = /*#__PURE__*/React.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 = _objectWithoutProperties(_ref, _excluded);
+  var coachmark = useCoachmark();
+  return /*#__PURE__*/React.createElement("div", _extends({}, rest, {
+    className: cx(blockClass, "".concat(blockClass, "__").concat(theme), coachmark.isOpen && "".concat(blockClass, "--is-open")),
+    ref: ref
+  }, getDevtoolsProps(componentName)), /*#__PURE__*/React.createElement("button", _extends({
+    // {...rest}
+    className: "".concat(blockClass, "__cta"),
+    type: "button"
+  }, coachmark.buttonProps), /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "__idea")
+  }, /*#__PURE__*/React.createElement(Idea16, null)), /*#__PURE__*/React.createElement("div", null, title)), /*#__PURE__*/React.createElement(Button, {
+    kind: "ghost",
+    size: "sm",
+    renderIcon: Close16,
+    iconDescription: closeIconDescription,
+    hasIconOnly: true,
+    className: "".concat(blockClass, "--close-btn"),
+    onClick: onClose
+  }));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+CoachmarkTagline = 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.string,
+  /**
+   * Function to call when the close button is clicked.
+   */
+  onClose: PropTypes.func,
+  /**
+   * Determines the theme of the component.
+   */
+  theme: PropTypes.oneOf(['light', 'dark']),
+  /**
+   * The title of the tagline.
+   */
+  title: PropTypes.string.isRequired
+};

package/es/components/Coachmark/index.js

@@ -0,0 +1,10 @@
+/**
+ * Copyright IBM Corp. 2023, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+export { Coachmark } from './Coachmark';
+export { BEACON_KIND, COACHMARK_OVERLAY_KIND, COACHMARK_ALIGNMENT } from './utils/enums';
+export { useCoachmark } from './utils/context';

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

@@ -0,0 +1,76 @@
+import { COACHMARK_ALIGNMENT, COACHMARK_OVERLAY_KIND } from './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}
+ */
+
+export 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 !== COACHMARK_OVERLAY_KIND.TOOLTIP) {
+    switch (coachmark.align) {
+      case COACHMARK_ALIGNMENT.TOP:
+        left = width / 2;
+        break;
+      case COACHMARK_ALIGNMENT.TOP_LEFT:
+        left = distanceOffset;
+        break;
+      case COACHMARK_ALIGNMENT.TOP_RIGHT:
+        left = width - distanceOffset;
+        break;
+      case COACHMARK_ALIGNMENT.BOTTOM:
+        top = height;
+        left = width / 2;
+        break;
+      case COACHMARK_ALIGNMENT.BOTTOM_LEFT:
+        top = height;
+        left = distanceOffset;
+        break;
+      case COACHMARK_ALIGNMENT.BOTTOM_RIGHT:
+        top = height;
+        left = width - distanceOffset;
+        break;
+      case COACHMARK_ALIGNMENT.LEFT:
+        top = height / 2;
+        break;
+      case COACHMARK_ALIGNMENT.LEFT_TOP:
+        top = distanceOffset;
+        break;
+      case COACHMARK_ALIGNMENT.LEFT_BOTTOM:
+        top = height - distanceOffset;
+        break;
+      case COACHMARK_ALIGNMENT.RIGHT:
+        top = height / 2;
+        left = width;
+        break;
+      case COACHMARK_ALIGNMENT.RIGHT_TOP:
+        top = distanceOffset;
+        left = width;
+        break;
+      case COACHMARK_ALIGNMENT.RIGHT_BOTTOM:
+        top = height - distanceOffset;
+        left = width;
+        break;
+    }
+  }
+  return {
+    top: top,
+    left: left
+  };
+};

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

@@ -0,0 +1,5 @@
+import { createContext, useContext } from 'react';
+export var CoachmarkContext = /*#__PURE__*/createContext();
+export var useCoachmark = function useCoachmark() {
+  return useContext(CoachmarkContext);
+};

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

@@ -0,0 +1,40 @@
+/* eslint-disable max-len */
+
+/**
+ * Reserved for future expansion, i.e. "RING".
+ */
+export 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.
+ */
+export 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.
+ */
+export 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'
+};

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

@@ -0,0 +1,11 @@
+/* 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
+ */
+export function clamp(max, min, value) {
+  return Math.min(max, Math.max(min, value));
+}

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

@@ -0,0 +1,54 @@
+import { useEffect, useRef, useLayoutEffect } from 'react';
+import { COACHMARK_OVERLAY_KIND } from './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 = useRef();
+  var isTooltip = overlayKind === COACHMARK_OVERLAY_KIND.TOOLTIP;
+  useLayoutEffect(function () {
+    cb.current = callback;
+  }, [callback]);
+  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 = useRef(null);
+  useEffect(function () {
+    savedCallback.current = callback;
+  });
+  useEffect(function () {
+    function handler(event) {
+      if (savedCallback.current) {
+        savedCallback.current(event);
+      }
+    }
+    window.addEventListener(eventName, handler);
+    return function () {
+      window.removeEventListener(eventName, handler);
+    };
+  }, [eventName]);
+};
+export { useClickOutsideElement, useWindowEvent };

package/es/components/CoachmarkBeacon/CoachmarkBeacon.js

@@ -0,0 +1,90 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["label", "className", "kind"];
+/**
+ * Copyright IBM Corp. 2023, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+// Import portions of React that are needed.
+import React from 'react';
+
+// Other standard imports.
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { useCoachmark } from '../Coachmark';
+import { getDevtoolsProps } from '../../global/js/utils/devtools';
+import { pkg /*, carbon */ } from '../../settings';
+
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(pkg.prefix, "--coachmark-beacon");
+var componentName = 'CoachmarkBeacon';
+var defaults = {
+  kind: 'default'
+};
+
+/**
+ * Use beacon for the target prop of a Coachmark component.
+ */
+export var CoachmarkBeacon = /*#__PURE__*/React.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 = _objectWithoutProperties(_ref, _excluded);
+  var coachmark = useCoachmark();
+  if (!coachmark) {
+    return /*#__PURE__*/React.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.createElement("span", _extends({}, rest, {
+    className: cx(blockClass, "".concat(blockClass, "-").concat(kind), className),
+    ref: ref,
+    style: overlayPositionStyle
+  }, getDevtoolsProps(componentName)), /*#__PURE__*/React.createElement("button", _extends({
+    tabIndex: 0,
+    type: "button"
+  }, coachmark.buttonProps, {
+    "aria-label": label,
+    className: "".concat(blockClass, "__target")
+  }), /*#__PURE__*/React.createElement("svg", {
+    className: "".concat(blockClass, "__center")
+  }, /*#__PURE__*/React.createElement("circle", {
+    r: 1,
+    cx: 38,
+    cy: 38
+  }))));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+CoachmarkBeacon = 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.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.oneOf(['default']),
+  /**
+   * The aria label.
+   */
+  label: PropTypes.string.isRequired
+};

package/es/components/CoachmarkBeacon/index.js

@@ -0,0 +1,8 @@
+/**
+ * Copyright IBM Corp. 2023, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+export { CoachmarkBeacon } from './CoachmarkBeacon';

package/es/components/CoachmarkButton/CoachmarkButton.js

@@ -0,0 +1,72 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["className", "label"];
+/**
+ * Copyright IBM Corp. 2023, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+// Import portions of React that are needed.
+import React from 'react';
+
+// Other standard imports.
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { Button } from 'carbon-components-react';
+import { useCoachmark } from '../Coachmark';
+import { getDevtoolsProps } from '../../global/js/utils/devtools';
+import { pkg /*, carbon */ } from '../../settings';
+
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(pkg.prefix, "--coachmark-button");
+var componentName = 'CoachmarkButton';
+
+/**
+ * Use CoachmarkButton for the target prop of a Coachmark component.
+ */
+export var CoachmarkButton = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
+  var className = _ref.className,
+    label = _ref.label,
+    rest = _objectWithoutProperties(_ref, _excluded);
+  var coachmark = useCoachmark();
+  if (!coachmark) {
+    return /*#__PURE__*/React.createElement("div", null, "CoachmarkButton is to be use exclusively within the target prop of Coachmark");
+  }
+  return /*#__PURE__*/React.createElement(Button, _extends({}, rest, {
+    className: cx(blockClass,
+    // Apply the block class to the main HTML element
+    className,
+    // Apply any supplied class names to the main HTML element.
+    // example: `${blockClass}__template-string-class-${kind}-n-${size}`,
+    {
+      // switched classes dependant on props or state
+      // example: [`${blockClass}__here-if-small`]: size === 'sm',
+    }),
+    ref: ref,
+    role: "button",
+    "aria-label": label
+  }, getDevtoolsProps(componentName), coachmark.buttonProps), label);
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+CoachmarkButton = pkg.checkComponentEnabled(CoachmarkButton, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+CoachmarkButton.displayName = componentName;
+
+// The types and DocGen commentary for the component props,
+// in alphabetical order (for consistency).
+// See https://www.npmjs.com/package/prop-types#usage.
+CoachmarkButton.propTypes = {
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: PropTypes.string,
+  /**
+   * The aria label.
+   */
+  label: PropTypes.string.isRequired
+};

package/es/components/CoachmarkButton/index.js

@@ -0,0 +1,8 @@
+/**
+ * Copyright IBM Corp. 2023, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+export { CoachmarkButton } from './CoachmarkButton';

package/es/components/CoachmarkFixed/CoachmarkFixed.js

@@ -0,0 +1,201 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["children", "className", "onClose", "portalTarget", "tagline", "theme"];
+/**
+ * Copyright IBM Corp. 2023, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+// Import portions of React that are needed.
+import React, { useEffect, useRef, useState } from 'react';
+
+// Other standard imports.
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { createPortal } from 'react-dom';
+import { CoachmarkOverlay } from '../Coachmark/CoachmarkOverlay';
+import { CoachmarkTagline } from '../Coachmark/CoachmarkTagline';
+import { CoachmarkContext } from '../Coachmark/utils/context';
+import { COACHMARK_OVERLAY_KIND } from '../Coachmark/utils/enums';
+import { getDevtoolsProps } from '../../global/js/utils/devtools';
+import { pkg /*, carbon */ } from '../../settings';
+
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(pkg.prefix, "--coachmark-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.
+ */
+export var CoachmarkFixed = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
+  var _document$querySelect;
+  var children = _ref.children,
+    className = _ref.className,
+    _ref$onClose = _ref.onClose,
+    onClose = _ref$onClose === void 0 ? defaults.onClose : _ref$onClose,
+    portalTarget = _ref.portalTarget,
+    _ref$tagline = _ref.tagline,
+    tagline = _ref$tagline === void 0 ? defaults.tagline : _ref$tagline,
+    _ref$theme = _ref.theme,
+    theme = _ref$theme === void 0 ? defaults.theme : _ref$theme,
+    rest = _objectWithoutProperties(_ref, _excluded);
+  var overlayRef = useRef();
+  var portalNode = portalTarget ? (_document$querySelect = document.querySelector(portalTarget)) !== null && _document$querySelect !== void 0 ? _document$querySelect : document.querySelector('body') : document.querySelector('body');
+  var _useState = useState(false),
+    _useState2 = _slicedToArray(_useState, 2),
+    isOpen = _useState2[0],
+    setIsOpen = _useState2[1];
+  var _useState3 = useState(false),
+    _useState4 = _slicedToArray(_useState3, 2),
+    shouldResetPosition = _useState4[0],
+    setShouldResetPosition = _useState4[1];
+  var _useState5 = useState(),
+    _useState6 = _slicedToArray(_useState5, 2),
+    targetRect = _useState6[0],
+    setTargetRect = _useState6[1];
+  var _useState7 = useState({
+      x: 0,
+      y: 0
+    }),
+    _useState8 = _slicedToArray(_useState7, 2),
+    targetOffset = _useState8[0],
+    setTargetOffset = _useState8[1];
+  var _useState9 = useState(false),
+    _useState10 = _slicedToArray(_useState9, 2),
+    fixedIsVisible = _useState10[0],
+    setFixedIsVisible = _useState10[1];
+  var 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
+  useEffect(function () {
+    if (shouldResetPosition) {
+      setShouldResetPosition(false);
+      setIsOpen(true);
+    }
+  }, [shouldResetPosition]);
+  useEffect(function () {
+    setFixedIsVisible(isOpen);
+  }, [isOpen]);
+
+  // On unmount:
+  // - DO NOT "Close()" the coachmark.
+  //   - This triggers a "signal" to close it forever.
+  //   - "Closing" should only ever be a user-triggered event.
+  // - DO "hide" the coachmark.
+  //   - The app is doing the action for the user.
+  //   - The user will have the opportunity to open it again.
+  useEffect(function () {
+    return function () {
+      return setIsOpen(false);
+    };
+  }, []);
+  return /*#__PURE__*/React.createElement(CoachmarkContext.Provider, {
+    value: contextValue
+  }, /*#__PURE__*/React.createElement("div", _extends({}, rest, {
+    className: cx(blockClass, // Apply the block class to the main HTML element
+    "".concat(blockClass, "__").concat(theme), className // Apply any supplied class names to the main HTML element.
+    ),
+
+    ref: ref
+  }, getDevtoolsProps(componentName)), /*#__PURE__*/React.createElement(CoachmarkTagline, {
+    title: tagline,
+    onClose: onClose
+  }), isOpen && /*#__PURE__*/createPortal( /*#__PURE__*/React.createElement(CoachmarkOverlay, {
+    ref: overlayRef,
+    fixedIsVisible: fixedIsVisible,
+    kind: COACHMARK_OVERLAY_KIND.FIXED,
+    onClose: handleClose,
+    onTransitionEnd: handleTransitionEnd,
+    theme: theme
+  }, children), portalNode)));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+CoachmarkFixed = pkg.checkComponentEnabled(CoachmarkFixed, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+CoachmarkFixed.displayName = componentName;
+
+// The types and DocGen commentary for the component props,
+// in alphabetical order (for consistency).
+// See https://www.npmjs.com/package/prop-types#usage.
+CoachmarkFixed.propTypes = {
+  // TODO: Add this to MDX as will be done with Coachmark
+  /**
+   * CoachmarkFixed should use a single CoachmarkOverlayElements component as a child.
+   */
+  children: PropTypes.node.isRequired,
+  /**
+   * Optional class name for this component.
+   */
+  className: PropTypes.string,
+  /**
+   * Function to call when the Coachmark closes.
+   */
+  onClose: PropTypes.func,
+  /**
+   * By default, the Coachmark will be appended to the end of `document.body`.
+   * The Coachmark will remain persistent as the user navigates the app until
+   * the user closes the Coachmark.
+   *
+   * Alternatively, the app developer can tightly couple the Coachmark to a DOM
+   * element or other component by specifying a CSS selector. The Coachmark will
+   * remain visible as long as that element remains visible or mounted. When the
+   * element is hidden or component is unmounted, the Coachmark will disappear.
+   */
+  portalTarget: PropTypes.string,
+  /**
+   * The tagline title which will be fixed to the bottom right of the window and will serve as the display trigger.
+   */
+  tagline: PropTypes.string.isRequired,
+  /**
+   * Determines the theme of the component.
+   */
+  theme: PropTypes.oneOf(['light', 'dark'])
+};