@carbon/ibm-products 2.43.2-canary.22 → 2.43.2-canary.226

package/es/components/CoachmarkStack/CoachmarkStack.d.ts

@@ -1,8 +1,73 @@
+/**
+ * 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 React, { ReactNode } from 'react';
+type Media = {
+    render?: () => ReactNode;
+} | {
+    filePaths?: string[];
+};
+interface CoachmarkStackProps {
+    /**
+     * CoachmarkStack should use a single CoachmarkOverlayElements component as a child.
+     */
+    children: ReactNode;
+    /**
+     * Provide an optional class to be applied to the containing node.
+     */
+    className?: string;
+    /**
+     * The label for the button that will close the Stack
+     */
+    closeButtonLabel?: string;
+    /**
+     * The description of the Coachmark.
+     */
+    description: ReactNode;
+    /**
+     * 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?: Media;
+    /**
+     * The labels used to link to the stackable Coachmarks.
+     */
+    navLinkLabels: string[];
+    /**
+     * Function to call when the CoachmarkStack closes.
+     */
+    onClose?: () => void;
+    /**
+     * Where in the DOM to render the stack.
+     * The default is `document.body`.
+     */
+    portalTarget?: string;
+    /**
+     * The tagline title which will be fixed to the bottom right of the window and will serve as the display trigger.
+     */
+    tagline: string;
+    /**
+     * Determines the theme of the component.
+     */
+    theme?: 'light' | 'dark';
+    /**
+     * The title of the Coachmark.
+     */
+    title: string;
+}
 /**
  * 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 let CoachmarkStack: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let CoachmarkStack: React.ForwardRefExoticComponent<CoachmarkStackProps & React.RefAttributes<HTMLDivElement>>;
+export {};

package/es/components/CoachmarkStack/CoachmarkStack.js

@@ -17,6 +17,7 @@ import { CoachmarkStackHome } from './CoachmarkStackHome.js';
 import { CoachmarkTagline } from '../Coachmark/CoachmarkTagline.js';
 import { CoachmarkContext } from '../Coachmark/utils/context.js';
 import { COACHMARK_OVERLAY_KIND } from '../Coachmark/utils/enums.js';
+import { useIsomorphicEffect } from '../../global/js/hooks/useIsomorphicEffect.js';
 
 var _excluded = ["children", "className", "onClose", "description", "media", "navLinkLabels", "portalTarget", "closeButtonLabel", "tagline", "theme", "title"];
 
@@ -30,7 +31,8 @@ var elementBlockClass = "".concat(pkg.prefix, "--coachmark-stack-element");
 var defaults = {
   onClose: function onClose() {},
   // Pass through to CoachmarkStackHome
-  theme: 'light'
+  theme: 'light',
+  portalTarget: 'body'
 };
 
 // NOTE
@@ -47,7 +49,6 @@ var defaults = {
  * This variant allows the stacking of multiple coachmark overlays to be displayed by interacting with the tagline.
  */
 var CoachmarkStack = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
-  var _document$querySelect;
   var children = _ref.children,
     className = _ref.className,
     _ref$onClose = _ref.onClose,
