@carbon/ibm-products 2.89.0 → 2.90.0

package/es/components/UserProfileImage/UserProfileImage.js

@@ -15,7 +15,6 @@ import React from "react";
 import PropTypes from "prop-types";
 import { Tooltip, usePrefix } from "@carbon/react";
 import { Group, User } from "@carbon/react/icons";
-
 //#region src/components/UserProfileImage/UserProfileImage.tsx
 var import_classnames = /* @__PURE__ */ __toESM(require_classnames());
 const blockClass = `${pkg.prefix}--user-profile-image`;
@@ -114,6 +113,10 @@ UserProfileImage.deprecated = {
 };
 UserProfileImage.displayName = componentName;
 UserProfileImage.propTypes = {
+	/**
+	* The background color passed should match one of the background colors in the library documentation:
+	* https://pages.github.ibm.com/carbon/ibm-products/patterns/user-profile-images/
+	*/
 	backgroundColor: PropTypes.oneOf([
 		"light-cyan",
 		"dark-cyan",
@@ -128,18 +131,47 @@ UserProfileImage.propTypes = {
 		"light-teal",
 		"dark-teal"
 	]),
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* Provide a custom icon to use if you need to use an icon other than the included ones
+	*/
 	icon: PropTypes.func,
+	/**
+	* When passing the image prop, supply a full path to the image to be displayed.
+	*/
+	/**@ts-ignore */
 	image: PropTypes.string,
+	/**
+	* When passing the image prop use the imageDescription prop to describe the image for screen reader.
+	*/
+	/**@ts-ignore */
 	imageDescription: PropTypes.string,
+	/**
+	* When passing the initials prop, either send the initials to be used or the user's display name. The first two capital letters of the display name will be used as the initials.
+	*/
 	initials: PropTypes.string,
+	/**
+	* When passing the kind prop, use either "user" or "group". The values match up to the Carbon Library icons.
+	*/
 	kind: PropTypes.oneOf(["user", "group"]),
+	/**
+	* Set the size of the avatar circle
+	*/
 	size: PropTypes.oneOf([
 		"xl",
 		"lg",
 		"md"
 	]).isRequired,
+	/**
+	* Set theme in which the component will be rendered
+	*/
 	theme: PropTypes.oneOf(["light", "dark"]).isRequired,
+	/**
+	* Specify how the trigger should align with the tooltip
+	*/
 	tooltipAlignment: PropTypes.oneOf([
 		"top",
 		"top-left",
@@ -150,8 +182,10 @@ UserProfileImage.propTypes = {
 		"left",
 		"right"
 	]),
+	/**
+	* Pass in the display name to have it shown on hover
+	*/
 	tooltipText: PropTypes.string
 };
-
 //#endregion
-export { UserProfileImage };
+export { UserProfileImage };

package/es/components/WebTerminal/WebTerminal.js

@@ -15,7 +15,6 @@ import React, { useEffect, useMemo, useRef, useState } from "react";
 import PropTypes from "prop-types";
 import { Button, OverflowMenu, OverflowMenuItem, Theme } from "@carbon/react";
 import { Close, Help } from "@carbon/react/icons";
-
 //#region src/components/WebTerminal/WebTerminal.tsx
 /**
 * Copyright IBM Corp. 2020, 2022
@@ -116,19 +115,44 @@ const WebTerminal = React.forwardRef(({ actions = defaults.actions, children, cl
 });
 WebTerminal.displayName = componentName;
 WebTerminal.propTypes = {
+	/**
+	* An array of actions to be displayed in the web terminal header bar
+	*/
+	/**@ts-ignore */
 	actions: PropTypes.arrayOf(PropTypes.shape({
 		renderIcon: PropTypes.func.isRequired,
 		onClick: PropTypes.func.isRequired,
 		iconDescription: PropTypes.string.isRequired
 	})),
+	/**
+	* Provide your own terminal component as children to show up in the web terminal
+	*/
 	children: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.node), PropTypes.node]).isRequired,
+	/**
+	* Custom classname for additional styling of the web terminal
+	*/
 	className: PropTypes.string,
