@carbon/ibm-products 2.23.0 → 2.24.0

package/es/components/Coachmark/CoachmarkOverlay.js

@@ -0,0 +1,235 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+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.
+import React, { forwardRef, useRef, useState, useEffect } from 'react';
+import uuidv4 from '../../global/js/utils/uuidv4';
+// Other standard imports.
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { getDevtoolsProps } from '../../global/js/utils/devtools';
+import { pkg /*, carbon */ } from '../../settings';
+import { CoachmarkDragbar } from './CoachmarkDragbar';
+import { CoachmarkHeader } from './CoachmarkHeader';
+import { getOffsetTune } from './utils/constants';
+import { useCoachmark } from './utils/context';
+import { COACHMARK_OVERLAY_KIND } from './utils/enums';
+
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(pkg.prefix, "--coachmark-overlay");
+var componentName = 'CoachmarkOverlay';
+
+// NOTE: the component SCSS is not imported here: it is rolled up separately.
+
+var defaults = {
+  kind: COACHMARK_OVERLAY_KIND.FLOATING,
+  theme: 'light'
+};
+
+/**
+ * DO NOT USE. This component is for the exclusive use
+ * of other Novice to Pro components.
+ */
+export var CoachmarkOverlay = /*#__PURE__*/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 = _objectWithoutProperties(_ref, _excluded);
+  var _useWindowDimensions = useWindowDimensions(),
+    winHeight = _useWindowDimensions.winHeight,
+    winWidth = _useWindowDimensions.winWidth;
+  var _useState = useState(false),
+    _useState2 = _slicedToArray(_useState, 2),
+    a11yDragMode = _useState2[0],
+    setA11yDragMode = _useState2[1];
+  var overlayRef = useRef();
+  var coachmark = useCoachmark();
+  var isBeacon = kind === COACHMARK_OVERLAY_KIND.TOOLTIP;
+  var isDraggable = kind === 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 = 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 = uuidv4();
+  return /*#__PURE__*/React.createElement("div", _extends({}, rest, {
+    className: cx(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
+  }, getDevtoolsProps(componentName)), isDraggable ? /*#__PURE__*/React.createElement(CoachmarkDragbar, {
+    a11yKeyboardHandler: handleKeyPress,
+    onBlur: function onBlur() {
+      return setA11yDragMode(false);
+    },
+    onDrag: handleDrag,
+    theme: theme,
+    onClose: onClose
+  }) : /*#__PURE__*/React.createElement(CoachmarkHeader, {
+    onClose: onClose
+  }), /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "__body"),
+    ref: ref,
+    id: contentId
+  }, React.Children.map(children, function (child) {
+    return /*#__PURE__*/React.cloneElement(child, {
+      isVisible: isVisible
+    });
+  })), isBeacon && /*#__PURE__*/React.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 = useState(getWindowDimensions()),
+    _useState4 = _slicedToArray(_useState3, 2),
+    windowDimensions = _useState4[0],
+    setWindowDimensions = _useState4[1];
+  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
+CoachmarkOverlay = 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.node.isRequired,
+  /**
+   * Optional class name for this component.
+   */
+  className: PropTypes.string,
+  /**
+   * The visibility of CoachmarkOverlay is
+   * managed in the parent Coachmark component.
+   */
+  fixedIsVisible: PropTypes.bool.isRequired,
+  /**
+   * What kind or style of Coachmark to render.
+   */
+  kind: PropTypes.oneOf(Object.values(COACHMARK_OVERLAY_KIND)),
+  /**
+   * Function to call when the Coachmark closes.
+   */
+  onClose: PropTypes.func.isRequired,
+  /**
+   * Determines the theme of the component.
+   */
+  theme: PropTypes.oneOf(['light', 'dark'])
+};

package/es/components/Coachmark/CoachmarkTagline.js

@@ -0,0 +1,97 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+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.
+import React from 'react';
+
+// Other standard imports.
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { Close, Idea } from '@carbon/icons-react';
+import { Button } from '@carbon/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(Idea, {
+    size: 16
+  })), /*#__PURE__*/React.createElement("div", null, title)), /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "--close-btn-container")
+  }, /*#__PURE__*/React.createElement(Button, {
+    kind: "ghost",
+    size: "sm",
+    renderIcon: Close,
+    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, 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.
+ */
+
+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,93 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+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.
+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), {
+    role: "tooltip"
+  }), /*#__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"),
+    alt: ""
+  }, /*#__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, 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.
+ */
+
+export { CoachmarkBeacon } from './CoachmarkBeacon';