@carbon/ibm-products 2.89.0 → 2.90.0

package/lib/components/InlineTip/InlineTipLink.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/InlineTip/InlineTipLink.tsx
 /**
 * Copyright IBM Corp. 2023, 2023
@@ -40,9 +39,14 @@ const InlineTipLink = react.default.forwardRef(({ children, className, ...rest }
 });
 InlineTipLink.displayName = componentName;
 InlineTipLink.propTypes = {
+	/**
+	* Provide the contents of the InlineTipLink.
+	*/
 	children: prop_types.default.node.isRequired,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string
 };
-
 //#endregion
-exports.InlineTipLink = InlineTipLink;
+exports.InlineTipLink = InlineTipLink;

package/lib/components/InlineTip/utils.js

@@ -5,7 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-
 //#region src/components/InlineTip/utils.js
 /**
 * Copyright IBM Corp. 2023, 2023
@@ -28,6 +27,5 @@ const getComponentText = (reactNode) => {
 	if (typeof tmpChildren === "object") return getComponentText(reactNode.props.children);
 	if (typeof tmpChildren === "string") return reactNode.props.children;
 };
-
 //#endregion
-exports.getComponentText = getComponentText;
+exports.getComponentText = getComponentText;

package/lib/components/InterstitialScreen/InterstitialScreen.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_devtools = require('../../global/js/utils/devtools.js');
-const require_context = require('./context.js');
-const require_InterstitialScreenHeader = require('./InterstitialScreenHeader.js');
-const require_InterstitialScreenBody = require('./InterstitialScreenBody.js');
-const require_InterstitialScreenFooter = require('./InterstitialScreenFooter.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
+const require_context = require("./context.js");
+const require_InterstitialScreenHeader = require("./InterstitialScreenHeader.js");
+const require_InterstitialScreenBody = require("./InterstitialScreenBody.js");
+const require_InterstitialScreenFooter = require("./InterstitialScreenFooter.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/InterstitialScreen/InterstitialScreen.tsx
 /**
 * Copyright IBM Corp. 2024, 2025
@@ -139,15 +138,36 @@ InterstitialScreen.Body = require_InterstitialScreenBody.default;
 InterstitialScreen.Footer = require_InterstitialScreenFooter.default;
 InterstitialScreen.displayName = componentName;
 InterstitialScreen.propTypes = {
+	/**
+	* The aria label applied to the Interstitial Screen component
+	*/
 	ariaLabel: prop_types.default.string,
 	children: prop_types.default.node,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/**
+	* Tooltip text and aria label for the Close button icon.
+	*/
 	closeIconDescription: prop_types.default.string,
+	/**
+	* Specifies whether the component is shown as a full-screen
+	* experience, else it is shown as a modal by default.
+	*/
 	isFullScreen: prop_types.default.bool,
+	/**
+	* Provide a ref to return focus to once the interstitial is closed.
+	*/
 	launcherButtonRef: prop_types.default.any,
+	/**
+	* Function to call when the close button is clicked.
+	*/
 	onClose: prop_types.default.func,
+	/**
+	* Specifies whether the component is currently open.
+	*/
 	open: prop_types.default.bool
 };
-
 //#endregion
-exports.InterstitialScreen = InterstitialScreen;
+exports.InterstitialScreen = InterstitialScreen;