+	/**
+	* Icon description for the close button
+	*/
 	closeIconDescription: PropTypes.string.isRequired,
+	/**
+	* Array of objects for each documentation link. Each documentation link uses the prop types of OverflowMenuItems. See more: https://react.carbondesignsystem.com/?path=/docs/components-overflowmenu--default
+	*/
+	/**@ts-ignore */
 	documentationLinks: PropTypes.arrayOf(PropTypes.shape({ ...OverflowMenuItem.propTypes })),
+	/**
+	* Description for the documentation link overflow menu tooltip
+	*/
 	documentationLinksIconDescription: PropTypes.string,
+	/**
+	* Optionally pass if the web terminal should be open by default
+	*/
 	isInitiallyOpen: PropTypes.bool,
+	/**
+	* Specifies aria label for Web terminal
+	*/
 	webTerminalAriaLabel: PropTypes.string
 };
-
 //#endregion
-export { WebTerminal };
+export { WebTerminal };

package/es/components/WebTerminal/WebTerminalContentWrapper.js

@@ -11,7 +11,6 @@ import { pkg } from "../../settings.js";
 import { useWebTerminal } from "./hooks/index.js";
 import React from "react";
 import PropTypes from "prop-types";
-
 //#region src/components/WebTerminal/WebTerminalContentWrapper.tsx
 /**
 * Copyright IBM Corp. 2022, 2022
@@ -31,7 +30,10 @@ const WebTerminalContentWrapper = React.forwardRef(({ children, ...rest }, ref)
 	}, children);
 });
 WebTerminalContentWrapper.displayName = componentName;
-WebTerminalContentWrapper.propTypes = { children: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.node), PropTypes.node]).isRequired };
-
+WebTerminalContentWrapper.propTypes = { 
+/**
+* Pass in content as children.
+*/
+children: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.node), PropTypes.node]).isRequired };
 //#endregion
-export { WebTerminalContentWrapper };
+export { WebTerminalContentWrapper };

package/es/components/WebTerminal/hooks/index.js

@@ -7,7 +7,6 @@
 
 import React, { createContext, useCallback, useContext, useState } from "react";
 import PropTypes from "prop-types";
-
 //#region src/components/WebTerminal/hooks/index.tsx
 const WebTerminalContext = createContext({});
 const WebTerminalProvider = ({ children }) => {
@@ -22,10 +21,13 @@ const WebTerminalProvider = ({ children }) => {
 		toggleWebTerminal
 	} }, children);
 };
-WebTerminalProvider.propTypes = { children: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.node), PropTypes.node]).isRequired };
+WebTerminalProvider.propTypes = { 
+/**
+* Provide your own terminal component as children to show up in the web terminal
+*/
+children: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.node), PropTypes.node]).isRequired };
 const useWebTerminal = () => {
 	return useContext(WebTerminalContext);
 };
-
 //#endregion
-export { WebTerminalProvider, useWebTerminal };
+export { WebTerminalProvider, useWebTerminal };

package/es/components/_Canary/Canary.js

@@ -11,7 +11,6 @@ import package_settings_default from "../../global/js/package-settings.js";
 import React from "react";
 import PropTypes from "prop-types";
 import { CodeSnippet } from "@carbon/react";
-
 //#region src/components/_Canary/Canary.jsx
 /**
 * Copyright IBM Corp. 2020, 2021
@@ -36,9 +35,10 @@ pkg.component.${componentName} = true;
 	}, /* @__PURE__ */ React.createElement("h2", null, "This component ", /* @__PURE__ */ React.createElement("strong", null, componentName), " is not ready yet."), /* @__PURE__ */ React.createElement("p", null, "To enable it, initialize package flags before the component is first used."), /* @__PURE__ */ React.createElement("br", null), /* @__PURE__ */ React.createElement("p", null, "e.g. in main.js"), /* @__PURE__ */ React.createElement(CodeSnippet, { type: "multi" }, instructions), /* @__PURE__ */ React.createElement("br", null), /* @__PURE__ */ React.createElement("p", null, "View a live example on", " ", /* @__PURE__ */ React.createElement("a", { href: "https://codesandbox.io/s/example-component-olif5?file=/src/config.js" }, "codesandbox"), "."));
 };
 Canary.propTypes = {
+	/** Provide an optional class to be applied to the containing node */
 	className: PropTypes.string,
+	/** Name of the component that is not ready yet */
 	componentName: PropTypes.string.isRequired
 };
