@carbon/ibm-products 2.89.0 → 2.90.0

package/lib/components/PageHeader/next/overflowHandler.js

@@ -5,7 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-
 //#region src/components/PageHeader/next/overflowHandler.ts
 /**
 * Copyright IBM Corp. 2025
@@ -118,6 +117,5 @@ function createOverflowHandler({ container, maxVisibleItems, onChange, dimension
 		resizeObserver.disconnect();
 	} };
 }
-
 //#endregion
-exports.createOverflowHandler = createOverflowHandler;
+exports.createOverflowHandler = createOverflowHandler;

package/lib/components/PageHeader/next/utils.js

@@ -5,7 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-
 //#region src/components/PageHeader/next/utils.ts
 /**
 * Copyright IBM Corp. 2025
@@ -61,7 +60,6 @@ const scrollableAncestor = (target) => {
 	if (!target || !style || style.position === "fixed") return document.scrollingElement;
 	return scrollableAncestorInner(target);
 };
-
 //#endregion
 exports.getHeaderOffset = getHeaderOffset;
-exports.scrollableAncestor = scrollableAncestor;
+exports.scrollableAncestor = scrollableAncestor;

package/lib/components/ProductiveCard/ProductiveCard.js

@@ -5,15 +5,14 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
-const require_props_helper = require('../../global/js/utils/props-helper.js');
-const require_Card = require('../Card/Card.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
+const require_props_helper = require("../../global/js/utils/props-helper.js");
+const require_Card = require("../Card/Card.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
-
 //#region src/components/ProductiveCard/ProductiveCard.tsx
 const componentName = "ProductiveCard";
 const ProductiveCard = (0, react.forwardRef)(({ actionsPlacement = "top", children, ...rest }, ref) => {
@@ -34,63 +33,154 @@ const ProductiveCard = (0, react.forwardRef)(({ actionsPlacement = "top", childr
 	}, children);
 });
 ProductiveCard.propTypes = {
+	/**
+	* Icons that are displayed on the card. Refer to design documentation for implementation guidelines. Note: href is deprecated. Set link.href for href functionality. If you are setting link object, href is a required property. link object supports all anchor element properties. Precedence: link.href > href. If link.href or href is set => anchor element, else button.
+	*/
+	/**@ts-ignore */
 	actionIcons: prop_types.default.arrayOf(prop_types.default.shape({
 		id: prop_types.default.string,
 		icon: prop_types.default.oneOfType([prop_types.default.func, prop_types.default.object]),
 		onKeyDown: prop_types.default.func,
 		onClick: prop_types.default.func,
 		iconDescription: prop_types.default.string,
+		/**
+		* @deprecated please use the `link.href` instead
+		*/
 		href: prop_types.default.string,
 		link: prop_types.default.shape({ href: prop_types.default.string.isRequired })
 	})),
+	/**
+	* Determines if the action icons are on the top or bottom of the card
+	*/
 	actionsPlacement: prop_types.default.oneOf(["top", "bottom"]),
+	/**
+	* Content that shows in the body of the card
+	*/
 	children: prop_types.default.node,
+	/**
+	* Optional user provided class
+	*/
 	className: prop_types.default.string,
+	/**
+	* Designates which zones of the card are clickable. Refer to design documentation for implementation guidelines
+	*/
 	clickZone: prop_types.default.oneOf([
 		"one",
 		"two",
 		"three"
 	]),
+	/**
+	* Optional prop that allows you to pass any component.
+	*/
 	decorator: prop_types.default.oneOfType([prop_types.default.node, prop_types.default.bool]),
+	/**
+	* Optional header description
+	*/
 	description: prop_types.default.oneOfType([
 		prop_types.default.string,
 		prop_types.default.object,
 		prop_types.default.node
 	]),
+	/**
+	* Sets the text for the OverflowMenu trigger button tooltip and OverflowMenu aria label,
+	* gets overridden by the `overflowAriaLabel` prop.
+	*
+	* @deprecated Please use the `overflowAriaLabel` prop instead.
+	*/
 	iconDescription: prop_types.default.string,