package/lib/components/InterstitialScreen/InterstitialScreenBody.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_devtools = require('../../global/js/utils/devtools.js');
-const require_context = require('./context.js');
-const require_Carousel = require('../Carousel/Carousel.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
+const require_context = require("./context.js");
+const require_Carousel = require("../Carousel/Carousel.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/InterstitialScreen/InterstitialScreenBody.tsx
 /**
 * Copyright IBM Corp. 2024, 2025
@@ -81,10 +80,21 @@ const InterstitialScreenBody = react.default.forwardRef((props, ref) => {
 	}, renderBody());
 });
 InterstitialScreenBody.propTypes = {
+	/**
+	* Optional static content for body
+	*/
 	children: prop_types.default.node,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/**
+	*You can provide content either through a callback (contentRenderer) or as static children—but not both.
+	* If both are provided, contentRenderer always takes precedence. This optional callback should return the content
+	* to be rendered in the body section, which can be either a single element or an array of elements based on your needs.
+	* If internal state access isn’t required, you can simply use static children instead
+	*/
 	contentRenderer: prop_types.default.func
 };
-
 //#endregion
-exports.default = InterstitialScreenBody;
+exports.default = InterstitialScreenBody;

package/lib/components/InterstitialScreen/InterstitialScreenFooter.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_devtools = require('../../global/js/utils/devtools.js');
-const require_clamp = require('../../global/js/utils/clamp.js');
-const require_context = require('./context.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
+const require_clamp = require("../../global/js/utils/clamp.js");
+const require_context = require("./context.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/InterstitialScreen/InterstitialScreenFooter.tsx
 /**
 * Copyright IBM Corp. 2024, 2025
@@ -114,14 +113,36 @@ const InterstitialScreenFooter = react.default.forwardRef((props, ref) => {
 	}, footerContent);
 });
 InterstitialScreenFooter.propTypes = {
+	/**
+	* This is an optional callback prop that allows to render your custom footer action buttons.
+	*/
 	actionButtonRenderer: prop_types.default.func,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/**
+	* The label for the Next button.
+	*/
 	nextButtonLabel: prop_types.default.string,
+	/**
+	* optional asynchronous callback on action button click (skip, previous, next and start)
+	* note: this is applicable when not using custom actionButtonRenderer
+	*/
 	onAction: prop_types.default.func,
+	/**
+	* The label for the Previous button.
+	*
+	*/
 	previousButtonLabel: prop_types.default.string,
+	/**
+	* The label for the skip button.
+	*/
 	skipButtonLabel: prop_types.default.string,
+	/**
+	* The label for the start button.
+	*/
 	startButtonLabel: prop_types.default.string
 };
-
 //#endregion
-exports.default = InterstitialScreenFooter;
+exports.default = InterstitialScreenFooter;

package/lib/components/InterstitialScreen/InterstitialScreenHeader.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_devtools = require('../../global/js/utils/devtools.js');
-const require_context = require('./context.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
+const require_context = require("./context.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/InterstitialScreen/InterstitialScreenHeader.tsx
 /**
 * Copyright IBM Corp. 2024, 2025
@@ -66,13 +65,31 @@ const InterstitialScreenHeader = react.default.forwardRef((props, ref) => {
 	}, headerContent());
 });
 InterstitialScreenHeader.propTypes = {
+	/**
+	* Provide the optional content for header section and will be render after header titles and before progress indicator.
+	* People can make use of this if they want to have custom header.
+	*/
 	children: prop_types.default.node,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/**
+	* Tooltip text and aria label for the Close button icon.
+	*/
 	closeIconDescription: prop_types.default.string,
+	/**
+	* Provide an optional sub title to be applied to the header >.
+	*/
 	headerSubTitle: prop_types.default.string,
+	/**
+	* Provide an optional title to be applied to the header >.
+	*/
 	headerTitle: prop_types.default.string,
+	/**
+	* Optional parameter to hide the progress indicator when multiple steps are used.
+	*/
 	hideProgressIndicator: prop_types.default.bool
 };
-
 //#endregion
-exports.default = InterstitialScreenHeader;
+exports.default = InterstitialScreenHeader;

package/lib/components/InterstitialScreen/InterstitialScreenView.js

@@ -5,13 +5,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_settings = require('../../settings.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_settings = require("../../settings.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/InterstitialScreen/InterstitialScreenView.tsx
 /**
 * Copyright IBM Corp. 2023, 2025
@@ -33,11 +32,22 @@ const InterstitialScreenView = react.default.forwardRef(({ children, className,
 });
 InterstitialScreenView.displayName = componentName;
 InterstitialScreenView.propTypes = {
+	/**
+	* Provide the contents of the InterstitialScreenView.
+	*/
 	children: prop_types.default.node,
+	/**
+	* Optional class name for this component.
+	*/
 	className: prop_types.default.string,
+	/**
+	* The label to pass to the ProgressStep component.
+	*/
 	stepTitle: prop_types.default.string.isRequired,
+	/**
+	* Optional method that takes in a message id and returns an internationalized string.
+	*/
 	translateWithId: prop_types.default.func
 };
-
 //#endregion
-exports.InterstitialScreenView = InterstitialScreenView;
+exports.InterstitialScreenView = InterstitialScreenView;

package/lib/components/InterstitialScreen/context.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_settings = require('../../settings.js');
+require("../../_virtual/_rolldown/runtime.js");
+const require_settings = require("../../settings.js");
 let react = require("react");
-
 //#region src/components/InterstitialScreen/context.ts
 /**
 * Copyright IBM Corp. 2025, 2025
@@ -21,7 +20,6 @@ const InterstitialScreenContext = (0, react.createContext)({
 	progStep: 0,
 	stepCount: 0
 });
-
 //#endregion
 exports.InterstitialScreenContext = InterstitialScreenContext;
-exports.blockClass = blockClass;
+exports.blockClass = blockClass;

package/lib/components/MultiAddSelect/MultiAddSelect.js

@@ -5,14 +5,13 @@
  * 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_AddSelect = require('../AddSelect/AddSelect.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
+const require_AddSelect = require("../AddSelect/AddSelect.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/MultiAddSelect/MultiAddSelect.tsx
 const componentName = "MultiAddSelect";
 /**
@@ -25,21 +24,62 @@ const MultiAddSelect = (0, react.forwardRef)((props, ref) => /* @__PURE__ */ rea
 	...require_devtools.getDevtoolsProps(componentName)
 }));
 MultiAddSelect.propTypes = {
+	/**
+	* optional class name
+	*/
 	className: prop_types.default.string,
+	/**
+	* placeholder for column input filter
+	*/
 	columnInputPlaceholder: prop_types.default.string,
+	/**
+	* text description that appears under the title
+	*/
 	description: prop_types.default.string,
+	/**
+	* options to display in the global filter box. values are generated
+	* from the id which should correlate with a specific property in an
+	* item entry
+	*/
+	/**@ts-ignore */
 	globalFilters: prop_types.default.arrayOf(prop_types.default.shape({
 		id: prop_types.default.string,
 		label: prop_types.default.string
 	})),
 	globalFiltersIconDescription: prop_types.default.string,
+	/**
+	* placeholder text for the global filter dropdown
+	*/
 	globalFiltersPlaceholderText: prop_types.default.string,
+	/**
+	* text for the global filter primary button
+	*/
 	globalFiltersPrimaryButtonText: prop_types.default.string,
+	/**
+	* text for the global filter secondary button
+	*/
 	globalFiltersSecondaryButtonText: prop_types.default.string,
+	/**
+	* label for global search input
+	*/
 	globalSearchLabel: prop_types.default.string,
+	/**
+	* placeholder for global search input
+	*/
 	globalSearchPlaceholder: prop_types.default.string,
+	/**
+	* the theme for the empty state illustration
+	*/
 	illustrationTheme: prop_types.default.oneOf(["light", "dark"]),
+	/**
+	* title that displays in the sidebar / influencer
+	*/
 	influencerTitle: prop_types.default.string,
+	/**
+	* object that contains the item data. for more information reference the
+	* "Structuring items" section in the docs tab
+	*/
+	/**@ts-ignore */
 	items: prop_types.default.shape({
 		modifiers: prop_types.default.shape({
 			label: prop_types.default.string,
@@ -63,21 +103,59 @@ MultiAddSelect.propTypes = {
 			value: prop_types.default.string.isRequired
 		}))
 	}),
+	/**
+	* label that display above the list of items
+	*/
 	itemsLabel: prop_types.default.string,
+	/**
+	* text to display when no results are found from the global search
+	*/
 	noResultsDescription: prop_types.default.string,
+	/**
+	* title to display when no results are found from the global search
+	*/
 	noResultsTitle: prop_types.default.string,
+	/**
+	* text body that displays in the sidebar when nothing is selected
+	*/
 	noSelectionDescription: prop_types.default.string,
+	/**
+	* title that displays in the sidebar when nothing is selected
+	*/
 	noSelectionTitle: prop_types.default.string,
+	/**
+	* Determines if the component should be rendered within a Tearsheet component
+	*/
 	noTearsheet: prop_types.default.bool,
+	/**
+	* function to call when the close button clicked
+	*/
 	onClose: prop_types.default.func,
+	/**
+	* text for close button
+	*/
 	onCloseButtonText: prop_types.default.string,
+	/**
+	* function to call when the submit button is clicked. returns a selection
+	*/
 	onSubmit: prop_types.default.func,
+	/**
+	* text for the submit button
+	*/
 	onSubmitButtonText: prop_types.default.string,
+	/**
+	* specifies if the component is open or not
+	*/
 	open: prop_types.default.bool,
+	/**
+	* text that displays when displaying filtered items
+	*/
 	searchResultsTitle: prop_types.default.string,
+	/**
+	* header text
+	*/
 	title: prop_types.default.string
 };
 MultiAddSelect.displayName = componentName;