-
 //#endregion
-export { Canary };
+export { Canary };

package/es/global/js/hooks/useActiveElement.js

@@ -6,7 +6,6 @@
  */
 
 import { useEffect, useState } from "react";
-
 //#region src/global/js/hooks/useActiveElement.js
 /**
 * Copyright IBM Corp. 2022, 2022
@@ -27,6 +26,5 @@ const useActiveElement = () => {
 	}, []);
 	return active;
 };
-
 //#endregion
-export { useActiveElement };
+export { useActiveElement };

package/es/global/js/hooks/useClickOutside.js

@@ -6,7 +6,6 @@
  */
 
 import { useEffect } from "react";
-
 //#region src/global/js/hooks/useClickOutside.js
 /**
 * Copyright IBM Corp. 2020, 2021
@@ -25,6 +24,5 @@ const useClickOutside = (ref, callback) => {
 		};
 	}, [callback, ref]);
 };
-
 //#endregion
-export { useClickOutside };
+export { useClickOutside };

package/es/global/js/hooks/useCollapsible.js

@@ -6,7 +6,6 @@
  */
 
 import { useEffect } from "react";
-
 //#region src/global/js/hooks/useCollapsible.ts
 /**
 * Copyright IBM Corp. 2025, 2025
@@ -62,6 +61,5 @@ function useCollapsible({ container, triggerCollapse, disableHeaderCollapse = fa
 		disableHeaderCollapse
 	]);
 }
-
 //#endregion
-export { useCollapsible };
+export { useCollapsible };

package/es/global/js/hooks/useControllableState.js

@@ -6,7 +6,6 @@
  */
 
 import { useCallback, useState } from "react";
-
 //#region src/global/js/hooks/useControllableState.ts
 /**
 * Copyright IBM Corp. 2025, 2025
@@ -29,6 +28,5 @@ function useControllableState(value, onChange) {
 	if (typeof onChange === "function") return [value, onControlledChange];
 	return [uncontrolledValue, setUncontrolledValue];
 }
-
 //#endregion
-export { useControllableState };
+export { useControllableState };

package/es/global/js/hooks/useCreateComponentFocus.js

@@ -7,7 +7,6 @@
 
 import wait from "../utils/wait.js";
 import { useEffect } from "react";
-
 //#region src/global/js/hooks/useCreateComponentFocus.js
 /**
 * Copyright IBM Corp. 2021, 2021
@@ -60,6 +59,5 @@ const useCreateComponentFocus = ({ previousState, currentStep, blockClass, onMou
 		firstFocusElement
 	]);
 };
-
 //#endregion
-export { useCreateComponentFocus };
+export { useCreateComponentFocus };

package/es/global/js/hooks/useCreateComponentStepChange.js

@@ -6,7 +6,6 @@
  */
 
 import { useCallback, useEffect } from "react";
-
 //#region src/global/js/hooks/useCreateComponentStepChange.js
 /**
 * Copyright IBM Corp. 2021, 2023
@@ -155,6 +154,5 @@ const useCreateComponentStepChange = ({ firstIncludedStep, lastIncludedStep, ste
 		experimentalSecondarySubmitText
 	]);
 };
-
 //#endregion
-export { useCreateComponentStepChange };
+export { useCreateComponentStepChange };

package/es/global/js/hooks/useFocus.js

@@ -8,7 +8,6 @@
 import { pkg } from "../../../settings.js";
 import { useCallback, useEffect } from "react";
 import { usePrefix } from "@carbon/react";
-
 //#region src/global/js/hooks/useFocus.js
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -74,6 +73,5 @@ const useFocus = (modalRef, selectorPrimaryFocus) => {
 		claimFocus
 	};
 };
-
 //#endregion
-export { getSpecificElement, useFocus };
+export { getSpecificElement, useFocus };

package/es/global/js/hooks/useIsomorphicEffect.js

@@ -6,7 +6,6 @@
  */
 
 import { useEffect, useLayoutEffect } from "react";