+	/**
+	* Optional label for the top of the card
+	*/
 	label: prop_types.default.oneOfType([
 		prop_types.default.string,
 		prop_types.default.object,
 		prop_types.default.node
 	]),
+	/**
+	* Provides the callback for a clickable card
+	*/
 	onClick: prop_types.default.func,
+	/**
+	* Function that's called from the primary button or action icon
+	*/
 	onPrimaryButtonClick: prop_types.default.func,
+	/**
+	* Function that's called from the secondary button or action icon
+	*/
 	onSecondaryButtonClick: prop_types.default.func,
+	/**
+	* Use an overflow menu instead of action icons. Refer to design documentation for implementation guidelines
+	*/
+	/**@ts-ignore */
 	overflowActions: prop_types.default.arrayOf(prop_types.default.shape({
 		id: prop_types.default.string,
 		itemText: prop_types.default.string,
 		onClick: prop_types.default.func,
 		onKeyDown: prop_types.default.func
 	})),
+	/**
+	* Sets the text for the OverflowMenu aria label and the OverflowMenu trigger button tooltip.
+	* Overrides `iconDescription` prop.
+	*/
 	overflowAriaLabel: prop_types.default.string,
+	/**
+	* Determines if the primary button is enabled or not
+	*/
 	primaryButtonDisabled: prop_types.default.bool,
+	/**
+	* Optionally specify an href for your Button to become an <a> element
+	*/
 	primaryButtonHref: prop_types.default.string,
+	/**
+	* Optional prop to allow overriding the icon rendering. Can be a React component class
+	*/
+	/**@ts-ignore */
 	primaryButtonIcon: prop_types.default.oneOfType([prop_types.default.func, prop_types.default.object]),
+	/**
+	* Determines if the primary button is on the top or bottom of the card
+	*/
 	primaryButtonPlacement: prop_types.default.oneOf(["top", "bottom"]),
+	/**
+	* The text that's displayed in the primary button
+	*/
+	/**@ts-ignore */
 	primaryButtonText: prop_types.default.node,
+	/**
+	* Optionally specify an href for your Button to become an <a> element
+	*/
 	secondaryButtonHref: prop_types.default.string,
+	/**
+	* Optional prop to allow overriding the icon rendering. Can be a React component class
+	*/
+	/**@ts-ignore */
 	secondaryButtonIcon: prop_types.default.oneOfType([prop_types.default.func, prop_types.default.object]),
+	/**
+	* Determines if the secondary button is on the top or bottom of the card
+	*/
 	secondaryButtonPlacement: prop_types.default.oneOf(["top", "bottom"]),
+	/**
+	* The text that's displayed in the secondary button
+	*/
+	/**@ts-ignore */
 	secondaryButtonText: prop_types.default.node,
+	/**
+	* **Experimental:** For all cases a `Slug` component can be provided.
+	* Clickable tiles only accept a boolean value of true and display a hollow slug.
+	*/
 	slug: prop_types.default.oneOfType([prop_types.default.node, prop_types.default.bool]),
+	/**
+	* Title that's displayed at the top of the card
+	*/
 	title: prop_types.default.oneOfType([
 		prop_types.default.string,
 		prop_types.default.object,
 		prop_types.default.node
 	]),
+	/**
+	* Determines title size
+	*/
 	titleSize: prop_types.default.oneOf(["default", "large"])
 };
 ProductiveCard.displayName = componentName;
-
 //#endregion
-exports.ProductiveCard = ProductiveCard;
+exports.ProductiveCard = ProductiveCard;

package/lib/components/RemoveModal/RemoveModal.js

