@carbon/ibm-products 2.89.0 → 2.90.0

package/lib/components/Coachmark/utils/constants.js

@@ -5,16 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_enums = require('./enums.js');
-
+require("./enums.js");
 //#region src/components/Coachmark/utils/constants.js
 /**
-* 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.
-*/
-/**
 * If the coachmark's target is a link, button, etc. (i.e. not a beacon),
 * this adjusts the coachmark's position based on the position and size of the target.
 * @param {object} coachmark target reference
@@ -26,46 +19,46 @@ const getOffsetTune = (coachmark, kind) => {
 	const distanceOffset = 24;
 	let top = 0;
 	let left = 0;
-	if (kind !== require_enums.COACHMARK_OVERLAY_KIND.TOOLTIP) switch (coachmark.align) {
-		case require_enums.COACHMARK_ALIGNMENT.TOP:
+	if (kind !== "tooltip") switch (coachmark.align) {
+		case "top":
 			left = width / 2;
 			break;
-		case require_enums.COACHMARK_ALIGNMENT.TOP_LEFT:
+		case "top-left":
 			left = distanceOffset;
 			break;
-		case require_enums.COACHMARK_ALIGNMENT.TOP_RIGHT:
+		case "top-right":
 			left = width - distanceOffset;
 			break;
-		case require_enums.COACHMARK_ALIGNMENT.BOTTOM:
+		case "bottom":
 			top = height;
 			left = width / 2;
 			break;
-		case require_enums.COACHMARK_ALIGNMENT.BOTTOM_LEFT:
+		case "bottom-left":
 			top = height;
 			left = distanceOffset;
 			break;
-		case require_enums.COACHMARK_ALIGNMENT.BOTTOM_RIGHT:
+		case "bottom-right":
 			top = height;
 			left = width - distanceOffset;
 			break;
-		case require_enums.COACHMARK_ALIGNMENT.LEFT:
+		case "left":
 			top = height / 2;
 			break;
-		case require_enums.COACHMARK_ALIGNMENT.LEFT_TOP:
+		case "left-top":
 			top = distanceOffset;
 			break;
-		case require_enums.COACHMARK_ALIGNMENT.LEFT_BOTTOM:
+		case "left-bottom":
 			top = height - distanceOffset;
 			break;
-		case require_enums.COACHMARK_ALIGNMENT.RIGHT:
+		case "right":
 			top = height / 2;
 			left = width;
 			break;
-		case require_enums.COACHMARK_ALIGNMENT.RIGHT_TOP:
+		case "right-top":
 			top = distanceOffset;
 			left = width;
 			break;
-		case require_enums.COACHMARK_ALIGNMENT.RIGHT_BOTTOM:
+		case "right-bottom":
 			top = height - distanceOffset;
 			left = width;
 			break;
@@ -75,6 +68,5 @@ const getOffsetTune = (coachmark, kind) => {
 		left
 	};
 };
-
 //#endregion
-exports.getOffsetTune = getOffsetTune;
+exports.getOffsetTune = getOffsetTune;

package/lib/components/Coachmark/utils/context.js

@@ -5,15 +5,13 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../../_virtual/_rolldown/runtime.js');
+require("../../../_virtual/_rolldown/runtime.js");
 let react = require("react");
-
 //#region src/components/Coachmark/utils/context.ts
 const CoachmarkContext = (0, react.createContext)(null);
 const useCoachmark = () => {
 	return (0, react.useContext)(CoachmarkContext);
 };
-
 //#endregion
 exports.CoachmarkContext = CoachmarkContext;
-exports.useCoachmark = useCoachmark;
+exports.useCoachmark = useCoachmark;

package/lib/components/Coachmark/utils/enums.js

@@ -5,7 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-
 //#region src/components/Coachmark/utils/enums.ts
 /**
 * Copyright IBM Corp. 2024, 2025
@@ -53,8 +52,7 @@ let COACHMARK_ALIGNMENT = /* @__PURE__ */ function(COACHMARK_ALIGNMENT) {
 	COACHMARK_ALIGNMENT["TOP_RIGHT"] = "top-right";
 	return COACHMARK_ALIGNMENT;
 }({});