-
 //#region src/global/js/hooks/useIsomorphicEffect.ts
 /**
 * Copyright IBM Corp. 2024, 2025
@@ -15,6 +14,5 @@ import { useEffect, useLayoutEffect } from "react";
 * LICENSE file in the root directory of this source tree.
 */
 const useIsomorphicEffect = typeof window !== "undefined" ? useLayoutEffect : useEffect;
-
 //#endregion
-export { useIsomorphicEffect };
+export { useIsomorphicEffect };

package/es/global/js/hooks/useMatchMedia.js

@@ -6,7 +6,6 @@
  */
 
 import { useEffect, useState } from "react";
-
 //#region src/global/js/hooks/useMatchMedia.ts
 /**
 * Copyright IBM Corp. 2025, 2025
@@ -35,6 +34,5 @@ const useMatchMedia = (mediaQuery, defaultState = false) => {
 	}, [mediaQuery]);
 	return matches;
 };
-
 //#endregion
-export { useMatchMedia };
+export { useMatchMedia };

package/es/global/js/hooks/useMergedRefs.js

@@ -6,7 +6,6 @@
  */
 
 import { useCallback, useMemo } from "react";
-
 //#region src/global/js/hooks/useMergedRefs.js
 /**
 * Copyright IBM Corp. 2025
@@ -31,6 +30,5 @@ const useMergedRefs = (refs) => {
 		});
 	}, [memoizedRefs]);
 };
-
 //#endregion
-export { useMergedRefs };
+export { useMergedRefs };

package/es/global/js/hooks/useOverflowItems/useOverflowItems.js

@@ -7,7 +7,6 @@
 
 import { useResizeObserver } from "../useResizeObserver.js";
 import { useRef, useState } from "react";
-
 //#region src/global/js/hooks/useOverflowItems/useOverflowItems.ts
 /**
 * Copyright IBM Corp. 2025, 2025
@@ -93,6 +92,5 @@ function useOverflowItems(items = [], containerRef, offsetRef, maxItems, onChang
 		offsetRefHandler
 	};
 }
-
 //#endregion
-export { useOverflowItems };
+export { useOverflowItems };

package/es/global/js/hooks/useOverflowString.js

@@ -6,7 +6,6 @@
  */
 
 import { useCallback, useEffect, useState } from "react";
-
 //#region src/global/js/hooks/useOverflowString.ts
 /**
 * Copyright IBM Corp. 2025, 2025
@@ -31,6 +30,5 @@ function useOverflowStringWidth(elementRef) {
 	]);
 	return isOverflowing;
 }
-
 //#endregion
-export { useOverflowStringWidth };
+export { useOverflowStringWidth };

package/es/global/js/hooks/usePortalTarget.js

@@ -9,7 +9,6 @@ import { pkg } from "../../../settings.js";
 import { useFeatureFlag } from "../../../components/FeatureFlags/index.js";
 import { useCallback, useEffect, useState } from "react";
 import { createPortal } from "react-dom";
-
 //#region src/global/js/hooks/usePortalTarget.js
 /**
 * Copyright IBM Corp. 2023, 2024
@@ -26,6 +25,5 @@ const usePortalTarget = (portalTargetIn) => {
 	}, [portalTargetIn, enablePortalTarget]);
 	return useCallback((children) => portalTarget ? createPortal(children, portalTarget) : children, [portalTarget]);
 };
-
 //#endregion
-export { usePortalTarget };
+export { usePortalTarget };

package/es/global/js/hooks/usePrefersReducedMotion.js

@@ -7,7 +7,6 @@
 
 import { useIsomorphicEffect } from "./useIsomorphicEffect.js";
 import { useState } from "react";
-
 //#region src/global/js/hooks/usePrefersReducedMotion.js
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -31,6 +30,5 @@ const usePrefersReducedMotion = () => {
 	}, []);
 	return prefersReducedMotion;
 };
-
 //#endregion
-export { usePrefersReducedMotion };
+export { usePrefersReducedMotion };

package/es/global/js/hooks/usePrefix.js

@@ -6,7 +6,6 @@
  */
 
 import package_settings_default from "../package-settings.js";