@@ -5,19 +5,18 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_index = require('../../node_modules/classnames/index.js');
-const require_settings = require('../../settings.js');
-const require_usePreviousValue = require('../../global/js/hooks/usePreviousValue.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
-const require_usePortalTarget = require('../../global/js/hooks/usePortalTarget.js');
-const require_uuidv4 = require('../../global/js/utils/uuidv4.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_settings = require("../../settings.js");
+const require_usePreviousValue = require("../../global/js/hooks/usePreviousValue.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
+const require_usePortalTarget = require("../../global/js/hooks/usePortalTarget.js");
+const require_uuidv4 = require("../../global/js/utils/uuidv4.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let _carbon_react = require("@carbon/react");
-
 //#region src/components/RemoveModal/RemoveModal.tsx
 var import_classnames = /* @__PURE__ */ require_runtime.__toESM(require_index.default);
 const componentName = "RemoveModal";
@@ -76,27 +75,83 @@ const RemoveModal = (0, react.forwardRef)(({ body, className, iconDescription, i
 	}, primaryButtonText))));
 });
 RemoveModal.propTypes = {
+	/**
+	* The content to be displayed in the body of the modal
+	*/
 	body: prop_types.default.node.isRequired,
+	/**
+	* Optional classname
+	*/
 	className: prop_types.default.string,
+	/**
+	* Provide a description for "close" icon that can be read by screen readers
+	*/
 	iconDescription: prop_types.default.string.isRequired,
+	/**
+	* Message showed when user input fails validation
+	*/
 	inputInvalidText: prop_types.default.string,
+	/**
+	* Label for text box
+	*/
 	inputLabelText: prop_types.default.node,
+	/**
+	* Placeholder for text box
+	*/
 	inputPlaceholderText: prop_types.default.string,
+	/**
+	* Specify the modal label texts
+	*/
 	label: prop_types.default.string,
+	/**
+	* Callback function that runs when user closes the modal
+	*/
 	onClose: prop_types.default.func,
+	/**
+	* Callback function that runs when user submits the modal
+	*/
 	onRequestSubmit: prop_types.default.func,
+	/**
+	* Specify whether the Modal is currently open
+	*/
 	open: prop_types.default.bool.isRequired,
+	/**
+	* The DOM node the tearsheet should be rendered within. Defaults to document.body.
+	*/
 	portalTarget: prop_types.default.node,
+	/**
+	* Prevent closing on click outside of modal
+	*/
 	preventCloseOnClickOutside: prop_types.default.bool,
+	/**
+	* Specify whether the primary button should be disabled. This value will override textConfirmation
+	*/
 	primaryButtonDisabled: prop_types.default.bool,
+	/**
+	* Specify the text for the primary button
+	*/
 	primaryButtonText: prop_types.default.string,
+	/**
+	* Specify the danger description on the primary button
+	*/
 	primaryDangerDescription: prop_types.default.string,
+	/**
+	* The name of the resource being acted upon
+	*/
 	resourceName: prop_types.default.string.isRequired,
+	/**
+	* Specify the text for the secondary button
+	*/
 	secondaryButtonText: prop_types.default.string,
+	/**
+	* Specify whether or not to show the text confirmation input
+	*/
 	textConfirmation: prop_types.default.bool,
+	/**
+	* The text displayed at the top of the modal
+	*/
 	title: prop_types.default.string.isRequired
 };
 RemoveModal.displayName = componentName;
-
 //#endregion
-exports.RemoveModal = RemoveModal;
+exports.RemoveModal = RemoveModal;

package/lib/components/Saving/Saving.js

