@carbon/ibm-products 2.22.0 → 2.24.0

package/lib/components/Coachmark/Coachmark.js

@@ -0,0 +1,264 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Coachmark = void 0;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+var _react = _interopRequireWildcard(require("react"));
+var _classnames = _interopRequireDefault(require("classnames"));
+var _propTypes = _interopRequireWildcard(require("prop-types"));
+var _reactDom = require("react-dom");
+var _CoachmarkOverlay = require("./CoachmarkOverlay");
+var _context = require("./utils/context");
+var _enums = require("./utils/enums");
+var _hooks = require("./utils/hooks");
+var _devtools = require("../../global/js/utils/devtools");
+var _settings = require("../../settings");
+var _lodash = require("lodash");
+var _excluded = ["align", "children", "className", "onClose", "overlayClassName", "overlayKind", "overlayRef", "portalTarget", "positionTune", "target", "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.
+ */
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(_settings.pkg.prefix, "--coachmark");
+var overlayBlockClass = "".concat(blockClass, "-overlay");
+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.
+ */
+
+var Coachmark = exports.Coachmark = /*#__PURE__*/(0, _react.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 = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  var isBeacon = overlayKind === _enums.COACHMARK_OVERLAY_KIND.TOOLTIP;
+  var isStacked = overlayKind === _enums.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 = (0, _react.useState)(isStacked),
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    isOpen = _useState2[0],
+    setIsOpen = _useState2[1];
+  var _useState3 = (0, _react.useState)(false),
+    _useState4 = (0, _slicedToArray2.default)(_useState3, 2),
+    shouldResetPosition = _useState4[0],
+    setShouldResetPosition = _useState4[1];
+  var _useState5 = (0, _react.useState)(),
+    _useState6 = (0, _slicedToArray2.default)(_useState5, 2),
+    targetRect = _useState6[0],
+    setTargetRect = _useState6[1];
+  var _useState7 = (0, _react.useState)({
+      x: 0,
+      y: 0
+    }),
+    _useState8 = (0, _slicedToArray2.default)(_useState7, 2),
+    targetOffset = _useState8[0],
+    setTargetOffset = _useState8[1];
+  var overlayBackupRef = (0, _react.useRef)();
+  var backupRef = (0, _react.useRef)();
+  var _coachmarkRef = ref || backupRef;
+  var _overlayRef = overlayRef || overlayBackupRef;
+  var closeOverlay = function closeOverlay() {
+    setIsOpen(false);
+  };
+  var handleClose = (0, _react.useCallback)(function () {
+    if (isStacked) {
+      // If stacked, do not unmount,
+      // only call its ("parent") onClose method.
+      onClose();
+    } else {
+      setIsOpen(false);
+      onClose();
+    }
+  }, [isStacked, onClose]);
+  var escFunction = (0, _react.useCallback)(function (event) {
+    if (event.key === 'Escape') {
+      handleClose();
+    }
+  }, [handleClose]);
+  (0, _react.useEffect)(function () {
+    document.addEventListener('keydown', escFunction, false);
+    return function () {
+      document.removeEventListener('keydown', escFunction, false);
+    };
+  }, [escFunction]);
+  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,
+      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,
+    align: align,
+    positionTune: positionTune
+  };
+  var handleResize = (0, _lodash.throttle)(function () {
+    closeOverlay();
+  }, 2000);
+
+  // instead of toggling on/off,
+  // keep open and reset to original position
+  (0, _react.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.
+  (0, _react.useEffect)(function () {
+    return function () {
+      return setIsOpen(false);
+    };
+  }, []);
+  (0, _hooks.useClickOutsideElement)(_coachmarkRef, _overlayRef, overlayKind, closeOverlay);
+  (0, _hooks.useWindowEvent)('resize', handleResize);
+  return /*#__PURE__*/_react.default.createElement(_context.CoachmarkContext.Provider, {
+    value: contextValue
+  }, /*#__PURE__*/_react.default.createElement("div", (0, _extends2.default)({
+    className: (0, _classnames.default)(blockClass, "".concat(blockClass, "__").concat(theme), className),
+    ref: _coachmarkRef
+  }, rest, (0, _devtools.getDevtoolsProps)(componentName)), target, isOpen && /*#__PURE__*/(0, _reactDom.createPortal)( /*#__PURE__*/_react.default.createElement(_CoachmarkOverlay.CoachmarkOverlay, {
+    ref: _overlayRef,
+    fixedIsVisible: false,
+    kind: overlayKind,
+    onClose: handleClose,
+    theme: theme,
+    className: (0, _classnames.default)(overlayClassName, "".concat(overlayBlockClass, "--is-visible"))
+  }, children), portalNode)));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.Coachmark = Coachmark = _settings.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.default.oneOf(['bottom', 'bottom-left', 'bottom-right', 'left', 'left-top', 'left-bottom', 'right', 'right-top', 'right-bottom', 'top', 'top-left', 'top-right']),
+  /**
+   * Coachmark should use a single CoachmarkOverlayElements component as a child.
+   * @see CoachmarkOverlayElements
+   */
+  children: _propTypes.default.node.isRequired,
+  /**
+   * Optional class name for this component.
+   */
+  className: _propTypes.default.string,
+  /**
+   * Function to call when the Coachmark closes.
+   */
+  onClose: _propTypes.default.func,
+  /**
+   * Optional class name for the Coachmark Overlay component.
+   */
+  overlayClassName: _propTypes.default.string,
+  /**
+   * What kind or style of Coachmark to render.
+   */
+  overlayKind: _propTypes.default.oneOf(['tooltip', 'floating', 'stacked']),
+  overlayRef: _propTypes.default.oneOfType([
+  // Either a function
+  _propTypes.default.func,
+  // Or the instance of a DOM native element (see the note about SSR)
+  _propTypes.default.shape({
+    current: _propTypes.default.instanceOf(_propTypes.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.default.string,
+  /**
+   * Fine tune the position of the target in pixels. Applies only to Beacons.
+   */
+  positionTune: _propTypes.default.shape({
+    x: _propTypes.default.number,
+    y: _propTypes.default.number
+  }),
+  /**
+   * The optional button or beacon that the user will click to show the Coachmark.
+   */
+  target: _propTypes.default.node,
+  /**
+   * Determines the theme of the component.
+   */
+  theme: _propTypes.default.oneOf(['light', 'dark'])
+};

package/lib/components/Coachmark/CoachmarkDragbar.js

@@ -0,0 +1,151 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CoachmarkDragbar = void 0;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+var _react = _interopRequireWildcard(require("react"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _classnames = _interopRequireDefault(require("classnames"));
+var _icons = require("@carbon/react/icons");
+var _react2 = require("@carbon/react");
+var _devtools = require("../../global/js/utils/devtools");
+var _settings = require("../../settings");
+var _excluded = ["a11yKeyboardHandler", "closeIconDescription", "onClose", "onDrag", "showCloseButton", "theme"];
+/**
+ * Copyright IBM Corp. 2023, 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+// Import portions of React that are needed.
+// Other standard imports.
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+// Carbon and package components we use.
+/* TODO: @import(s) of carbon components and other package components. */ // The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(_settings.pkg.prefix, "--coachmark-dragbar");
+var overlayBlockClass = "".concat(_settings.pkg.prefix, "--coachmark-overlay");
+var componentName = 'CoachmarkDragbar';
+var defaults = {
+  closeIconDescription: 'Close',
+  onDrag: function onDrag() {},
+  onClose: function onClose() {},
+  showCloseButton: true,
+  theme: 'light'
+};
+
+/**
+ * DO NOT USE. This component is for the exclusive use
+ * of other Novice to Pro components.
+ */
+var CoachmarkDragbar = exports.CoachmarkDragbar = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
+  var a11yKeyboardHandler = _ref.a11yKeyboardHandler,
+    _ref$closeIconDescrip = _ref.closeIconDescription,
+    closeIconDescription = _ref$closeIconDescrip === void 0 ? defaults.closeIconDescription : _ref$closeIconDescrip,
+    _ref$onClose = _ref.onClose,
+    onClose = _ref$onClose === void 0 ? defaults.onClose : _ref$onClose,
+    _ref$onDrag = _ref.onDrag,
+    onDrag = _ref$onDrag === void 0 ? defaults.onDrag : _ref$onDrag,
+    _ref$showCloseButton = _ref.showCloseButton,
+    showCloseButton = _ref$showCloseButton === void 0 ? defaults.showCloseButton : _ref$showCloseButton,
+    _ref$theme = _ref.theme,
+    theme = _ref$theme === void 0 ? defaults.theme : _ref$theme,
+    rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  var _useState = (0, _react.useState)(false),
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    isDragging = _useState2[0],
+    setIsDragging = _useState2[1];
+  (0, _react.useEffect)(function () {
+    var handleDragStop = function handleDragStop() {
+      return setIsDragging(false);
+    };
+    window.addEventListener('mouseup', handleDragStop);
+    return function () {
+      window.removeEventListener('mouseup', handleDragStop);
+    };
+  }, []);
+  (0, _react.useEffect)(function () {
+    var handleDrag = function handleDrag(event) {
+      onDrag(event.movementX, event.movementY);
+    };
+    if (isDragging) {
+      window.addEventListener('mousemove', handleDrag);
+    }
+    return function () {
+      window.removeEventListener('mousemove', handleDrag);
+    };
+  }, [isDragging, onDrag]);
+  var handleDragStart = function handleDragStart() {
+    return setIsDragging(true);
+  };
+  return /*#__PURE__*/_react.default.createElement("header", (0, _extends2.default)({}, rest, {
+    className: (0, _classnames.default)(blockClass, // Apply the block class to the main HTML element
+    "".concat(blockClass, "__").concat(theme),
+    // example: `${blockClass}__template-string-class-${kind}-n-${size}`,
+    {
+      // switched classes dependant on props or state
+      // example: [`${blockClass}__here-if-small`]: size === 'sm',
+    }),
+    ref: ref
+    // role="main"
+  }, (0, _devtools.getDevtoolsProps)(componentName)), /*#__PURE__*/_react.default.createElement("button", {
+    type: "button",
+    className: "".concat(overlayBlockClass, "__handle"),
+    onMouseDown: handleDragStart,
+    onKeyDown: a11yKeyboardHandler
+  }, /*#__PURE__*/_react.default.createElement(_icons.Draggable, {
+    size: "16"
+  })), showCloseButton && /*#__PURE__*/_react.default.createElement(_react2.Button, {
+    kind: "ghost",
+    size: "sm",
+    renderIcon: _icons.Close,
+    iconDescription: closeIconDescription,
+    hasIconOnly: true,
+    className: "".concat(overlayBlockClass, "--close-btn"),
+    onClick: onClose
+  }));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.CoachmarkDragbar = CoachmarkDragbar = _settings.pkg.checkComponentEnabled(CoachmarkDragbar, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+CoachmarkDragbar.displayName = componentName;
+
+// The types and DocGen commentary for the component props,
+// in alphabetical order (for consistency).
+// See https://www.npmjs.com/package/prop-types#usage.
+CoachmarkDragbar.propTypes = {
+  /**
+   * Handler to manage keyboard interactions with the dragbar.
+   */
+  a11yKeyboardHandler: _propTypes.default.func.isRequired,
+  /**
+   * Tooltip text and aria label for the Close button icon.
+   */
+  closeIconDescription: _propTypes.default.string,
+  /**
+   * Function to call when the close button is clicked.
+   */
+  onClose: _propTypes.default.func,
+  /**
+   * Function to call when the user clicks and drags the Coachmark.
+   * For internal use only by the parent CoachmarkOverlay.
+   */
+  onDrag: _propTypes.default.func,
+  /**
+   * Show/hide the "X" close button.
+   */
+  showCloseButton: _propTypes.default.bool,
+  /**
+   * Determines the theme of the component.
+   */
+  theme: _propTypes.default.oneOf(['light', 'dark'])
+};

package/lib/components/Coachmark/CoachmarkHeader.js

@@ -0,0 +1,95 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CoachmarkHeader = void 0;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+var _react = _interopRequireDefault(require("react"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _classnames = _interopRequireDefault(require("classnames"));
+var _icons = require("@carbon/react/icons");
+var _react2 = require("@carbon/react");
+var _devtools = require("../../global/js/utils/devtools");
+var _settings = require("../../settings");
+var _excluded = ["closeIconDescription", "onClose", "showCloseButton", "theme"];
+/**
+ * Copyright IBM Corp. 2023, 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+// Import portions of React that are needed.
+// Other standard imports.
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(_settings.pkg.prefix, "--coachmark-header");
+var overlayBlockClass = "".concat(_settings.pkg.prefix, "--coachmark-overlay");
+var componentName = 'CoachmarkHeader';
+var defaults = {
+  closeIconDescription: 'Close',
+  onClose: function onClose() {},
+  showCloseButton: true,
+  theme: 'light'
+};
+
+/**
+ * DO NOT USE. This component is for the exclusive use
+ * of other Novice to Pro components.
+ */
+var CoachmarkHeader = exports.CoachmarkHeader = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
+  var _ref$closeIconDescrip = _ref.closeIconDescription,
+    closeIconDescription = _ref$closeIconDescrip === void 0 ? defaults.closeIconDescription : _ref$closeIconDescrip,
+    _ref$onClose = _ref.onClose,
+    onClose = _ref$onClose === void 0 ? defaults.onClose : _ref$onClose,
+    _ref$showCloseButton = _ref.showCloseButton,
+    showCloseButton = _ref$showCloseButton === void 0 ? defaults.showCloseButton : _ref$showCloseButton,
+    _ref$theme = _ref.theme,
+    theme = _ref$theme === void 0 ? defaults.theme : _ref$theme,
+    rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  return /*#__PURE__*/_react.default.createElement("header", (0, _extends2.default)({}, rest, {
+    className: (0, _classnames.default)(blockClass, "".concat(blockClass, "__").concat(theme)),
+    ref: ref
+    // role="main"
+  }, (0, _devtools.getDevtoolsProps)(componentName)), showCloseButton && /*#__PURE__*/_react.default.createElement("div", {
+    className: "".concat(overlayBlockClass, "--close-btn-container")
+  }, /*#__PURE__*/_react.default.createElement(_react2.Button, {
+    kind: "ghost",
+    size: "sm",
+    renderIcon: _icons.Close,
+    iconDescription: closeIconDescription,
+    hasIconOnly: true,
+    className: "".concat(overlayBlockClass, "--close-btn"),
+    onClick: onClose
+  })));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.CoachmarkHeader = CoachmarkHeader = _settings.pkg.checkComponentEnabled(CoachmarkHeader, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+CoachmarkHeader.displayName = componentName;
+
+// The types and DocGen commentary for the component props,
+// in alphabetical order (for consistency).
+// See https://www.npmjs.com/package/prop-types#usage.
+CoachmarkHeader.propTypes = {
+  /**
+   * Tooltip text and aria label for the Close button icon.
+   */
+  closeIconDescription: _propTypes.default.string,
+  /**
+   * Function to call when the close button is clicked.
+   */
+  onClose: _propTypes.default.func,
+  /**
+   * Show/hide the "X" close button.
+   */
+  showCloseButton: _propTypes.default.bool,
+  /**
+   * Determines the theme of the component.
+   */
+  theme: _propTypes.default.oneOf(['light', 'dark'])
+};