-
 //#region src/global/js/hooks/usePrefix.js
 /**
 * Copyright IBM Corp. 2023, 2023
@@ -15,6 +14,5 @@ import package_settings_default from "../package-settings.js";
 * LICENSE file in the root directory of this source tree.
 */
 const usePrefix = () => package_settings_default.prefix;
-
 //#endregion
-export { usePrefix };
+export { usePrefix };

package/es/global/js/hooks/usePresence.js

@@ -6,7 +6,6 @@
  */
 
 import { useEffect, useState } from "react";
-
 //#region src/global/js/hooks/usePresence.ts
 /**
 * Copyright IBM Corp. 2025, 2025
@@ -57,6 +56,5 @@ function usePresence(open, ref, animationName) {
 	]);
 	return { shouldRender };
 }
-
 //#endregion
-export { usePresence };
+export { usePresence };

package/es/global/js/hooks/usePreviousValue.js

@@ -6,7 +6,6 @@
  */
 
 import { useEffect, useRef } from "react";
-
 //#region src/global/js/hooks/usePreviousValue.js
 /**
 * Copyright IBM Corp. 2021, 2021
@@ -26,6 +25,5 @@ const usePreviousValue = (value) => {
 	});
 	return ref.current;
 };
-
 //#endregion
-export { usePreviousValue };
+export { usePreviousValue };

package/es/global/js/hooks/useResetCreateComponent.js

@@ -7,7 +7,6 @@
 
 import { getNumberOfHiddenSteps } from "../utils/getNumberOfHiddenSteps.js";
 import { useEffect } from "react";
-
 //#region src/global/js/hooks/useResetCreateComponent.js
 /**
 * Copyright IBM Corp. 2021, 2022
@@ -47,6 +46,5 @@ const useResetCreateComponent = ({ firstIncludedStep, previousState, open, setCu
 		componentName
 	]);
 };
-
 //#endregion
-export { useResetCreateComponent };
+export { useResetCreateComponent };

package/es/global/js/hooks/useResizeObserver.js

@@ -7,7 +7,6 @@
 
 import { useIsomorphicEffect } from "./useIsomorphicEffect.js";
 import { useEffect, useRef, useState } from "react";
-
 //#region src/global/js/hooks/useResizeObserver.ts
 /**
 * Copyright IBM Corp. 2023, 2025
@@ -61,6 +60,5 @@ const useResizeObserver = (ref, onResize) => {
 		height
 	};
 };
-
 //#endregion
-export { useResizeObserver };
+export { useResizeObserver };

package/es/global/js/hooks/useRetrieveFormTitles.js

@@ -6,7 +6,6 @@
  */
 
 import { useEffect } from "react";
-
 //#region src/global/js/hooks/useRetrieveFormTitles.js
 /**
 * Copyright IBM Corp. 2024
@@ -30,6 +29,5 @@ const useRetrieveFormTitles = ({ formContext, formNumber, title }) => {
 		formNumber
 	]);
 };
-
 //#endregion
-export { useRetrieveFormTitles };
+export { useRetrieveFormTitles };

package/es/global/js/hooks/useRetrieveStepData.js

@@ -6,7 +6,6 @@
  */
 
 import { useEffect } from "react";
-
 //#region src/global/js/hooks/useRetrieveStepData.js
 /**
 * Copyright IBM Corp. 2022, 2023
@@ -54,6 +53,5 @@ const useRetrieveStepData = ({ stepsContext, stepNumber, introStep, invalid, sho
 		stepNumber
 	]);
 };
-
 //#endregion
-export { useRetrieveStepData };
+export { useRetrieveStepData };

package/es/global/js/hooks/useValidCreateStepCount.js

@@ -6,7 +6,6 @@
  */
 
 import { useEffect } from "react";