@@ -5,17 +5,16 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_index = require('../../node_modules/classnames/index.js');
-const require_settings = require('../../settings.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_settings = require("../../settings.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let _carbon_react = require("@carbon/react");
 let _carbon_react_icons = require("@carbon/react/icons");
-
 //#region src/components/Saving/Saving.tsx
 /**
 * Copyright IBM Corp. 2021, 2024
@@ -81,27 +80,68 @@ const Saving = (0, react.forwardRef)(({ secondaryButtonText, className, defaultI
 	}, statusObj[status]?.text)));
 });
 Saving.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/**
+	* Description for default state icon (manual).
+	*/
 	defaultIconDescription: prop_types.default.string,
+	/**
+	* Default text for the save button (manual). Per design guidelines you probably don't want to display this in the auto mode.
+	*/
 	defaultText: prop_types.default.string,
+	/**
+	* Description for fail state icon (manual).
+	*/
 	failIconDescription: prop_types.default.string,
+	/**
+	* Text for failure state.
+	*/
 	failText: prop_types.default.string,
+	/**
+	* Description for in progress state icon (manual).
+	*/
 	inProgressIconDescription: prop_types.default.string,
+	/**
+	* Text for in progress state.
+	*/
 	inProgressText: prop_types.default.string,
+	/**
+	* Function handler for cancel button (manual).
+	*/
 	onRequestCancel: prop_types.default.func,
+	/**
+	* Function handler for save button (manual).
+	*/
 	onRequestSave: prop_types.default.func,
+	/**
+	* Text for the secondary or cancel button (manual).
+	*/
 	secondaryButtonText: prop_types.default.string,
+	/**
+	* The status of the save. default being the untouched default state -> in-progress being a save has been initiated -> fail or success being the outcome.
+	*/
 	status: prop_types.default.oneOf([
 		"default",
 		"in-progress",
 		"success",
 		"fail"
 	]).isRequired,
+	/**
+	* Description for success state icon (manual).
+	*/
 	successIconDescription: prop_types.default.string,
+	/**
+	* Text for success state
+	*/
 	successText: prop_types.default.string,
+	/**
+	* Designates the style of the save component. Manual uses a set of buttons and auto just displays a string. See usage guidelines for additional information.
+	*/
 	type: prop_types.default.oneOf(["manual", "auto"]).isRequired
 };
 Saving.displayName = componentName;
-
 //#endregion
-exports.Saving = Saving;
+exports.Saving = Saving;

package/lib/components/ScrollGradient/ScrollGradient.js

