@carbon/ibm-products 1.55.1 → 1.56.0

package/es/components/CoachmarkFixed/index.js

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

package/es/components/CoachmarkOverlayElement/CoachmarkOverlayElement.js

@@ -0,0 +1,86 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["button", "className", "description", "title"];
+/**
+ * Copyright IBM Corp. 2023, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+// Import portions of React that are needed.
+import React from 'react';
+
+// Other standard imports.
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { 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-overlay-element");
+var componentName = 'CoachmarkOverlayElement';
+
+/**
+ * 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 var CoachmarkOverlayElement = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
+  var button = _ref.button,
+    className = _ref.className,
+    description = _ref.description,
+    title = _ref.title,
+    rest = _objectWithoutProperties(_ref, _excluded);
+  return /*#__PURE__*/React.createElement("div", _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="main"
+  }, getDevtoolsProps(componentName)), /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "__content")
+  }, title && /*#__PURE__*/React.createElement("h2", {
+    className: "".concat(blockClass, "__title")
+  }, title), description && /*#__PURE__*/React.createElement("p", {
+    className: "".concat(blockClass, "__body")
+  }, description)), button && /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "__button")
+  }, button));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+CoachmarkOverlayElement = pkg.checkComponentEnabled(CoachmarkOverlayElement, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+CoachmarkOverlayElement.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.
+CoachmarkOverlayElement.propTypes = {
+  /**
+   * An optional button can be rendered below the description.
+   * This can be a link, button, Coachmark button, etc.
+   */
+  button: PropTypes.node,
+  /**
+   * Optional class name for this component.
+   */
+  className: PropTypes.string,
+  /**
+   * The description of the Coachmark.
+   */
+  description: PropTypes.node.isRequired,
+  /**
+   * The title of the Coachmark.
+   */
+  title: PropTypes.string.isRequired
+};

package/es/components/CoachmarkOverlayElement/index.js

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

package/es/components/CoachmarkOverlayElements/CoachmarkOverlayElements.js

@@ -0,0 +1,175 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["className", "children", "media", "nextButtonText", "previousButtonLabel", "closeButtonLabel"];
+/**
+ * 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, { Children, useEffect, useRef, useState } from 'react';
+import { Button } from 'carbon-components-react';
+import cx from 'classnames';
+import PropTypes from 'prop-types';
+import { useCoachmark } from '../Coachmark';
+import { clamp } from 'lodash';
+import pconsole from '../../global/js/utils/pconsole';
+//TODO THIS PATH WILL NEED TO BE UPDATED ONCE IN IBM PRODUCTS
+import { Carousel } from '../Carousel';
+//TODO THIS PATH WILL NEED TO BE UPDATED ONCE IN IBM PRODUCTS
+import { SteppedAnimatedMedia } from '../SteppedAnimatedMedia';
+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-overlay-elements");
+var componentName = 'CoachmarkOverlayElements';
+var defaults = {
+  nextButtonText: 'Next',
+  previousButtonLabel: 'Back',
+  closeButtonLabel: 'Got it'
+};
+
+/**
+ * Composable container to allow for the displaying of CoachmarkOverlayElement
+ * components in a carousel fashion.
+ */
+export var CoachmarkOverlayElements = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
+  var className = _ref.className,
+    children = _ref.children,
+    media = _ref.media,
+    _ref$nextButtonText = _ref.nextButtonText,
+    nextButtonText = _ref$nextButtonText === void 0 ? defaults.nextButtonText : _ref$nextButtonText,
+    _ref$previousButtonLa = _ref.previousButtonLabel,
+    previousButtonLabel = _ref$previousButtonLa === void 0 ? defaults.previousButtonLabel : _ref$previousButtonLa,
+    _ref$closeButtonLabel = _ref.closeButtonLabel,
+    closeButtonLabel = _ref$closeButtonLabel === void 0 ? defaults.closeButtonLabel : _ref$closeButtonLabel,
+    rest = _objectWithoutProperties(_ref, _excluded);
+  var buttonFocusRef = useRef();
+  var scrollRef = useRef();
+  var _useState = useState(0),
+    _useState2 = _slicedToArray(_useState, 2),
+    scrollPosition = _useState2[0],
+    setScrollPosition = _useState2[1];
+  var _useState3 = useState(0),
+    _useState4 = _slicedToArray(_useState3, 2),
+    currentProgStep = _useState4[0],
+    setCurrentProgStep = _useState4[1];
+  var coachmark = useCoachmark();
+  var numProgSteps = Children.count(children);
+  var progStepFloor = 0;
+  var progStepCeil = numProgSteps - 1;
+  useEffect(function () {
+    // On mount, one of the two primary buttons ("next" or "close")
+    // will be rendered and must have focus. (a11y)
+    if (buttonFocusRef.current) {
+      buttonFocusRef.current.focus();
+    }
+  }, []);
+  if (!coachmark) {
+    return pconsole.warn("The ".concat(componentName, " is a composable container element which should be used only within the scope of a Coachmark or a CoachmarkFixed component."));
+  }
+  return /*#__PURE__*/React.createElement("section", _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="main"
+  }, getDevtoolsProps(componentName)), media && (media.render ? media.render() : /*#__PURE__*/React.createElement(SteppedAnimatedMedia, {
+    className: "".concat(blockClass, "__element-stepped-media"),
+    filePaths: media.filePaths,
+    playStep: currentProgStep
+  })), numProgSteps === 1 ? /*#__PURE__*/React.createElement(React.Fragment, null, children, closeButtonLabel && /*#__PURE__*/React.createElement("div", {
+    className: cx("".concat(blockClass, "__footer"), 'coachmark-carousel-controls')
+  }, /*#__PURE__*/React.createElement(Button, _extends({
+    size: "sm"
+  }, coachmark.closeButtonProps), closeButtonLabel))) : /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Carousel, {
+    disableArrowScroll: true,
+    ref: scrollRef
+  }, children), /*#__PURE__*/React.createElement("div", {
+    className: cx("".concat(blockClass, "__footer"))
+  }, /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "--controls-progress")
+  }, "".concat(currentProgStep + 1, " / ").concat(numProgSteps)), scrollPosition > 0 && /*#__PURE__*/React.createElement(Button, {
+    size: "sm",
+    kind: "ghost",
+    title: previousButtonLabel,
+    disabled: scrollPosition === 0,
+    onClick: function onClick() {
+      var targetStep = clamp(currentProgStep - 1, progStepFloor, progStepCeil);
+      scrollRef.current.scrollToView(targetStep).then(function (scrollPercentage) {
+        setScrollPosition(scrollPercentage);
+      });
+      setCurrentProgStep(targetStep);
+    }
+  }, previousButtonLabel), currentProgStep < progStepCeil ? /*#__PURE__*/React.createElement(Button, {
+    size: "sm",
+    ref: buttonFocusRef,
+    title: nextButtonText,
+    disabled: scrollPosition === 1,
+    onClick: function onClick() {
+      var targetStep = clamp(currentProgStep + 1, progStepFloor, progStepCeil);
+      scrollRef.current.scrollToView(targetStep).then(function (scrollPercentage) {
+        setScrollPosition(scrollPercentage);
+      });
+      setCurrentProgStep(targetStep);
+    }
+  }, nextButtonText) : closeButtonLabel && /*#__PURE__*/React.createElement(Button, _extends({
+    size: "sm",
+    ref: buttonFocusRef
+  }, coachmark.closeButtonProps), closeButtonLabel))));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+CoachmarkOverlayElements = pkg.checkComponentEnabled(CoachmarkOverlayElements, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+CoachmarkOverlayElements.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.
+CoachmarkOverlayElements.propTypes = {
+  // TODO: UPDATE COMMENT HERE - UPDATE MDX TO HAVE DIRECTION TO USE ONLY OVERLAY ELEMENTS>...CoachmarkOverlayElements will accept only one or more CoachmarkOverlayElement as child components.
+
+  /**
+   * CoachmarkOverlayElements should be used with one or many CoachmarkOverlayElement components as children.
+   * @see CoachmarkOverlayElement
+   */
+  children: PropTypes.node.isRequired,
+  /**
+   * Optional class name for this component.
+   */
+  className: PropTypes.string,
+  /**
+   * The label for the Close button.
+   */
+  closeButtonLabel: PropTypes.string,
+  /**
+   * The object describing an image in one of two shapes.
+   * If a single media element is required, use `{render}`.
+   * If a stepped animation is required, use `{filePaths}`.
+   */
+  media: PropTypes.oneOfType([PropTypes.shape({
+    render: PropTypes.func
+  }), PropTypes.shape({
+    filePaths: PropTypes.arrayOf(PropTypes.string)
+  })]),
+  /**
+   * The label for the Next button.
+   */
+  nextButtonText: PropTypes.string,
+  /**
+   * The label for the Previous button.
+   */
+  previousButtonLabel: PropTypes.string
+};

package/es/components/CoachmarkOverlayElements/index.js

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

package/es/components/CoachmarkStack/CoachmarkStack.js

@@ -0,0 +1,260 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["children", "className", "onClose", "description", "media", "navLinkLabels", "portalTarget", "closeButtonLabel", "tagline", "theme", "title"];
+/**
+ * Copyright IBM Corp. 2023, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import React, { Children, useEffect, useRef, useState } from 'react';
+import { createPortal } from 'react-dom';
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { getDevtoolsProps } from '../../global/js/utils/devtools';
+import { pkg } from '../../settings';
+import { CoachmarkOverlay } from '../Coachmark/CoachmarkOverlay';
+import { CoachmarkStackHome } from './CoachmarkStackHome';
+import { CoachmarkTagline } from '../Coachmark/CoachmarkTagline';
+import { CoachmarkContext } from '../Coachmark/utils/context';
+import { COACHMARK_OVERLAY_KIND } from '../Coachmark/utils/enums';
+var blockClass = "".concat(pkg.prefix, "--coachmark-stack");
+var elementBlockClass = "".concat(pkg.prefix, "--coachmark-stack-element");
+var componentName = 'CoachmarkStack';
+var defaults = {
+  onClose: function onClose() {},
+  // Pass through to CoachmarkStackHome
+  theme: 'light'
+};
+
+// NOTE
+// The stack is limited to a depth of two Coachmarks:
+// - a single parent CoachmarkStackHome
+// - a single child Coachmark when stacked
+// The parent will include links to all the children.
+// No child Coachmark will include links to any other child Coachmarks.
+
+/**
+ * Stacked 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 stacking of multiple coachmark overlays to be displayed by interacting with the tagline.
+ */
+export var CoachmarkStack = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
+  var _document$querySelect;
+  var children = _ref.children,
+    className = _ref.className,
+    _ref$onClose = _ref.onClose,
+    onClose = _ref$onClose === void 0 ? defaults.onClose : _ref$onClose,
+    description = _ref.description,
+    media = _ref.media,
+    navLinkLabels = _ref.navLinkLabels,
+    _ref$portalTarget = _ref.portalTarget,
+    portalTarget = _ref$portalTarget === void 0 ? defaults.portalTarget : _ref$portalTarget,
+    closeButtonLabel = _ref.closeButtonLabel,
+    tagline = _ref.tagline,
+    _ref$theme = _ref.theme,
+    theme = _ref$theme === void 0 ? defaults.theme : _ref$theme,
+    title = _ref.title,
+    rest = _objectWithoutProperties(_ref, _excluded);
+  var portalNode = portalTarget ? (_document$querySelect = document.querySelector(portalTarget)) !== null && _document$querySelect !== void 0 ? _document$querySelect : document.querySelector('body') : document.querySelector('body');
+  var stackHomeRef = useRef();
+  var stackedCoachmarkRefs = useRef([]);
+  var _useState = useState(false),
+    _useState2 = _slicedToArray(_useState, 2),
+    isOpen = _useState2[0],
+    setIsOpen = _useState2[1];
+  // selectedItemNumber -1 = parent close button was clicked, remove entire stack
+  // selectedItemNumber 0 = (default) the parent is visible, all children are hidden
+  // selectedItemNumber 1+ = a child is visible and stacked atop the parent
+  var _useState3 = useState(0),
+    _useState4 = _slicedToArray(_useState3, 2),
+    selectedItemNumber = _useState4[0],
+    setSelectedItemNumber = _useState4[1];
+  // // The parent height and width values to return to after unstacked
+  var _useState5 = useState(null),
+    _useState6 = _slicedToArray(_useState5, 2),
+    parentHeight = _useState6[0],
+    setParentHeight = _useState6[1];
+  // parent height = child height when stacked behind a child that is shorter
+  var childArray = Children.toArray(children);
+  var mountedRef = useRef();
+  // same value as CSS animation speed
+  var delayMs = 240;
+
+  // Unmount or unstack a child
+  var handleClickNavItem = function handleClickNavItem(itemNumber) {
+    setSelectedItemNumber(itemNumber);
+  };
+  var handleClose = function handleClose(isParentCloseButton) {
+    if (isParentCloseButton) {
+      // Trigger slide-out animation
+      setSelectedItemNumber(-1);
+
+      // Unmount after animation is complete
+      var timer = setTimeout(function () {
+        setIsOpen(false);
+        onClose();
+      }, delayMs);
+      return function () {
+        return clearTimeout(timer);
+      };
+    } else {
+      // Unstack child
+      setSelectedItemNumber(0);
+    }
+  };
+  var contextValue = {
+    buttonProps: {
+      'aria-expanded': isOpen,
+      onClick: function onClick() {
+        setIsOpen(true);
+      },
+      // Compensate for accidental open/close on double-click.
+      // Only open on double-click.
+      onDoubleClick: function onDoubleClick() {
+        setIsOpen(true);
+      }
+    },
+    closeButtonProps: {
+      onClick: function onClick() {
+        return handleClose(false);
+      }
+    },
+    isOpen: isOpen
+  };
+  useEffect(function () {
+    mountedRef.current = true;
+    return function () {
+      mountedRef.current = false;
+    };
+  }, []);
+  useEffect(function () {
+    setTimeout(function () {
+      if (stackHomeRef.current) {
+        setParentHeight(stackHomeRef.current.clientHeight);
+      }
+    }, 0);
+  }, [stackHomeRef]);
+  useEffect(function () {
+    var targetSelectedItem = selectedItemNumber - 1;
+    if (!parentHeight) {
+      return;
+    }
+    stackHomeRef.current.style.height = "".concat(parentHeight, "px");
+    if (!isOpen || targetSelectedItem < 0) {
+      return;
+    }
+    var targetHomeHeight = stackedCoachmarkRefs.current[targetSelectedItem].clientHeight;
+    stackHomeRef.current.style.height = "".concat(targetHomeHeight, "px");
+  }, [selectedItemNumber, isOpen, parentHeight]);
+  var wrappedChildren = Children.map(childArray, function (child, idx) {
+    var mountedClass = mountedRef.current ? "".concat(elementBlockClass, "--is-mounted") : '';
+    return /*#__PURE__*/React.createElement(CoachmarkOverlay, {
+      key: idx,
+      ref: function ref(_ref2) {
+        return stackedCoachmarkRefs.current[idx] = _ref2;
+      },
+      kind: COACHMARK_OVERLAY_KIND.STACKED,
+      onClose: function onClose() {
+        return handleClose(false);
+      },
+      theme: theme,
+      fixedIsVisible: false,
+      className: cx(elementBlockClass, mountedClass, idx === selectedItemNumber - 1 && "".concat(elementBlockClass, "--is-visible"), mountedRef.current && "".concat(elementBlockClass, "--is-mounted"))
+    }, child);
+  });
+  return /*#__PURE__*/React.createElement(CoachmarkContext.Provider, {
+    value: contextValue
+  }, /*#__PURE__*/React.createElement("div", _extends({}, rest, {
+    className: cx(blockClass, "".concat(pkg.prefix, "--coachmark-overlay--stack"), className),
+    ref: ref
+  }, getDevtoolsProps(componentName)), /*#__PURE__*/React.createElement(CoachmarkTagline, {
+    title: tagline,
+    onClose: onClose
+  }), /*#__PURE__*/React.createElement(CoachmarkStackHome, {
+    ref: stackHomeRef,
+    className: cx("".concat(pkg.prefix, "--coachmark-overlay"), "".concat(pkg.prefix, "--coachmark-overlay__").concat(theme), elementBlockClass, selectedItemNumber > 0 && "".concat(elementBlockClass, "--is-stacked"), selectedItemNumber > 0 && "".concat(elementBlockClass, "--is-stacked__").concat(theme), isOpen && "".concat(elementBlockClass, "--is-visible"), mountedRef.current && "".concat(elementBlockClass, "--is-mounted")),
+    description: description,
+    media: media,
+    navLinkLabels: navLinkLabels,
+    onClickNavItem: handleClickNavItem,
+    onClose: function onClose() {
+      handleClose(true);
+    },
+    portalTarget: portalTarget,
+    closeButtonLabel: closeButtonLabel,
+    title: title
+  }), /*#__PURE__*/createPortal(wrappedChildren, portalNode)));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+CoachmarkStack = pkg.checkComponentEnabled(CoachmarkStack, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+CoachmarkStack.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.
+CoachmarkStack.propTypes = {
+  /**
+   * CoachmarkStack should use a single CoachmarkOverlayElements component as a child.
+   */
+  children: PropTypes.node.isRequired,
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: PropTypes.string,
+  /**
+   * The label for the button that will close the Stack
+   */
+  closeButtonLabel: PropTypes.string,
+  // Pass through to CoachmarkStackHome
+  /**
+   * The description of the Coachmark.
+   */
+  description: PropTypes.node.isRequired,
+  /**
+   * The object describing an image in one of two shapes.
+   *
+   * If a single media element is required, use `{render}`.
+   *
+   * If a stepped animation is required, use `{filePaths}`.
+   *
+   * @see {@link MEDIA_PROP_TYPE}.
+   */
+  media: PropTypes.oneOfType([PropTypes.shape({
+    render: PropTypes.func
+  }), PropTypes.shape({
+    filePaths: PropTypes.arrayOf(PropTypes.string)
+  })]),
+  /**
+   * The labels used to link to the stackable Coachmarks.
+   */
+  navLinkLabels: PropTypes.arrayOf(PropTypes.string).isRequired,
+  /**
+   * Function to call when the CoachmarkStack closes.
+   */
+  onClose: PropTypes.func,
+  /**
+   * Where in the DOM to render the stack.
+   * The default is `document.body`.
+   */
+  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']),
+  /**
+   * The title of the Coachmark.
+   */
+  title: PropTypes.string.isRequired
+};