@carbon/ibm-products 2.23.0 → 2.25.0

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

@@ -0,0 +1,15 @@
+/**
+ * Copyright IBM Corp. 2020, 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 { createContext, useContext } from 'react';
+
+var CoachmarkContext = /*#__PURE__*/createContext();
+var useCoachmark = function useCoachmark() {
+  return useContext(CoachmarkContext);
+};
+
+export { CoachmarkContext, useCoachmark };

package/es/components/Coachmark/utils/enums.d.ts

@@ -0,0 +1,23 @@
+export namespace BEACON_KIND {
+    let DEFAULT: string;
+}
+export namespace COACHMARK_OVERLAY_KIND {
+    let TOOLTIP: string;
+    let FLOATING: string;
+    let FIXED: string;
+    let STACKED: string;
+}
+export namespace COACHMARK_ALIGNMENT {
+    let BOTTOM: string;
+    let BOTTOM_LEFT: string;
+    let BOTTOM_RIGHT: string;
+    let LEFT: string;
+    let LEFT_TOP: string;
+    let LEFT_BOTTOM: string;
+    let RIGHT: string;
+    let RIGHT_TOP: string;
+    let RIGHT_BOTTOM: string;
+    let TOP: string;
+    let TOP_LEFT: string;
+    let TOP_RIGHT: string;
+}

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

@@ -0,0 +1,42 @@
+/**
+ * Copyright IBM Corp. 2020, 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.
+ */
+
+/* eslint-disable max-len */
+
+/**
+ * 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.
+ */
+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.
+ */
+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'
+};
+
+export { COACHMARK_ALIGNMENT, COACHMARK_OVERLAY_KIND };

package/es/components/Coachmark/utils/hooks.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+export function useClickOutsideElement(coachmarkRef: object, overlayRef: object, overlayKind: string, callback: Function): void;
+export function useWindowEvent(eventName: any, callback: any): void;

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

@@ -0,0 +1,62 @@
+/**
+ * Copyright IBM Corp. 2020, 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 { useRef, useLayoutEffect, useEffect } from 'react';
+import { COACHMARK_OVERLAY_KIND } from './enums.js';
+
+/**
+ * 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.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Use beacon for the target prop of a Coachmark component.
+ */
+export let CoachmarkBeacon: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
+import React from 'react';

package/es/components/CoachmarkBeacon/CoachmarkBeacon.js

