@carbon/ibm-products 1.55.2 → 1.56.0

package/es/components/Coachmark/Coachmark.js

@@ -0,0 +1,243 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["align", "children", "className", "onClose", "overlayClassName", "overlayKind", "overlayRef", "portalTarget", "positionTune", "target", "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 React, { forwardRef, useEffect, useRef, useState } from 'react';
+import cx from 'classnames';
+import PropTypes, { Component } from 'prop-types';
+import { createPortal } from 'react-dom';
+import { CoachmarkOverlay } from './CoachmarkOverlay';
+import { CoachmarkContext } from './utils/context';
+import { COACHMARK_OVERLAY_KIND } from './utils/enums';
+import { useClickOutsideElement, useWindowEvent } from './utils/hooks';
+import { getDevtoolsProps } from '../../global/js/utils/devtools';
+import { pkg /*, carbon */ } from '../../settings';
+import { throttle } from 'lodash';
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(pkg.prefix, "--coachmark");
+var componentName = 'Coachmark';
+var defaults = {
+  align: 'bottom',
+  onClose: function onClose() {},
+  overlayKind: 'tooltip',
+  theme: 'light'
+};
+
+/**
+ * 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.
+ */
+
+export var Coachmark = /*#__PURE__*/forwardRef(function (_ref, ref) {
+  var _document$querySelect;
+  var _ref$align = _ref.align,
+    align = _ref$align === void 0 ? defaults.align : _ref$align,
+    children = _ref.children,
+    className = _ref.className,
+    _ref$onClose = _ref.onClose,
+    onClose = _ref$onClose === void 0 ? defaults.onClose : _ref$onClose,
+    overlayClassName = _ref.overlayClassName,
+    _ref$overlayKind = _ref.overlayKind,
+    overlayKind = _ref$overlayKind === void 0 ? defaults.overlayKind : _ref$overlayKind,
+    overlayRef = _ref.overlayRef,
+    portalTarget = _ref.portalTarget,
+    positionTune = _ref.positionTune,
+    target = _ref.target,
+    _ref$theme = _ref.theme,
+    theme = _ref$theme === void 0 ? defaults.theme : _ref$theme,
+    rest = _objectWithoutProperties(_ref, _excluded);
+  var isBeacon = overlayKind === COACHMARK_OVERLAY_KIND.TOOLTIP;
+  var isStacked = overlayKind === COACHMARK_OVERLAY_KIND.STACKED;
+  var portalNode = portalTarget ? (_document$querySelect = document.querySelector(portalTarget)) !== null && _document$querySelect !== void 0 ? _document$querySelect : document.querySelector('body') : document.querySelector('body');
+  var _useState = useState(isStacked),
+    _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 overlayBackupRef = useRef();
+  var backupRef = useRef();
+  var _coachmarkRef = ref || backupRef;
+  var _overlayRef = overlayRef || overlayBackupRef;
+  var closeOverlay = function closeOverlay() {
+    setIsOpen(false);
+  };
+  var handleClose = function handleClose() {
+    if (isStacked) {
+      // If stacked, do not unmount,
+      // only call its ("parent") onClose method.
+      onClose();
+    } else {
+      setIsOpen(false);
+      onClose();
+    }
+  };
+  var handleTargetClick = function handleTargetClick(e) {
+    setTargetRect(e.target.getBoundingClientRect());
+    setTargetOffset({
+      x: e.target.offsetLeft,
+      y: e.target.offsetTop
+    });
+    if (isBeacon) {
+      // toggle open/closed for beacons
+      setIsOpen(function (prevIsOpen) {
+        return !prevIsOpen;
+      });
+    } else {
+      // 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,
+    align: align,
+    positionTune: positionTune
+  };
+  var handleResize = throttle(function () {
+    closeOverlay();
+  }, 2000);
+
+  // instead of toggling on/off,
+  // keep open and reset to original position
+  useEffect(function () {
+    if (shouldResetPosition) {
+      setShouldResetPosition(false);
+      setIsOpen(true);
+    }
+  }, [shouldResetPosition]);
+
+  // 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);
+    };
+  }, []);
+  useClickOutsideElement(_coachmarkRef, _overlayRef, overlayKind, closeOverlay);
+  useWindowEvent('resize', handleResize);
+  return /*#__PURE__*/React.createElement(CoachmarkContext.Provider, {
+    value: contextValue
+  }, /*#__PURE__*/React.createElement("div", _extends({
+    className: cx(blockClass, "".concat(blockClass, "__").concat(theme), className),
+    ref: _coachmarkRef
+  }, rest, getDevtoolsProps(componentName)), target, isOpen && /*#__PURE__*/createPortal( /*#__PURE__*/React.createElement(CoachmarkOverlay, {
+    ref: _overlayRef,
+    fixedIsVisible: false,
+    kind: overlayKind,
+    onClose: handleClose,
+    theme: theme,
+    className: overlayClassName
+  }, children), portalNode)));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+Coachmark = pkg.checkComponentEnabled(Coachmark, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+Coachmark.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.
+Coachmark.propTypes = {
+  /**
+   * Where to render the Coachmark relative to its target.
+   * Applies only to Floating and Tooltip Coachmarks.
+   * @see COACHMARK_ALIGNMENT
+   */
+  align: PropTypes.oneOf(['bottom', 'bottom-left', 'bottom-right', 'left', 'left-top', 'left-bottom', 'right', 'right-top', 'right-bottom', 'top', 'top-left', 'top-right']),
+  // TODO: UPDATE COMMENT HERE - UPDATE MDX TO HAVE DIRECTION TO USE ONLY OVERLAY ELEMENTS>...
+  /**
+   * Coachmark should use a single CoachmarkOverlayElements component as a child.
+   * @see CoachmarkOverlayElements
+   */
+  children: PropTypes.node.isRequired,
+  /**
+   * Optional class name for this component.
+   */
+  className: PropTypes.string,
+  /**
+   * Function to call when the Coachmark closes.
+   */
+  onClose: PropTypes.func,
+  /**
+   * Optional class name for the Coachmark Overlay component.
+   */
+  overlayClassName: PropTypes.string,
+  /**
+   * What kind or style of Coachmark to render.
+   */
+  overlayKind: PropTypes.oneOf(['tooltip', 'floating', 'stacked']),
+  overlayRef: PropTypes.oneOfType([
+  // Either a function
+  PropTypes.func,
+  // Or the instance of a DOM native element (see the note about SSR)
+  PropTypes.shape({
+    current: PropTypes.instanceOf(Component)
+  })]),
+  /**
+   * 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,
+  /**
+   * Fine tune the position of the target in pixels. Applies only to Beacons.
+   */
+  positionTune: PropTypes.shape({
+    x: PropTypes.number,
+    y: PropTypes.number
+  }),
+  /**
+   * The optional button or beacon that the user will click to show the Coachmark.
+   */
+  target: PropTypes.node,
+  /**
+   * Determines the theme of the component.
+   */
+  theme: PropTypes.oneOf(['light', 'dark'])
+};

package/es/components/Coachmark/CoachmarkDragbar.js

@@ -0,0 +1,137 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["closeIconDescription", "onClose", "onDrag", "showCloseButton", "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, useState } from 'react';
+
+// Other standard imports.
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { Close16, Draggable16 } from '@carbon/icons-react';
+import { Button } from 'carbon-components-react';
+import { getDevtoolsProps } from '../../global/js/utils/devtools';
+import { pkg /*, carbon */ } from '../../settings';
+
+// 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(pkg.prefix, "--coachmark-dragbar");
+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.
+ */
+export var CoachmarkDragbar = /*#__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$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 = _objectWithoutProperties(_ref, _excluded);
+  var _useState = useState(false),
+    _useState2 = _slicedToArray(_useState, 2),
+    isDragging = _useState2[0],
+    setIsDragging = _useState2[1];
+  useEffect(function () {
+    var handleDragStop = function handleDragStop() {
+      return setIsDragging(false);
+    };
+    window.addEventListener('mouseup', handleDragStop);
+    return function () {
+      window.removeEventListener('mouseup', handleDragStop);
+    };
+  }, []);
+  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.createElement("header", _extends({}, rest, {
+    className: cx(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"
+  }, getDevtoolsProps(componentName)), /*#__PURE__*/React.createElement("button", {
+    type: "button",
+    className: "".concat(blockClass, "__handle"),
+    onMouseDown: handleDragStart
+  }, /*#__PURE__*/React.createElement(Draggable16, null)), showCloseButton && /*#__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
+CoachmarkDragbar = 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 = {
+  /**
+   * 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,
+  /**
+   * Function to call when the user clicks and drags the Coachmark.
+   * For internal use only by the parent CoachmarkOverlay.
+   */
+  onDrag: PropTypes.func,
+  /**
+   * Show/hide the "X" close button.
+   */
+  showCloseButton: PropTypes.bool,
+  /**
+   * Determines the theme of the component.
+   */
+  theme: PropTypes.oneOf(['light', 'dark'])
+};

package/es/components/Coachmark/CoachmarkHeader.js

@@ -0,0 +1,88 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["closeIconDescription", "onClose", "showCloseButton", "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 from 'react';
+
+// Other standard imports.
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { Close16 } from '@carbon/icons-react';
+import { Button } from 'carbon-components-react';
+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-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.
+ */
+export var CoachmarkHeader = /*#__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$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 = _objectWithoutProperties(_ref, _excluded);
+  return /*#__PURE__*/React.createElement("header", _extends({}, rest, {
+    className: cx(blockClass, "".concat(blockClass, "__").concat(theme)),
+    ref: ref
+    // role="main"
+  }, getDevtoolsProps(componentName)), showCloseButton && /*#__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
+CoachmarkHeader = 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.string,
+  /**
+   * Function to call when the close button is clicked.
+   */
+  onClose: PropTypes.func,
+  /**
+   * Show/hide the "X" close button.
+   */
+  showCloseButton: PropTypes.bool,
+  /**
+   * Determines the theme of the component.
+   */
+  theme: PropTypes.oneOf(['light', 'dark'])
+};

package/es/components/Coachmark/CoachmarkOverlay.js

@@ -0,0 +1,139 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["children", "onClose", "fixedIsVisible", "className", "kind", "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, { forwardRef, useRef } from 'react';
+
+// 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 overlayRef = useRef();
+  var coachmark = useCoachmark();
+  var isBeacon = kind === COACHMARK_OVERLAY_KIND.TOOLTIP;
+  var isDraggable = kind === 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 = 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.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"), className),
+    ref: overlayRef,
+    style: styledTune
+  }, getDevtoolsProps(componentName)), isDraggable ? /*#__PURE__*/React.createElement(CoachmarkDragbar, {
+    onDrag: handleDrag,
+    onClose: onClose
+  }) : /*#__PURE__*/React.createElement(CoachmarkHeader, {
+    onClose: onClose
+  }), /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "__body"),
+    ref: ref
+  }, children), isBeacon && /*#__PURE__*/React.createElement("span", {
+    className: "".concat(blockClass, "__caret")
+  }));
+});
+
+// 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'])
+};