-
 //#endregion
 exports.BEACON_KIND = BEACON_KIND;
 exports.COACHMARK_ALIGNMENT = COACHMARK_ALIGNMENT;
-exports.COACHMARK_OVERLAY_KIND = COACHMARK_OVERLAY_KIND;
+exports.COACHMARK_OVERLAY_KIND = COACHMARK_OVERLAY_KIND;

package/lib/components/Coachmark/utils/hooks.js

@@ -5,11 +5,10 @@
  * 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');
-const require_enums = require('./enums.js');
+require("../../../_virtual/_rolldown/runtime.js");
+const require_useIsomorphicEffect = require("../../../global/js/hooks/useIsomorphicEffect.js");
+require("./enums.js");
 let react = require("react");
-
 //#region src/components/Coachmark/utils/hooks.js
 /**
 * Copyright IBM Corp. 2024
@@ -26,7 +25,7 @@ let react = require("react");
 */
 function useClickOutsideElement(coachmarkRef, overlayRef, overlayKind, callback) {
 	const cb = (0, react.useRef)(void 0);
-	const isTooltip = overlayKind === require_enums.COACHMARK_OVERLAY_KIND.TOOLTIP;
+	const isTooltip = overlayKind === "tooltip";
 	require_useIsomorphicEffect.useIsomorphicEffect(() => {
 		cb.current = callback;
 	}, [callback]);
@@ -64,7 +63,6 @@ const useWindowEvent = (eventName, callback) => {
 		};
 	}, [eventName]);
 };
-
 //#endregion
 exports.useClickOutsideElement = useClickOutsideElement;
-exports.useWindowEvent = useWindowEvent;
+exports.useWindowEvent = useWindowEvent;

package/lib/components/CoachmarkBeacon/CoachmarkBeacon.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/CoachmarkBeacon/CoachmarkBeacon.tsx
 var import_classnames = /* @__PURE__ */ require_runtime.__toESM(require_index.default);
 const blockClass = `${require_settings.pkg.prefix}--coachmark-beacon`;
@@ -52,17 +51,32 @@ CoachmarkBeacon.deprecated = {
 };
 CoachmarkBeacon.displayName = componentName;
 CoachmarkBeacon.propTypes = {
+	/**
+	* button props
+	*/
 	buttonProps: prop_types.default.shape({
+		/**@ts-ignore*/
 		..._carbon_react.Button.propTypes,
+		/**@ts-ignore*/
 		onClick: prop_types.default.func,
 		onDoubleClick: prop_types.default.func,
 		tabIndex: prop_types.default.number,
 		["aria-expanded"]: prop_types.default.bool
 	}),
+	/**
+	* Optional class name for this component.
+	*/
 	className: prop_types.default.string,
+	/**
+	* What style of beacon.
+	* BEACON_KIND is an exported enum from the Coachmark and can be used for this value.
+	* @see {@link BEACON_KIND}
+	*/
 	kind: prop_types.default.oneOf(["default"]),
+	/**
+	* The aria label.
+	*/
 	label: prop_types.default.string.isRequired
 };
-
 //#endregion
-exports.CoachmarkBeacon = CoachmarkBeacon;
+exports.CoachmarkBeacon = CoachmarkBeacon;

package/lib/components/CoachmarkButton/CoachmarkButton.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_context = require('../Coachmark/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("../Coachmark/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");
-
 //#region src/components/CoachmarkButton/CoachmarkButton.tsx
 /**
 * Copyright IBM Corp. 2023, 2025
@@ -50,9 +49,14 @@ CoachmarkButton.deprecated = {
 };
 CoachmarkButton.displayName = componentName;
 CoachmarkButton.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/**
+	* The aria label.
+	*/
 	label: prop_types.default.string.isRequired
 };
-
 //#endregion
-exports.CoachmarkButton = CoachmarkButton;
+exports.CoachmarkButton = CoachmarkButton;

