@carbon/ibm-products 2.89.0 → 2.90.0

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

package/lib/components/Cascade/Cascade.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/Cascade/Cascade.tsx
 var import_classnames = /* @__PURE__ */ require_runtime.__toESM(require_index.default);
 const blockClass = `${require_settings.pkg.prefix}--cascade`;
@@ -65,10 +64,20 @@ const Cascade = (0, react.forwardRef)((props, ref) => {
 });
 Cascade.displayName = componentName;
 Cascade.propTypes = {
+	/**
+	* Main content that is shown.
+	*/
 	children: prop_types.default.node,
+	/**
+	* Optional class name.
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specifies whether or not to wrap the child content in a `<Grid />`.
+	* If this is set to true it's important that the children are being wrapped in rows in columns.
+	* Check the documentation for additional clarification.
+	*/
 	grid: prop_types.default.bool
 };
-
 //#endregion
-exports.Cascade = Cascade;
+exports.Cascade = Cascade;

package/lib/components/Checklist/Checklist.js

@@ -5,21 +5,19 @@
  * 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_uuidv4 = require('../../global/js/utils/uuidv4.js');
-const require_Checklist_types = require('./Checklist.types.js');
-const require_ChecklistChart = require('./ChecklistChart.js');
-const require_ChecklistIcon = require('./ChecklistIcon.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_uuidv4 = require("../../global/js/utils/uuidv4.js");
+const require_ChecklistChart = require("./ChecklistChart.js");
+const require_ChecklistIcon = require("./ChecklistIcon.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/Checklist/Checklist.tsx
 /**
 * Copyright IBM Corp. 2023, 2024
@@ -44,7 +42,7 @@ const defaults = {
 	open: true,
 	enableToggle: true,
 	taskLists: [],
-	theme: require_Checklist_types.Themes.light,
+	theme: "light",
 	toggleLabel: "Toggle"
 };
 /**
@@ -134,32 +132,86 @@ const Checklist = react.default.forwardRef(({ chartValue, chartLabel, checklistA
 });
 Checklist.displayName = componentName;
 Checklist.propTypes = {
+	/**
+	* Define both `chartLabel` and `chartValue` to show the chart and its label together.
+	*/
 	chartLabel: prop_types.default.node,
+	/**
+	* A number between 0 and 1.
+	*
+	* Define both `chartLabel` and `chartValue` to show the chart and its label together.
+	*/
 	chartValue: prop_types.default.number,
+	/**
+	* Aria-label for the Checklist component.
+	*/
 	checklistAriaLabel: prop_types.default.string,
+	/**
+	* Aria-label for the Checklist's toggle component.
+	*/
 	checklistToggleAriaLabel: prop_types.default.string,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/**
+	* Whether or not to show the open/close toggle.
+	*/
 	enableToggle: prop_types.default.bool,
+	/**
+	* Callback for the "View all" button. See also `viewAllLabel`.
+	*/
 	onClickViewAll: prop_types.default.func,
+	/**
+	* Optional callback for when the list is opened/closed.
+	*/
 	onToggle: prop_types.default.func,
+	/**
+	* Specifies whether the component is opened or closed.
+	* This can be set during initialization, or changed after being rendered.
+	*/
 	open: prop_types.default.bool,
+	/**
+	* The task list can be broken down into sub-lists.
+	*
+	* Each sub-list can include an optional `title`.
+	*
+	* Each task must specify the appropriate icon (`kind`) and `label`.
+	*
+	* If any task has an `onClick` callback function defined,
+	* then the `label` will be rendered as a button,
+	* else the `label` will be rendered as plain text.
+	*/
+	/**@ts-ignore */
 	taskLists: prop_types.default.arrayOf(prop_types.default.shape({
 		title: prop_types.default.string,
 		tasks: prop_types.default.arrayOf(prop_types.default.shape({
 			kind: prop_types.default.oneOf([
-				require_Checklist_types.Kinds.unchecked,
-				require_Checklist_types.Kinds.indeterminate,
-				require_Checklist_types.Kinds.checked,
-				require_Checklist_types.Kinds.disabled,
-				require_Checklist_types.Kinds.error
+				"unchecked",
+				"indeterminate",
+				"checked",
+				"disabled",
+				"error"
 			]).isRequired,
 			label: prop_types.default.string.isRequired,
 			onClick: prop_types.default.func
 		})).isRequired
 	})).isRequired,
-	theme: prop_types.default.oneOf([require_Checklist_types.Themes.light, require_Checklist_types.Themes.dark]),
+	/**
+	* Determines the theme of the component.
+	*/
+	theme: prop_types.default.oneOf(["light", "dark"]),
+	/**
+	* The title of the component.
+	*/
 	title: prop_types.default.node,
+	/**
+	* The label for the toggle's tooltip.
+	*/
 	toggleLabel: prop_types.default.string,
+	/**
+	* The alignment of the toggle's tooltip.
+	*/
 	toggleLabelAlign: prop_types.default.oneOf([
 		"top",
 		"top-left",
@@ -170,8 +222,10 @@ Checklist.propTypes = {
 		"left",
 		"right"
 	]),
+	/**
+	* If defined, will show and enable the "View all (#)" button at the bottom of the list.
+	*/
 	viewAllLabel: prop_types.default.string
 };
-
 //#endregion
-exports.Checklist = Checklist;
+exports.Checklist = Checklist;

package/lib/components/Checklist/ChecklistChart.js

@@ -5,18 +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_Checklist_types = require('./Checklist.types.js');
-const require_index$1 = require('../../node_modules/@carbon/colors/lib/index.js');
-const require_clamp = require('../../global/js/utils/clamp.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_index$1 = require("../../node_modules/@carbon/colors/lib/index.js");
+const require_clamp = require("../../global/js/utils/clamp.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/Checklist/ChecklistChart.jsx
 /**
 * Copyright IBM Corp. 2023, 2024
@@ -28,7 +26,7 @@ var import_classnames = /* @__PURE__ */ require_runtime.__toESM(require_index.de
 var import_lib = require_index$1.default;
 const blockClass = `${require_settings.pkg.prefix}--checklist__chart`;
 const componentName = "ChecklistChart";
-const defaults = { theme: require_Checklist_types.Themes.light };
+const defaults = { theme: "light" };
 /**
 * Custom chart component used within Checklist PLG component
 */
@@ -38,7 +36,7 @@ let ChecklistChart = react.default.forwardRef(
 	*/
 	({ className, value, theme = defaults.theme, ...rest }, ref) => {
 		const numDegrees = require_clamp.clamp(value * 360, 0, 360);
-		const circleColor = theme === require_Checklist_types.Themes.light ? import_lib.gray20 : import_lib.gray70;
+		const circleColor = theme === "light" ? import_lib.gray20 : import_lib.gray70;
 		const progressColor = import_lib.purple50;
 		(0, react.useEffect)(() => {
 			const ele = document.getElementsByClassName(`${blockClass}`);
@@ -60,10 +58,18 @@ let ChecklistChart = react.default.forwardRef(
 );
 ChecklistChart.displayName = componentName;
 ChecklistChart.propTypes = {
+	/**
+	* Optional class name for this component.
+	*/
 	className: prop_types.default.string,
-	theme: prop_types.default.oneOf([require_Checklist_types.Themes.light, require_Checklist_types.Themes.dark]),
+	/**
+	* Determines the theme of the component.
+	*/
+	theme: prop_types.default.oneOf(["light", "dark"]),
+	/**
+	* Number between 0 and 1.
+	*/
 	value: prop_types.default.number.isRequired
 };
-
 //#endregion
-exports.ChecklistChart = ChecklistChart;
+exports.ChecklistChart = ChecklistChart;

package/lib/components/Checklist/ChecklistIcon.js

@@ -5,17 +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_Checklist_types = require('./Checklist.types.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_icons = require("@carbon/react/icons");
-
 //#region src/components/Checklist/ChecklistIcon.jsx
 /**
 * Copyright IBM Corp. 2023, 2024
@@ -32,7 +30,7 @@ let _carbon_react_icons = require("@carbon/react/icons");
 var import_classnames = /* @__PURE__ */ require_runtime.__toESM(require_index.default);
 const blockClass = `${require_settings.pkg.prefix}--checklist__icon`;
 const componentName = "ChecklistIcon";
-const defaults = { theme: require_Checklist_types.Themes.light };
+const defaults = { theme: "light" };
 /**
 * TODO: A description of the component.
 */
@@ -65,16 +63,24 @@ let ChecklistIcon = react.default.forwardRef(
 	}
 );
 ChecklistIcon.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/**
+	* The icon to be displayed.
+	*/
 	kind: prop_types.default.oneOf([
-		require_Checklist_types.Kinds.unchecked,
-		require_Checklist_types.Kinds.indeterminate,
-		require_Checklist_types.Kinds.checked,
-		require_Checklist_types.Kinds.disabled,
-		require_Checklist_types.Kinds.error
+		"unchecked",
+		"indeterminate",
+		"checked",
+		"disabled",
+		"error"
 	]),
-	theme: prop_types.default.oneOf([require_Checklist_types.Themes.light, require_Checklist_types.Themes.dark])
+	/**
+	* Determines the theme of the component.
+	*/
+	theme: prop_types.default.oneOf(["light", "dark"])
 };
-
 //#endregion
-exports.ChecklistIcon = ChecklistIcon;
+exports.ChecklistIcon = ChecklistIcon;

package/lib/components/Coachmark/Coachmark.js

@@ -5,23 +5,22 @@
  * 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_enums = require('./utils/enums.js');
-const require_hooks = require('./utils/hooks.js');
-const require_context = require('./utils/context.js');
-const require_CoachmarkOverlay = require('./CoachmarkOverlay.js');
-const require_throttle = require('../../global/js/utils/throttle.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");
+require("./utils/enums.js");
+const require_hooks = require("./utils/hooks.js");
+const require_context = require("./utils/context.js");
+const require_CoachmarkOverlay = require("./CoachmarkOverlay.js");
+const require_throttle = require("../../global/js/utils/throttle.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 react_dom = require("react-dom");
-
 //#region src/components/Coachmark/Coachmark.tsx
 /**
 * Copyright IBM Corp. 2023, 2025
@@ -48,8 +47,8 @@ const defaults = {
 * @deprecated This component is deprecated.
 */
 const Coachmark = (0, react.forwardRef)(({ align = defaults.align, autoAlign, children, className, onClose = defaults.onClose, overlayClassName, overlayKind = defaults.overlayKind, overlayRef, positionTune, portalTarget, target, theme = defaults.theme, isOpenByDefault = defaults.isOpenByDefault, closeIconDescription = defaults.closeIconDescription, ...rest }, ref) => {
-	const isBeacon = overlayKind === require_enums.COACHMARK_OVERLAY_KIND.TOOLTIP;
-	const isStacked = overlayKind === require_enums.COACHMARK_OVERLAY_KIND.STACKED;
+	const isBeacon = overlayKind === "tooltip";
+	const isStacked = overlayKind === "stacked";
 	const [isOpen, setIsOpen] = (0, react.useState)(isStacked || isOpenByDefault);
 	const [shouldResetPosition, setShouldResetPosition] = (0, react.useState)(false);
 	const [targetRect, setTargetRect] = (0, react.useState)();
@@ -177,18 +176,50 @@ Coachmark.deprecated = {
 };
 Coachmark.displayName = componentName;
 const deprecatedProps = {
+	/**
+	* **Deprecated**
+	* Optional class name for the Coachmark Overlay component.
+	*/
 	overlayClassName: prop_types.default.string,
+	/**
+	* **Deprecated**
+	* What kind or style of Coachmark to render.
+	*/
 	overlayKind: prop_types.default.oneOf([
 		"tooltip",
 		"floating",
 		"stacked"
 	]),
 	overlayRef: prop_types.default.shape({ current: overlayRefType }),
+	/**
+	* **Deprecated**
+	* By default, the Coachmark will be appended to the end of `document.body`.
+	* The Coachmark will remain persistent as the user navigates the app until
+	* the user closes the Coachmark.
+	*
+	* Alternatively, the app developer can tightly couple the Coachmark to a DOM
+	* element or other component by specifying a CSS selector. The Coachmark will
+	* remain visible as long as that element remains visible or mounted. When the
+	* element is hidden or component is unmounted, the Coachmark will disappear.
+	*/
 	portalTarget: prop_types.default.string,
+	/**
+	* **Deprecated**
+	* The optional button or beacon that the user will click to show the Coachmark.
+	*/
 	target: prop_types.default.node,
+	/**
+	* **Deprecated**
+	* Determines the theme of the component.
+	*/
 	theme: prop_types.default.oneOf(["light", "dark"])
 };
 Coachmark.propTypes = {
+	/**
+	* Where to render the Coachmark relative to its target.
+	* Applies only to Floating and Tooltip Coachmarks.
+	* @see COACHMARK_ALIGNMENT
+	*/
 	align: prop_types.default.oneOf([
 		"bottom",
 		"bottom-left",
@@ -203,18 +234,41 @@ Coachmark.propTypes = {
 		"top-left",
 		"top-right"
 	]),
+	/**
+	* Auto aligns the coachmark based on screen boundaries
+	* Applies only to Tooltip Coachmarks.
+	*/
 	autoAlign: prop_types.default.bool,
+	/**
+	* Coachmark should use a single CoachmarkOverlayElements component as a child.
+	* @see CoachmarkOverlayElements
+	*/
 	children: prop_types.default.node.isRequired,
+	/**
+	* Optional class name for this component.
+	*/
 	className: prop_types.default.string,
+	/**
+	* Tooltip text and aria label for the Close button icon.
+	*/
 	closeIconDescription: prop_types.default.string,
+	/**
+	* Determines if the coachmark is open by default.
+	* Does nothing if `overlayKind=stacked`.
+	*/
 	isOpenByDefault: prop_types.default.bool,
+	/**
+	* Function to call when the Coachmark closes.
+	*/
 	onClose: prop_types.default.func,
+	/**
+	* Fine tune the position of the target in pixels. Applies only to Beacons.
+	*/
 	positionTune: prop_types.default.shape({
 		x: prop_types.default.number,
 		y: prop_types.default.number
 	}),
 	...deprecatedProps
 };
-
 //#endregion
-exports.Coachmark = Coachmark;
+exports.Coachmark = Coachmark;

package/lib/components/Coachmark/CoachmarkDragbar.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_devtools = require('../../global/js/utils/devtools.js');
-const require_context = require('./utils/context.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_context = require("./utils/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/Coachmark/CoachmarkDragbar.tsx
 /**
 * Copyright IBM Corp. 2023, 2025
@@ -87,12 +86,27 @@ CoachmarkDragbar.deprecated = {
 };
 CoachmarkDragbar.displayName = componentName;
 CoachmarkDragbar.propTypes = {
+	/**
+	* Handler to manage keyboard interactions with the dragbar.
+	*/
 	a11yKeyboardHandler: prop_types.default.func.isRequired,
+	/**
+	* Function to call when the close button is clicked.
+	*/
 	onClose: prop_types.default.func,
+	/**
+	* Function to call when the user clicks and drags the Coachmark.
+	* For internal use only by the parent CoachmarkOverlay.
+	*/
 	onDrag: prop_types.default.func,
+	/**
+	* Show/hide the "X" close button.
+	*/
 	showCloseButton: prop_types.default.bool,
+	/**
+	* Determines the theme of the component.
+	*/
 	theme: prop_types.default.oneOf(["light", "dark"])
 };
-
 //#endregion
-exports.CoachmarkDragbar = CoachmarkDragbar;
+exports.CoachmarkDragbar = CoachmarkDragbar;

package/lib/components/Coachmark/CoachmarkHeader.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_devtools = require('../../global/js/utils/devtools.js');
-const require_context = require('./utils/context.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_context = require("./utils/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/Coachmark/CoachmarkHeader.tsx
 /**
 * Copyright IBM Corp. 2023, 2025
@@ -62,11 +61,22 @@ CoachmarkHeader.deprecated = {
 };
 CoachmarkHeader.displayName = componentName;
 CoachmarkHeader.propTypes = {
+	/**
+	* Tooltip text and aria label for the Close button icon.
+	*/
 	closeIconDescription: prop_types.default.string,
+	/**
+	* Function to call when the close button is clicked.
+	*/
 	onClose: prop_types.default.func,
+	/**
+	* Show/hide the "X" close button.
+	*/
 	showCloseButton: prop_types.default.bool,
+	/**
+	* Determines the theme of the component.
+	*/
 	theme: prop_types.default.oneOf(["light", "dark"])
 };
-
 //#endregion
-exports.CoachmarkHeader = CoachmarkHeader;
+exports.CoachmarkHeader = CoachmarkHeader;