@@ -0,0 +1,93 @@
+/**
+ * Copyright IBM Corp. 2020, 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 { objectWithoutProperties as _objectWithoutProperties, extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import React__default from 'react';
+import PropTypes from '../../node_modules/prop-types/index.js';
+import cx from '../../node_modules/classnames/index.js';
+import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
+import { pkg } from '../../settings.js';
+import { useCoachmark } from '../Coachmark/utils/context.js';
+
+var _div, _circle;
+var _excluded = ["label", "className", "kind"];
+
+// 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.
+ */
+var CoachmarkBeacon = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
+  var _coachmark$positionTu, _coachmark$positionTu2, _coachmark$positionTu3, _coachmark$positionTu4;
+  var label = _ref.label,
+    className = _ref.className,
+    _ref$kind = _ref.kind,
+    kind = _ref$kind === void 0 ? defaults.kind : _ref$kind,
+    rest = _objectWithoutProperties(_ref, _excluded);
+  var coachmark = useCoachmark();
+  if (!coachmark) {
+    return _div || (_div = /*#__PURE__*/React__default.createElement("div", null, "CoachmarkBeacon is to be use exclusively within the target prop of Coachmark"));
+  }
+  var overlayPositionStyle = {
+    top: (_coachmark$positionTu = (_coachmark$positionTu2 = coachmark.positionTune) === null || _coachmark$positionTu2 === void 0 ? void 0 : _coachmark$positionTu2.y) !== null && _coachmark$positionTu !== void 0 ? _coachmark$positionTu : 0,
+    left: (_coachmark$positionTu3 = (_coachmark$positionTu4 = coachmark.positionTune) === null || _coachmark$positionTu4 === void 0 ? void 0 : _coachmark$positionTu4.x) !== null && _coachmark$positionTu3 !== void 0 ? _coachmark$positionTu3 : 0
+  };
+  return /*#__PURE__*/React__default.createElement("span", _extends({}, rest, {
+    className: cx(blockClass, "".concat(blockClass, "-").concat(kind), className),
+    ref: ref,
+    style: overlayPositionStyle
+  }, getDevtoolsProps(componentName), {
+    role: "tooltip"
+  }), /*#__PURE__*/React__default.createElement("button", _extends({
+    tabIndex: 0,
+    type: "button"
+  }, coachmark.buttonProps, {
+    "aria-label": label,
+    className: "".concat(blockClass, "__target")
+  }), /*#__PURE__*/React__default.createElement("svg", {
+    className: "".concat(blockClass, "__center"),
+    alt: ""
+  }, _circle || (_circle = /*#__PURE__*/React__default.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
+};
+
+export { CoachmarkBeacon };

package/es/components/CoachmarkBeacon/index.d.ts

@@ -0,0 +1 @@
+export { CoachmarkBeacon } from "./CoachmarkBeacon";

package/es/components/CoachmarkButton/CoachmarkButton.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Use CoachmarkButton for the target prop of a Coachmark component.
+ */
+export let CoachmarkButton: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
+import React from 'react';

package/es/components/CoachmarkButton/CoachmarkButton.js

@@ -0,0 +1,90 @@
+/**
+ * Copyright IBM Corp. 2020, 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 { objectWithoutProperties as _objectWithoutProperties, extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import React__default from 'react';
+import PropTypes from '../../node_modules/prop-types/index.js';
+import cx from '../../node_modules/classnames/index.js';
+import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
+import { pkg } from '../../settings.js';
+import { Button } from '@carbon/react';
+import { useCoachmark } from '../Coachmark/utils/context.js';
+
+var _div;
+var _excluded = ["className", "label"];
+// 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-button");
+var componentName = 'CoachmarkButton';
+
+// NOTE: the component SCSS is not imported here: it is rolled up separately.
+
+// Default values can be included here and then assigned to the prop params,
+// e.g. prop = defaults.prop,
+// This gathers default values together neatly and ensures non-primitive
+// values are initialized early to avoid react making unnecessary re-renders.
+// Note that default values are not required for props that are 'required',
+// nor for props where the component can apply undefined values reasonably.
+// Default values should be provided when the component needs to make a choice
+// or assumption when a prop is not supplied.
+
+// Default values for props
+// const defaults = {
+//   /* TODO: add defaults for relevant props if needed */
+// };
+
+/**
+ * Use CoachmarkButton for the target prop of a Coachmark component.
+ */
+var CoachmarkButton = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
+  var className = _ref.className,
+    label = _ref.label,
+    rest = _objectWithoutProperties(_ref, _excluded);
+  var coachmark = useCoachmark();
+  if (!coachmark) {
+    return _div || (_div = /*#__PURE__*/React__default.createElement("div", null, "CoachmarkButton is to be use exclusively within the target prop of Coachmark"));
+  }
+  return /*#__PURE__*/React__default.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
+};
+
+export { CoachmarkButton };

package/es/components/CoachmarkButton/index.d.ts

@@ -0,0 +1 @@
+export { CoachmarkButton } from "./CoachmarkButton";

package/es/components/CoachmarkFixed/CoachmarkFixed.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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 let CoachmarkFixed: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
+import React from 'react';

package/es/components/CoachmarkFixed/CoachmarkFixed.js

@@ -0,0 +1,223 @@
+/**
+ * Copyright IBM Corp. 2020, 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 { objectWithoutProperties as _objectWithoutProperties, slicedToArray as _slicedToArray, extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import React__default, { useRef, useState, useCallback, useEffect } from 'react';
+import PropTypes from '../../node_modules/prop-types/index.js';
+import cx from '../../node_modules/classnames/index.js';
+import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
+import { pkg } from '../../settings.js';
+import { createPortal } from 'react-dom';
+import { CoachmarkOverlay } from '../Coachmark/CoachmarkOverlay.js';
+import { CoachmarkTagline } from '../Coachmark/CoachmarkTagline.js';
+import { CoachmarkContext } from '../Coachmark/utils/context.js';
+import { COACHMARK_OVERLAY_KIND } from '../Coachmark/utils/enums.js';
+
+var _excluded = ["children", "className", "onClose", "portalTarget", "tagline", "theme"];
+// 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 coachmarkClass = "".concat(pkg.prefix, "--coachmark");
+var blockClass = "".concat(coachmarkClass, "-fixed");
+var overlayBlockClass = "".concat(coachmarkClass, "-overlay");
+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.
+ */
+var CoachmarkFixed = /*#__PURE__*/React__default.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 prefersReducedMotion = window.matchMedia('(prefers-reduced-motion: reduce)');
+  var handleClose = useCallback(function () {
+    console.log('HANDLING CLOSE HERE...');
+    if (prefersReducedMotion.matches) {
+      setIsOpen(false);
+    } else {
+      setFixedIsVisible(false);
+    }
+  }, [prefersReducedMotion.matches]);
+  var handleTransitionEnd = function handleTransitionEnd(e) {
+    console.log('Hererrrrrreee at transition end... ', e.propertyName === 'transform' && !fixedIsVisible);
+    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 escFunction = useCallback(function (event) {
+    if (event.key === 'Escape') {
+      handleClose();
+    }
+  }, [handleClose]);
+  useEffect(function () {
+    document.addEventListener('keydown', escFunction, false);
+    return function () {
+      document.removeEventListener('keydown', escFunction, false);
+    };
+  }, [escFunction]);
+  var contextValue = {
+    buttonProps: {
+      'aria-expanded': isOpen,
+      tabIndex: 0,
+      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,
+    tacos: 'tacos'
+  };
+
+  // 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__default.createElement(CoachmarkContext.Provider, {
+    value: contextValue
+  }, /*#__PURE__*/React__default.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__default.createElement(CoachmarkTagline, {
+    title: tagline,
+    onClose: onClose
+  }), isOpen && /*#__PURE__*/createPortal( /*#__PURE__*/React__default.createElement(CoachmarkOverlay, {
+    ref: overlayRef,
+    fixedIsVisible: fixedIsVisible,
+    kind: COACHMARK_OVERLAY_KIND.FIXED,
+    onClose: handleClose,
+    onTransitionEnd: handleTransitionEnd,
+    theme: theme,
+    className: cx(fixedIsVisible && "".concat(overlayBlockClass, "--is-visible"), overlayBlockClass)
+  }, 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'])
+};
+
+export { CoachmarkFixed };

package/es/components/CoachmarkFixed/index.d.ts

@@ -0,0 +1 @@
+export { CoachmarkFixed } from "./CoachmarkFixed";

package/es/components/CoachmarkOverlayElement/CoachmarkOverlayElement.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Component to be displayed within a CoachmarkOverlayElements container.
+ * Can be used 1 to N number, to display content in a Coachmark's overlay
+ * in a carousel fashion.
+ */
+export let CoachmarkOverlayElement: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
+import React from 'react';