-
 //#region src/global/js/hooks/useValidCreateStepCount.js
 /**
 * Copyright IBM Corp. 2021, 2021
@@ -24,6 +23,5 @@ const useValidCreateStepCount = (stepCount, componentName) => {
 		if (stepCount === 1) console.warn(`${componentName}: ${componentName}s with one step are not permitted. If you require only one step, please use either the CreateTearsheetNarrow, CreateSidePanel, or CreateModal components.`);
 	}, [stepCount, componentName]);
 };
-
 //#endregion
-export { useValidCreateStepCount };
+export { useValidCreateStepCount };

package/es/global/js/hooks/useWindowResize.js

@@ -7,7 +7,6 @@
 
 import { useIsomorphicEffect } from "./useIsomorphicEffect.js";
 import { useRef } from "react";
-
 //#region src/global/js/hooks/useWindowResize.js
 /**
 * Copyright IBM Corp. 2022, 2023
@@ -54,6 +53,5 @@ const useWindowResize = (effect, deps, throttleInterval = 0) => {
 		return () => window.removeEventListener("resize", handleResize);
 	}, deps);
 };
-
 //#endregion
-export { useWindowResize };
+export { useWindowResize };

package/es/global/js/hooks/useWindowScroll.js

@@ -8,7 +8,6 @@
 import { useIsomorphicEffect } from "./useIsomorphicEffect.js";
 import { scrollableAncestor } from "../utils/scrollableAncestor.js";
 import { useRef } from "react";
-
 //#region src/global/js/hooks/useWindowScroll.js
 /**
 * Copyright IBM Corp. 2022, 2023
@@ -65,6 +64,5 @@ function useNearestScroll(ref, effect, deps, throttle = 0) {
 	if (scrollableTarget && (document.body === scrollableTarget || scrollableTarget.contains(document.body))) scrollableTarget = window;
 	return useTargetScroll(scrollableTarget, effect, deps, throttle);
 }
-
 //#endregion
-export { useNearestScroll };
+export { useNearestScroll };

package/es/global/js/package-settings.js

@@ -199,6 +199,5 @@ var package_settings_default = {
 		silent = value;
 	}
 };
-
 //#endregion
-export { package_settings_default as default, devtoolsAttribute, getDevtoolsId };
+export { package_settings_default as default, devtoolsAttribute, getDevtoolsId };

package/es/global/js/utils/Wrap.js

@@ -7,7 +7,6 @@
 
 import React from "react";
 import PropTypes from "prop-types";
-
 //#region src/global/js/utils/Wrap.tsx
 /**
 * Copyright IBM Corp. 2021, 2024
@@ -40,13 +39,36 @@ const Wrap = React.forwardRef(({ alwaysRender, children, element: Wrapper = "div
 }, children));
 Wrap.displayName = "Wrap";
 Wrap.propTypes = {
+	/**
+	* Specify whether the wrapper element should render even if there are no
+	* children or the children are themselves empty wrappers. Useful if there
+	* are some conditions in which the wrapper element is still required. Note
+	* that this prop takes precedence over neverRender if both are set to true.
+	*/
 	alwaysRender: PropTypes.bool,
+	/**
+	* The content of the wrapper element. If no children are supplied, or the
+	* resulting value(s) are falsy, or if all the non-falsy children are Wrap
+	* components that decide not to render, nothing will be rendered in the DOM.
+	*/
 	children: PropTypes.node,
 	className: PropTypes.string,
+	/**
+	* The element name or component to use as a wrapper for the content.
+	*/
 	element: PropTypes.elementType,
+	/**
+	* Specify whether nothing should be rendered even if there are children
+	* in the content. Useful if there are some circumstances in which the
+	* component should not render at all. Note that if alwaysRender is also
+	* set to true then it will take precedence and the wrapper element and
+	* content will be rendered.
+	*/
 	neverRender: PropTypes.bool,
+	/**
+	* The title attribute the content.
+	*/
 	title: PropTypes.string
 };
-
 //#endregion
-export { Wrap };
+export { Wrap };

package/es/global/js/utils/checkForOverflow.js

@@ -10,6 +10,5 @@ const checkHeightOverflow = (el) => {
 	if (el) return el?.offsetHeight < el?.scrollHeight;
 	return false;
 };
-
 //#endregion
-export { checkHeightOverflow };
+export { checkHeightOverflow };