-
 //#endregion
-exports.MultiAddSelect = MultiAddSelect;
+exports.MultiAddSelect = MultiAddSelect;

package/lib/components/Nav/Nav.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_NavItem = require('./NavItem.js');
-const require_NavList = require('./NavList.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");
+const require_NavItem = require("./NavItem.js");
+const require_NavList = require("./NavList.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/Nav/Nav.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -109,19 +108,33 @@ Nav.deprecated = {
 	details: `This component is deprecated`
 };
 Nav.propTypes = {
+	/**
+	* Hypertext reference for active page.
+	*/
 	activeHref: prop_types.default.string,
+	/**
+	* Child elements.
+	*/
 	children: prop_types.default.node,
+	/**
+	* Extra classes to add.
+	*/
 	className: prop_types.default.string,
+	/**
+	* Heading.
+	*/
 	heading: prop_types.default.string,
+	/**
+	* Aria-label on the rendered `nav` element.
+	*/
 	label: prop_types.default.string.isRequired
 };
 Nav = require_settings.pkg.checkComponentEnabled(Nav, componentName);
 Nav.displayName = componentName;
-
 //#endregion
-Object.defineProperty(exports, 'Nav', {
-  enumerable: true,
-  get: function () {
-    return Nav;
-  }
-});
+Object.defineProperty(exports, "Nav", {
+	enumerable: true,
+	get: function() {
+		return Nav;
+	}
+});

package/lib/components/Nav/NavItem.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_uuidv4 = require('../../global/js/utils/uuidv4.js');
-const require_index$1 = require('../../node_modules/@carbon/icons-react/lib/index.js');
-const require_NavItemLink = require('./NavItemLink.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_uuidv4 = require("../../global/js/utils/uuidv4.js");
+const require_index$1 = require("../../node_modules/@carbon/icons-react/lib/index.js");
+const require_NavItemLink = require("./NavItemLink.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/Nav/NavItem.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -76,28 +75,63 @@ let NavItem = ({ activeHref = defaults.activeHref, children = defaults.children,
 };
 NavItem.displayName = componentName;
 NavItem.propTypes = {
+	/**
+	* Hypertext reference for active page.
+	*/
 	activeHref: prop_types.default.string,
+	/**
+	* Provide the contents of the Nav.
+	*/
 	children: prop_types.default.node.isRequired,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/**
+	* Currently selected item.
+	*/
 	current: prop_types.default.string,
+	/**
+	* Whether the item is disabled.
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* The base element to use to build the link. Defaults to `a`, can also accept alternative tag names or custom components like `Link` from `react-router`.
+	*/
 	element: prop_types.default.elementType,
+	/**
+	* The href of the nav item.
+	*/
 	href: prop_types.default.string,
+	/**
+	* Identifier.
+	*/
 	id: prop_types.default.string,
+	/**
+	* Label of an item.
+	*/
 	label: prop_types.default.string,
+	/**
+	* Whether the item is a link.
+	*/
 	link: prop_types.default.bool,
+	/**
+	* Click handler of an item.
+	*/
 	onClick: prop_types.default.func,
+	/**
+	* `tabindex` of an item.
+	*/
 	tabIndex: prop_types.default.number
 };
 NavItem = require_settings.pkg.checkComponentEnabled(NavItem, componentName);
 var NavItem_default = NavItem;
-
 //#endregion
-Object.defineProperty(exports, 'NavItem', {
-  enumerable: true,
-  get: function () {
-    return NavItem;
-  }
+Object.defineProperty(exports, "NavItem", {
+	enumerable: true,
+	get: function() {
+		return NavItem;
+	}
 });
 exports.blockClass = blockClass;
-exports.default = NavItem_default;
+exports.default = NavItem_default;

package/lib/components/Nav/NavItemLink.js

@@ -5,12 +5,11 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.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/Nav/NavItemLink.jsx
 /**
 * Copyright IBM Corp. 2024
@@ -26,7 +25,8 @@ const NavItemLink = react.default.forwardRef(function NavItemLink(props, ref) {
 	});
 });
 NavItemLink.displayName = "NavItemLink";
-NavItemLink.propTypes = { element: prop_types.default.elementType };
-
+NavItemLink.propTypes = { 
+/** @type {elementType} The base element to use to build the link. Defaults to `a`, can also accept alternative tag names or custom components like `Link` from `react-router`. */
+element: prop_types.default.elementType };
 //#endregion
-exports.default = NavItemLink;
+exports.default = NavItemLink;