@@ -63,8 +64,12 @@ var CoachmarkStack = /*#__PURE__*/React__default.forwardRef(function (_ref, ref)
     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 portalNode = useRef(null);
+  useIsomorphicEffect(function () {
+    var _document$querySelect, _document, _document2, _document3;
+    portalNode.current = portalTarget ? (_document$querySelect = (_document = document) === null || _document === void 0 ? void 0 : _document.querySelector(portalTarget)) !== null && _document$querySelect !== void 0 ? _document$querySelect : (_document2 = document) === null || _document2 === void 0 ? void 0 : _document2.querySelector('body') : (_document3 = document) === null || _document3 === void 0 ? void 0 : _document3.querySelector('body');
+  }, [portalTarget]);
+  var stackHomeRef = useRef(null);
   var stackedCoachmarkRefs = useRef([]);
   var _useState = useState(false),
     _useState2 = _slicedToArray(_useState, 2),
@@ -78,7 +83,7 @@ var CoachmarkStack = /*#__PURE__*/React__default.forwardRef(function (_ref, ref)
     selectedItemNumber = _useState4[0],
     setSelectedItemNumber = _useState4[1];
   // // The parent height and width values to return to after unstacked
-  var _useState5 = useState(null),
+  var _useState5 = useState(),
     _useState6 = _slicedToArray(_useState5, 2),
     parentHeight = _useState6[0],
     setParentHeight = _useState6[1];
@@ -159,14 +164,20 @@ var CoachmarkStack = /*#__PURE__*/React__default.forwardRef(function (_ref, ref)
     if (!parentHeight) {
       return;
     }
-    stackHomeRef.current.style.height = "".concat(parentHeight, "px");
+    if (stackHomeRef.current) {
+      stackHomeRef.current.style.height = "".concat(parentHeight, "px");
+    }
     if (!isOpen || targetSelectedItem < 0) {
-      stackHomeRef.current.focus();
+      if (stackHomeRef.current) {
+        stackHomeRef.current.focus();
+      }
       return;
     }
     var targetHomeHeight = stackedCoachmarkRefs.current[targetSelectedItem].clientHeight;
-    stackHomeRef.current.style.height = "".concat(targetHomeHeight, "px");
-    stackedCoachmarkRefs.current[targetSelectedItem].focus();
+    if (stackHomeRef.current) {
+      stackHomeRef.current.style.height = "".concat(targetHomeHeight, "px");
+      stackedCoachmarkRefs.current[targetSelectedItem].focus();
+    }
   }, [selectedItemNumber, isOpen, parentHeight]);
   var wrappedChildren = Children.map(childArray, function (child, idx) {
     var mountedClass = mountedRef.current ? "".concat(elementBlockClass, "--is-mounted") : '';
@@ -206,7 +217,7 @@ var CoachmarkStack = /*#__PURE__*/React__default.forwardRef(function (_ref, ref)
     portalTarget: portalTarget,
     closeButtonLabel: closeButtonLabel,
     title: title
-  }), /*#__PURE__*/createPortal(wrappedChildren, portalNode)));
+  }), portalNode !== null && portalNode !== void 0 && portalNode.current ? /*#__PURE__*/createPortal(wrappedChildren, portalNode === null || portalNode === void 0 ? void 0 : portalNode.current) : null));
 });
 
 // Return a placeholder if not released and not enabled by feature flag
@@ -254,7 +265,7 @@ CoachmarkStack.propTypes = {
   /**
    * The labels used to link to the stackable Coachmarks.
    */
-  navLinkLabels: PropTypes.arrayOf(PropTypes.string).isRequired,
+  navLinkLabels: PropTypes.arrayOf(PropTypes.string.isRequired).isRequired,
   /**
    * Function to call when the CoachmarkStack closes.
    */

package/es/components/CoachmarkStack/CoachmarkStackHome.d.ts

@@ -1,6 +1,75 @@
+/**
+ * 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 React, { ReactNode } from 'react';
+type Media = {
+    render?: () => ReactNode;
+    filePaths?: never;
+} | {
+    render?: never;
+    filePaths?: string[];
+};
+interface CoachmarkStackHomeProps {
+    /**
+     * Optional class name for this component.
+     */
+    className?: string;
+    /**
+     * The label for the button that will close the stack
+     */
+    closeButtonLabel?: string;
+    /**
+     * The description of the Coachmark.
+     */
+    description: React.ReactNode;
+    /**
+     * If the stack home is open.
+     */
+    isOpen: boolean;
+    /**
+     * 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?: Media;
+    /**
+     * The labels used to link to the stackable Coachmarks.
+     */
+    navLinkLabels: string[];
+    /**
+     * For internal use only by CoachmarkStack and CoachmarkStackHome.
+     */
+    onClickNavItem: (index: number) => void;
+    /**
+     * Function to call when the stack closes.
+     */
+    onClose: () => void;
+    /**
+     * By default, the CoachmarkStackHome will be appended to the end of `document.body`.
+     * The CoachmarkStackHome will remain persistent as the user navigates the app until
+     * the user closes the CoachmarkStackHome.
+     *
+     * Alternatively, the app developer can tightly couple the CoachmarkStackHome to a DOM
+     * element or other component by specifying a CSS selector. The CoachmarkStackHome will
+     * remain visible as long as that element remains visible or mounted. When the
+     * element is hidden or component is unmounted, the CoachmarkStackHome will disappear.
+     */
+    portalTarget?: string;
+    /**
+     * The title of the Coachmark.
+     */
+    title: string;
+}
 /**
  * DO NOT USE. This component is for the exclusive use
  * of other Onboarding components.
  */
-export let CoachmarkStackHome: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let CoachmarkStackHome: React.ForwardRefExoticComponent<CoachmarkStackHomeProps & React.RefAttributes<HTMLDivElement>>;
+export {};