@@ -5,18 +5,17 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_index = require('../../node_modules/classnames/index.js');
-const require_settings = require('../../settings.js');
-const require_useIsomorphicEffect = require('../../global/js/hooks/useIsomorphicEffect.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
-const require_constants = require('./constants.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_settings = require("../../settings.js");
+const require_useIsomorphicEffect = require("../../global/js/hooks/useIsomorphicEffect.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
+const require_constants = require("./constants.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let _carbon_react = require("@carbon/react");
-
 //#region src/components/ScrollGradient/ScrollGradient.jsx
 /**
 * Copyright IBM Corp. 2024, 2025
@@ -164,19 +163,29 @@ let ScrollGradient = react.default.forwardRef(({ children, className, color, onS
 ScrollGradient = require_settings.pkg.checkComponentEnabled(ScrollGradient, componentName);
 ScrollGradient.displayName = componentName;
 ScrollGradient.propTypes = {
+	/**
+	* Provide the contents of the ScrollGradient.
+	*/
 	children: prop_types.default.oneOfType([prop_types.default.arrayOf(prop_types.default.node), prop_types.default.node]),
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/** @type {string} Fade out color. Any valid CSS color value works */
 	color: prop_types.default.string,
+	/** @type {(element: HTMLElement) => {}} Optional function to get reference to scrollable DOM element */
 	getScrollElementRef: prop_types.default.func,
+	/** @type {boolean} Set to true if you want to hide gradient on the start side (top or left) of scrollable element. */
 	hideStartGradient: prop_types.default.bool,
+	/** @type {Function} Optional scroll handler */
 	onScroll: prop_types.default.func,
+	/** @type {string} Optional classname for scroll element. */
 	scrollElementClassName: prop_types.default.string
 };
-
 //#endregion
-Object.defineProperty(exports, 'ScrollGradient', {
-  enumerable: true,
-  get: function () {
-    return ScrollGradient;
-  }
-});
+Object.defineProperty(exports, "ScrollGradient", {
+	enumerable: true,
+	get: function() {
+		return ScrollGradient;
+	}
+});

package/lib/components/ScrollGradient/constants.js

@@ -5,10 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_useIsomorphicEffect = require('../../global/js/hooks/useIsomorphicEffect.js');
+require("../../_virtual/_rolldown/runtime.js");
+const require_useIsomorphicEffect = require("../../global/js/hooks/useIsomorphicEffect.js");
 let react = require("react");
-
 //#region src/components/ScrollGradient/constants.js
 /**
 * Copyright IBM Corp. 2024
@@ -61,7 +60,6 @@ const useIsOverflow = (ref) => {
 		yScrollable: isVerticallyScrollable
 	};
 };
-
 //#endregion
 exports.ScrollStates = ScrollStates;
-exports.useIsOverflow = useIsOverflow;
+exports.useIsOverflow = useIsOverflow;

package/lib/components/SearchBar/SearchBar.js

@@ -5,16 +5,15 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_index = require('../../node_modules/classnames/index.js');
-const require_settings = require('../../settings.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_settings = require("../../settings.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let _carbon_react = require("@carbon/react");
-
 //#region src/components/SearchBar/SearchBar.tsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -115,25 +114,53 @@ const conditionalScopePropValidator = (props, propName, componentName, ...rest)
 	/**@ts-ignore */
 	return prop_types.default.string(props, propName, componentName, ...rest);
 };
-const deprecatedProps = { titleText: prop_types.default.string };
+const deprecatedProps = { 
+/**
+* **Deprecated**
+*
+* Provide accessible label text for the scopes MultiSelect.
+*/
+titleText: prop_types.default.string };
 SearchBar.propTypes = {
+	/** @type {string} Optional additional class name. */
 	className: prop_types.default.string,
+	/** @type {string} The label text for the search text input. */
 	clearButtonLabelText: prop_types.default.string.isRequired,
+	/**
+	* Whether or not the scopes MultiSelect label is visually hidden.
+	*/
 	hideScopesLabel: prop_types.default.bool,
+	/** @type {string} The label text for the search text input. */
 	labelText: prop_types.default.string.isRequired,
+	/** @type {Function} Function handler for when the user changes their query search. */
 	onChange: prop_types.default.func,
+	/** @type {Function} Function handler for when the user submits a search. */
 	onSubmit: prop_types.default.func,
+	/** @type {string} Placeholder text to be displayed in the search input. */
 	placeholderText: prop_types.default.string.isRequired,
+	/** @type {Function} Function to get the text for each scope to display in dropdown. */
 	scopeToString: prop_types.default.func,
+	/** @type {Array<any>} Array of allowed search scopes. */
+	/**@ts-ignore */
 	scopes: prop_types.default.arrayOf(prop_types.default.oneOfType([prop_types.default.string, prop_types.default.object])),
+	/** @type {string} The name text for the search scope type. */
 	scopesTypeLabel: conditionalScopePropValidator,
+	/** @type {Array<any> Array of initially selected search scopes. */
+	/**@ts-ignore */
 	selectedScopes: prop_types.default.arrayOf(prop_types.default.oneOfType([prop_types.default.string, prop_types.default.object])),
+	/**
+	* Optional custom sorting algorithm for an array of scope items.
+	* By default, scope items are sorted in ascending alphabetical order,
+	* with "selected" items moved to the start of the scope items array.
+	*/
 	sortItems: prop_types.default.func,
+	/** @type {string} The label text for the search submit button. */
 	submitLabel: prop_types.default.string.isRequired,
+	/** @type {func} Callback function for translating MultiSelect's child ListBoxMenuIcon SVG title. */
 	translateWithId: prop_types.default.func,
+	/** @type {string} Search query value. */
 	value: prop_types.default.string,
 	...deprecatedProps
 };
-
 //#endregion
-exports.SearchBar = SearchBar;
+exports.SearchBar = SearchBar;