package/lib/components/CoachmarkFixed/CoachmarkFixed.js

@@ -5,22 +5,21 @@
  * 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_usePrefersReducedMotion = require('../../global/js/hooks/usePrefersReducedMotion.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
-const require_enums = require('../Coachmark/utils/enums.js');
-const require_context = require('../Coachmark/utils/context.js');
-const require_CoachmarkOverlay = require('../Coachmark/CoachmarkOverlay.js');
-const require_CoachmarkTagline = require('../Coachmark/CoachmarkTagline.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_usePrefersReducedMotion = require("../../global/js/hooks/usePrefersReducedMotion.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
+require("../Coachmark/utils/enums.js");
+const require_context = require("../Coachmark/utils/context.js");
+const require_CoachmarkOverlay = require("../Coachmark/CoachmarkOverlay.js");
+const require_CoachmarkTagline = require("../Coachmark/CoachmarkTagline.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let react_dom = require("react-dom");
-
 //#region src/components/CoachmarkFixed/CoachmarkFixed.tsx
 /**
 * Copyright IBM Corp. 2023, 2024
@@ -124,7 +123,7 @@ const CoachmarkFixed = react.default.forwardRef(({ children, className, onClose
 	}), isOpen && portalNode?.current && (0, react_dom.createPortal)(/* @__PURE__ */ react.default.createElement(require_CoachmarkOverlay.CoachmarkOverlay, {
 		ref: overlayRef,
 		fixedIsVisible,
-		kind: require_enums.COACHMARK_OVERLAY_KIND.FIXED,
+		kind: "fixed",
 		onClose: handleClose,
 		onTransitionEnd: handleTransitionEnd,
 		theme,
@@ -138,14 +137,41 @@ CoachmarkFixed.deprecated = {
 };
 CoachmarkFixed.displayName = componentName;
 CoachmarkFixed.propTypes = {
+	/**
+	* CoachmarkFixed should use a single CoachmarkOverlayElements component as a child.
+	*/
 	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,
+	/**
+	* Function to call when the Coachmark closes.
+	*/
 	onClose: prop_types.default.func,
+	/**
+	* 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,
+	/**
+	* The tagline title which will be fixed to the bottom right of the window and will serve as the display trigger.
+	*/
 	tagline: prop_types.default.string.isRequired,
+	/**
+	* Determines the theme of the component.
+	*/
 	theme: prop_types.default.oneOf(["light", "dark"])
 };
-
 //#endregion
-exports.CoachmarkFixed = CoachmarkFixed;
+exports.CoachmarkFixed = CoachmarkFixed;

package/lib/components/CoachmarkOverlayElement/CoachmarkOverlayElement.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/CoachmarkOverlayElement/CoachmarkOverlayElement.tsx
 /**
 * Copyright IBM Corp. 2023, 2025
@@ -45,11 +44,23 @@ CoachmarkOverlayElement.deprecated = {
 };
 CoachmarkOverlayElement.displayName = componentName;
 CoachmarkOverlayElement.propTypes = {
+	/**
+	* An optional button can be rendered below the description.
+	* This can be a link, button, Coachmark button, etc.
+	*/
 	button: prop_types.default.node,
+	/**
+	* Optional class name for this component.
+	*/
 	className: prop_types.default.string,
+	/**
+	* The description of the Coachmark.
+	*/
 	description: prop_types.default.node.isRequired,
+	/**
+	* The title of the Coachmark.
+	*/
 	title: prop_types.default.string.isRequired
 };
-
 //#endregion
-exports.CoachmarkOverlayElement = CoachmarkOverlayElement;
+exports.CoachmarkOverlayElement = CoachmarkOverlayElement;

package/lib/components/CoachmarkOverlayElements/CoachmarkOverlayElements.js

@@ -5,20 +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_pconsole = require('../../global/js/utils/pconsole.js');
-const require_settings = require('../../settings.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
-const require_clamp = require('../../global/js/utils/clamp.js');
-const require_Carousel = require('../Carousel/Carousel.js');
-const require_context = require('../Coachmark/utils/context.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_pconsole = require("../../global/js/utils/pconsole.js");
+const require_settings = require("../../settings.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
+const require_clamp = require("../../global/js/utils/clamp.js");
+const require_Carousel = require("../Carousel/Carousel.js");
+const require_context = require("../Coachmark/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");
-
 //#region src/components/CoachmarkOverlayElements/CoachmarkOverlayElements.tsx
 /**
 * Copyright IBM Corp. 2023, 2025
@@ -121,17 +120,48 @@ CoachmarkOverlayElements.deprecated = {
 };
 CoachmarkOverlayElements.displayName = componentName;
 CoachmarkOverlayElements.propTypes = {
+	/**
+	* CoachmarkOverlayElements should be used with one or many CoachmarkOverlayElement components as children.
+	* @see CoachmarkOverlayElement
+	*/
 	children: prop_types.default.node.isRequired,
+	/**
+	* Optional class name for this component.
+	*/
 	className: prop_types.default.string,
+	/**
+	* The label for the Close button.
+	*/
 	closeButtonLabel: prop_types.default.string,
+	/**
+	* Current step of the coachmarks
+	*/
 	currentStep: prop_types.default.number,
+	/**
+	* The visibility of CoachmarkOverlayElements is
+	* managed in the parent component.
+	*/
 	isVisible: prop_types.default.bool,
+	/**
+	* The label for the Next button.
+	*/
 	nextButtonText: prop_types.default.string,
+	/**
+	* Optional callback called when clicking on the Previous button.
+	*/
 	onBack: prop_types.default.func,
+	/**
+	* Optional callback called when clicking on the Next button.
+	*/
 	onNext: prop_types.default.func,
+	/**
+	* The label for the Previous button.
+	*/
 	previousButtonLabel: prop_types.default.string,
+	/**
+	* Optional prop to render any media like images or animated media.
+	*/
 	renderMedia: prop_types.default.func
 };
-
 //#endregion
-exports.CoachmarkOverlayElements = CoachmarkOverlayElements;
+exports.CoachmarkOverlayElements = CoachmarkOverlayElements;

package/lib/components/CoachmarkStack/CoachmarkStack.js

@@ -5,22 +5,21 @@
  * 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('../Coachmark/utils/enums.js');
-const require_context = require('../Coachmark/utils/context.js');
-const require_CoachmarkOverlay = require('../Coachmark/CoachmarkOverlay.js');
-const require_CoachmarkTagline = require('../Coachmark/CoachmarkTagline.js');
-const require_CoachmarkStackHome = require('./CoachmarkStackHome.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("../Coachmark/utils/enums.js");
+const require_context = require("../Coachmark/utils/context.js");
+const require_CoachmarkOverlay = require("../Coachmark/CoachmarkOverlay.js");
+const require_CoachmarkTagline = require("../Coachmark/CoachmarkTagline.js");
+const require_CoachmarkStackHome = require("./CoachmarkStackHome.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let react_dom = require("react-dom");
-
 //#region src/components/CoachmarkStack/CoachmarkStack.tsx
 /**
 * Copyright IBM Corp. 2023, 2025
@@ -138,7 +137,7 @@ const CoachmarkStack = react.default.forwardRef(({ children, className, onClose
 			ref: (ref) => {
 				stackedCoachmarkRefs.current[idx] = ref;
 			},
-			kind: require_enums.COACHMARK_OVERLAY_KIND.STACKED,
+			kind: "stacked",
 			onClose: () => handleClose(false),
 			theme,
 			fixedIsVisible: false,
@@ -177,20 +176,59 @@ CoachmarkStack.deprecated = {
 };
 CoachmarkStack.displayName = componentName;
 CoachmarkStack.propTypes = {
+	/**
+	* CoachmarkStack should use a single CoachmarkOverlayElements component as a child.
+	*/
 	children: prop_types.default.node.isRequired,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/**
+	* The label for the button that will close the Stack
+	*/
 	closeButtonLabel: prop_types.default.string,
+	/**
+	* Tooltip text and aria label for the Close button icon.
+	*/
 	closeIconDescription: prop_types.default.string,
+	/**
+	* The description of the Coachmark.
+	*/
 	description: prop_types.default.node.isRequired,
+	/**
+	* The labels used to link to the stackable Coachmarks.
+	*/
 	navLinkLabels: prop_types.default.arrayOf(prop_types.default.string.isRequired).isRequired,
+	/**
+	* Function to call when the CoachmarkStack closes.
+	*/
 	onClose: prop_types.default.func,
+	/**
+	* Where in the DOM to render the stack.
+	* The default is `document.body`.
+	*/
 	portalTarget: prop_types.default.string,
+	/**
+	* Optional prop to render any media like images or animated media.
+	*/
 	renderMedia: prop_types.default.func,
+	/**
+	* The tagline title which will be fixed to the bottom right of the window and will serve as the display trigger.
+	*/
 	tagline: prop_types.default.string.isRequired,
+	/**
+	* Determines the theme of the component.
+	*/
 	theme: prop_types.default.oneOf(["light", "dark"]),
+	/**
+	* The title of the Coachmark.
+	*/
 	title: prop_types.default.string.isRequired,
+	/**
+	* Label's tooltip position
+	*/
 	tooltipAlign: prop_types.default.oneOf(["top", "bottom"])
 };
-
 //#endregion
-exports.CoachmarkStack = CoachmarkStack;
+exports.CoachmarkStack = CoachmarkStack;

package/lib/components/CoachmarkStack/CoachmarkStackHome.js

@@ -5,13 +5,13 @@
  * 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_pconsole = require('../../global/js/utils/pconsole.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_CoachmarkHeader = require('../Coachmark/CoachmarkHeader.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_pconsole = require("../../global/js/utils/pconsole.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_CoachmarkHeader = require("../Coachmark/CoachmarkHeader.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
@@ -19,7 +19,6 @@ prop_types = require_runtime.__toESM(prop_types);
 let _carbon_react = require("@carbon/react");
 let react_dom = require("react-dom");
 let _carbon_react_icons = require("@carbon/react/icons");
-
 //#region src/components/CoachmarkStack/CoachmarkStackHome.tsx
 /**
 * Copyright IBM Corp. 2023, 2024
@@ -107,18 +106,57 @@ const CoachmarkStackHome = (0, react.forwardRef)(({ className, description, isOp
 });
 CoachmarkStackHome.displayName = componentName;
 CoachmarkStackHome.propTypes = {
+	/**
+	* Optional class name for this component.
+	*/
 	className: prop_types.default.string,
+	/**
+	* The label for the button that will close the stack
+	*/
 	closeButtonLabel: prop_types.default.string,
+	/**
+	* The description of the Coachmark.
+	*/
 	description: prop_types.default.node.isRequired,
+	/**
+	* If the stack home is open.
+	*/
 	isOpen: prop_types.default.bool.isRequired,
+	/**
+	* The labels used to link to the stackable Coachmarks.
+	*/
 	navLinkLabels: prop_types.default.arrayOf(prop_types.default.string.isRequired).isRequired,
+	/**
+	* For internal use only by CoachmarkStack and CoachmarkStackHome.
+	*/
 	onClickNavItem: prop_types.default.func.isRequired,
+	/**
+	* Function to call when the stack closes.
+	*/
 	onClose: prop_types.default.func.isRequired,
+	/**
+	* 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: prop_types.default.string,
+	/**
+	* Optional prop to render any media like images or animated media.
+	*/
 	renderMedia: prop_types.default.func,
+	/**
+	* The title of the Coachmark.
+	*/
 	title: prop_types.default.string.isRequired,
+	/**
+	* Label's tooltip position
+	*/
 	tooltipAlign: prop_types.default.oneOf(["top", "bottom"])
 };
-
 //#endregion
-exports.CoachmarkStackHome = CoachmarkStackHome;
+exports.CoachmarkStackHome = CoachmarkStackHome;