package/es/components/CoachmarkStack/CoachmarkStackHome.js

@@ -17,9 +17,9 @@ import { pkg } from '../../settings.js';
 import { createPortal } from 'react-dom';
 import { CoachmarkHeader } from '../Coachmark/CoachmarkHeader.js';
 import { SteppedAnimatedMedia } from '../SteppedAnimatedMedia/SteppedAnimatedMedia.js';
+import { useIsomorphicEffect } from '../../global/js/hooks/useIsomorphicEffect.js';
 
 var _excluded = ["className", "description", "isOpen", "media", "navLinkLabels", "onClickNavItem", "onClose", "portalTarget", "closeButtonLabel", "title"];
-
 // Carbon and package components we use.
 /* TODO: @import(s) of carbon components and other package components. */
 
@@ -33,7 +33,6 @@ var componentName = 'CoachmarkStackHome';
  * of other Onboarding components.
  */
 var CoachmarkStackHome = /*#__PURE__*/forwardRef(function (_ref, ref) {
-  var _document$querySelect;
   var className = _ref.className,
     description = _ref.description,
     isOpen = _ref.isOpen,
@@ -45,7 +44,7 @@ var CoachmarkStackHome = /*#__PURE__*/forwardRef(function (_ref, ref) {
     closeButtonLabel = _ref.closeButtonLabel,
     title = _ref.title,
     rest = _objectWithoutProperties(_ref, _excluded);
-  var buttonFocusRef = useRef();
+  var buttonFocusRef = useRef(null);
   var _useState = useState(0),
     _useState2 = _slicedToArray(_useState, 2),
     linkFocusIndex = _useState2[0],
@@ -57,14 +56,31 @@ var CoachmarkStackHome = /*#__PURE__*/forwardRef(function (_ref, ref) {
       }
     }, 100);
   }, [isOpen]);
+  var portalNode = useRef(null);
+  useIsomorphicEffect(function () {
+    var _document$querySelect, _document, _document2, _document3;
+    portalNode.current = portalTarget ? (_document$querySelect = (_document = document) === null || _document === void 0 ? void 0 : _document.querySelector(portalTarget)) !== null && _document$querySelect !== void 0 ? _document$querySelect : (_document2 = document) === null || _document2 === void 0 ? void 0 : _document2.querySelector('body') : (_document3 = document) === null || _document3 === void 0 ? void 0 : _document3.querySelector('body');
+  }, [portalTarget]);
   if (!navLinkLabels) {
     return pconsole.warn("".concat(componentName, " is an Onboarding internal component and is not intended for general use."));
   }
-  var portalNode = portalTarget ? (_document$querySelect = document.querySelector(portalTarget)) !== null && _document$querySelect !== void 0 ? _document$querySelect : document.querySelector('body') : document.querySelector('body');
-  return /*#__PURE__*/createPortal( /*#__PURE__*/React__default.createElement("div", _extends({}, rest, {
+  function renderNavLink(index, label) {
+    var ref = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
+    return /*#__PURE__*/React__default.createElement("li", {
+      key: index
+    }, /*#__PURE__*/React__default.createElement(Button, {
+      kind: "ghost",
+      size: "sm",
+      onClick: function onClick() {
+        setLinkFocusIndex(index);
+        onClickNavItem(index + 1);
+      },
+      ref: ref
+    }, label));
+  }
+  return portalNode !== null && portalNode !== void 0 && portalNode.current ? /*#__PURE__*/createPortal( /*#__PURE__*/React__default.createElement("div", _extends({}, rest, {
     className: cx(blockClass, className),
-    ref: ref,
-    role: "main"
+    ref: ref
   }, getDevtoolsProps(componentName)), /*#__PURE__*/React__default.createElement(CoachmarkHeader, {
     onClose: function onClose() {
       setLinkFocusIndex(0);
@@ -92,9 +108,8 @@ var CoachmarkStackHome = /*#__PURE__*/forwardRef(function (_ref, ref) {
   }, navLinkLabels.map(function (label, index) {
     if (index === linkFocusIndex) {
       return renderNavLink(index, label, buttonFocusRef);
-    } else {
-      return renderNavLink(index, label);
     }
+    return renderNavLink(index, label);
   })), closeButtonLabel && /*#__PURE__*/React__default.createElement("div", {
     className: "".concat(overlayClass, "__footer")
   }, /*#__PURE__*/React__default.createElement(Button, {
@@ -103,21 +118,7 @@ var CoachmarkStackHome = /*#__PURE__*/forwardRef(function (_ref, ref) {
       setLinkFocusIndex(0);
       _onClose();
     }
-  }, closeButtonLabel))))), portalNode);
-  function renderNavLink(index, label) {
-    var ref = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
-    return /*#__PURE__*/React__default.createElement("li", {
-      key: index
-    }, /*#__PURE__*/React__default.createElement(Button, {
-      kind: "ghost",
-      size: "sm",
-      onClick: function onClick() {
-        setLinkFocusIndex(index);
-        onClickNavItem(index + 1);
-      },
-      ref: ref
-    }, label));
-  }
+  }, closeButtonLabel))))), portalNode === null || portalNode === void 0 ? void 0 : portalNode.current) : null;
 });
 
 // Return a placeholder if not released and not enabled by feature flag
@@ -164,7 +165,7 @@ CoachmarkStackHome.propTypes = {
   /**
    * The labels used to link to the stackable Coachmarks.
    */
-  navLinkLabels: PropTypes.arrayOf(PropTypes.string).isRequired,
+  navLinkLabels: PropTypes.arrayOf(PropTypes.string.isRequired).isRequired,
   /**
    * For internal use only by CoachmarkStack and CoachmarkStackHome.
    */

package/es/components/ComboButton/ComboButton.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React, { ComponentProps, ReactNode } from 'react';
-interface ComboButtonProps extends ComponentProps<'div'> {
+export interface ComboButtonProps extends ComponentProps<'div'> {
     /** Provide the contents of the `ComboButton` */
     children?: ReactNode;
     /** Provide an optional class to be applied to the containing node */

package/es/components/ComboButton/ComboButton.js

@@ -6,13 +6,13 @@
  */
 
 import { objectWithoutProperties as _objectWithoutProperties, slicedToArray as _slicedToArray, objectSpread2 as _objectSpread2, toArray as _toArray, extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import { OverflowMenu, Button, OverflowMenuItem } from '@carbon/react';
 import { ChevronUp, ChevronDown } from '@carbon/react/icons';
-import { Button, OverflowMenu, OverflowMenuItem } from '@carbon/react';
-import cx from 'classnames';
-import { p as propTypesExports } from '../../node_modules/prop-types/index.js';
-import uuidv4 from '../../global/js/utils/uuidv4.js';
 import React__default, { forwardRef, useRef, useState, Children, createElement } from 'react';
+import { p as propTypesExports } from '../../node_modules/prop-types/index.js';
+import cx from 'classnames';
 import { pkg } from '../../settings.js';
+import uuidv4 from '../../global/js/utils/uuidv4.js';
 
 var _excluded = ["children", "className", "overflowMenu"],
   _excluded2 = ["children", "renderIcon"];

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

@@ -1,2 +1,9 @@
-export { ComboButton } from "./ComboButton";
-export { ComboButtonItem } from "./ComboButtonItem";
+/**
+ * Copyright IBM Corp. 2020, 2021
+ *
+ * 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 { ComboButton } from './ComboButton';
+export { ComboButtonItem } from './ComboButtonItem';
+export type { ComboButtonProps } from './ComboButton';

package/es/components/ConditionBuilder/ConditionBlock/ConditionBlock.d.ts

@@ -1,28 +1,104 @@
-export default ConditionBlock;
+/**
+ * Copyright IBM Corp. 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 React from 'react';
+import PropTypes from 'prop-types';
+import { Condition, ConditionGroup, LogicalOperator } from '../ConditionBuilder.types';
 /**
  * This component build each block of condition consisting of property, operator value and close button.
  */
-declare function ConditionBlock(props: any): import("react/jsx-runtime").JSX.Element;
-declare namespace ConditionBlock {
-    namespace propTypes {
-        let addConditionHandler: PropTypes.Requireable<(...args: any[]) => any>;
-        let addConditionSubGroupHandler: PropTypes.Requireable<(...args: any[]) => any>;
-        let aria: PropTypes.Requireable<object>;
-        let condition: PropTypes.Requireable<object>;
-        let conditionIndex: PropTypes.Requireable<number>;
-        let conjunction: PropTypes.Requireable<string>;
-        let group: PropTypes.Requireable<object>;
-        let hideConditionPreviewHandler: PropTypes.Requireable<(...args: any[]) => any>;
-        let hideConditionSubGroupPreviewHandler: PropTypes.Requireable<(...args: any[]) => any>;
-        let isLastCondition: PropTypes.Requireable<(...args: any[]) => any>;
-        let isStatement: PropTypes.Requireable<boolean>;
-        let onChange: PropTypes.Requireable<(...args: any[]) => any>;
-        let onConnectorOperatorChange: PropTypes.Requireable<(...args: any[]) => any>;
-        let onRemove: PropTypes.Requireable<(...args: any[]) => any>;
-        let onStatementChange: PropTypes.Requireable<(...args: any[]) => any>;
-        let showConditionPreviewHandler: PropTypes.Requireable<(...args: any[]) => any>;
-        let showConditionSubGroupPreviewHandler: PropTypes.Requireable<(...args: any[]) => any>;
-        let state: PropTypes.Requireable<object>;
-    }
+interface ConditionBlockProps {
+    condition?: Condition;
+    onRemove: (e: React.MouseEvent<HTMLButtonElement>) => void;
+    onChange: (condition: Condition) => void;
+    onConnectorOperatorChange?: (op: string) => void;
+    onStatementChange?: (v: string) => void;
+    addConditionHandler?: (conditionIndex: number) => void;
+    addConditionSubGroupHandler?: (conditionIndex: number) => void;
+    hideConditionSubGroupPreviewHandler?: () => void;
+    showConditionSubGroupPreviewHandler?: () => void;
+    hideConditionPreviewHandler?: () => void;
+    showConditionPreviewHandler?: () => void;
+    conjunction?: LogicalOperator;
+    isStatement?: boolean;
+    group: ConditionGroup;
+    conditionIndex: number;
+    aria: {
+        level: number;
+        posinset: number;
+        setsize?: number;
+    };
+    isLastCondition: (index: number, conditions: (ConditionGroup | Condition)[]) => void;
 }
-import PropTypes from 'prop-types';
+declare const ConditionBlock: {
+    (props: ConditionBlockProps): import("react/jsx-runtime").JSX.Element;
+    propTypes: {
+        /**
+         * callback to add a new condition
+         */
+        addConditionHandler: PropTypes.Requireable<(...args: any[]) => any>;
+        /**
+         * callback to add a new condition subgroup
+         */
+        addConditionSubGroupHandler: PropTypes.Requireable<(...args: any[]) => any>;
+        /**
+         * object hold aria attributes
+         */
+        aria: PropTypes.Requireable<object>;
+        condition: PropTypes.Requireable<object>;
+        conditionIndex: PropTypes.Requireable<number>;
+        /**
+         * string that decides to show the condition connector
+         */
+        conjunction: PropTypes.Requireable<string>;
+        /**
+         * object that hold the current group object where is condition is part of
+         */
+        group: PropTypes.Requireable<object>;
+        /**
+         * handler for hiding sub group preview
+         */
+        hideConditionPreviewHandler: PropTypes.Requireable<(...args: any[]) => any>;
+        /**
+         * handler for hiding sub group preview
+         */
+        hideConditionSubGroupPreviewHandler: PropTypes.Requireable<(...args: any[]) => any>;
+        isLastCondition: PropTypes.Requireable<(...args: any[]) => any>;
+        /**
+         *  boolean that decides to show the statement(if/ excl.if)
+         */
+        isStatement: PropTypes.Requireable<boolean>;
+        /**
+         * callback to update the current condition of the state tree
+         */
+        onChange: PropTypes.Requireable<(...args: any[]) => any>;
+        /**
+         * callback to handle the connector(and/or) change
+         */
+        onConnectorOperatorChange: PropTypes.Requireable<(...args: any[]) => any>;
+        /**
+         * callback for Remove a condition
+         */
+        onRemove: PropTypes.Requireable<(...args: any[]) => any>;
+        /**
+         * callback to handle the statement(if/ excl.if) change
+         */
+        onStatementChange: PropTypes.Requireable<(...args: any[]) => any>;
+        /**
+         * handler for showing add condition preview
+         */
+        showConditionPreviewHandler: PropTypes.Requireable<(...args: any[]) => any>;
+        /**
+         * handler for showing sub group preview
+         */
+        showConditionSubGroupPreviewHandler: PropTypes.Requireable<(...args: any[]) => any>;
+        /**
+         * object that hold the current condition
+         */
+        state: PropTypes.Requireable<object>;
+    };
+};
+export default ConditionBlock;