@carbon/ibm-products 2.89.0 → 2.90.0

package/es/components/Coachmark/CoachmarkTagline.js

@@ -14,7 +14,6 @@ import React from "react";
 import PropTypes from "prop-types";
 import { Button } from "@carbon/react";
 import { Close, Idea } from "@carbon/react/icons";
-
 //#region src/components/Coachmark/CoachmarkTagline.tsx
 /**
 * Copyright IBM Corp. 2023, 2025
@@ -65,11 +64,22 @@ CoachmarkTagline.deprecated = {
 };
 CoachmarkTagline.displayName = componentName;
 CoachmarkTagline.propTypes = {
+	/**
+	* Tooltip text and aria label for the Close button icon.
+	*/
 	closeIconDescription: PropTypes.string,
+	/**
+	* Function to call when the close button is clicked.
+	*/
 	onClose: PropTypes.func,
+	/**
+	* Determines the theme of the component.
+	*/
 	theme: PropTypes.oneOf(["light", "dark"]),
+	/**
+	* The title of the tagline.
+	*/
 	title: PropTypes.string.isRequired
 };
-
 //#endregion
-export { CoachmarkTagline };
+export { CoachmarkTagline };

package/es/components/Coachmark/next/Coachmark/Coachmark.d.ts

@@ -4,7 +4,7 @@
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { FC, ForwardRefExoticComponent, ReactNode, RefAttributes } from 'react';
+import { FC, ForwardRefExoticComponent, ReactNode, RefAttributes, RefObject } from 'react';
 import { CoachmarkContentProps } from './CoachmarkContent';
 import { NewPopoverAlignment } from '@carbon/react';
 import { ContentHeaderProps } from './ContentHeader';
@@ -58,6 +58,10 @@ export interface CoachmarkPropsNext {
      * If not provided, no automatic focus management will occur.
      */
     selectorPrimaryFocus?: string;
+    /**
+     * Optional ref for an external trigger element, used when the trigger is not part of the coachmark.
+     */
+    triggerRef?: RefObject<HTMLElement>;
 }
 type CoachmarkContentComponent = FC<CoachmarkContentProps> & {
     Header: FC<ContentHeaderProps>;

package/es/components/Coachmark/next/Coachmark/Coachmark.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Coachmark.d.ts","sourceRoot":"","sources":["../../../../../src/components/Coachmark/next/Coachmark/Coachmark.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EACZ,EAAE,EACF,yBAAyB,EACzB,SAAS,EACT,aAAa,EAMd,MAAM,OAAO,CAAC;AAOf,OAAyB,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC7E,OAAO,EAAW,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAE7D,OAAO,EAAiB,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAe,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAiB9D,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,SAAS,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACpC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,KAAK,yBAAyB,GAAG,EAAE,CAAC,qBAAqB,CAAC,GAAG;IAC3D,MAAM,EAAE,EAAE,CAAC,kBAAkB,CAAC,CAAC;IAC/B,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,yBAAyB,CACxD,kBAAkB,GAAG,aAAa,CAAC,cAAc,CAAC,CACnD,GAAG;IACF,OAAO,EAAE,yBAAyB,CAAC;CACpC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,SAAS,EAuIjB,kBAAkB,CAAC"}
+{"version":3,"file":"Coachmark.d.ts","sourceRoot":"","sources":["../../../../../src/components/Coachmark/next/Coachmark/Coachmark.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EACZ,EAAE,EACF,yBAAyB,EACzB,SAAS,EACT,aAAa,EACb,SAAS,EAKV,MAAM,OAAO,CAAC;AAOf,OAAyB,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC7E,OAAO,EAAW,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAE7D,OAAO,EAAiB,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAe,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAiB9D,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,SAAS,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACpC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC;CACrC;AAED,KAAK,yBAAyB,GAAG,EAAE,CAAC,qBAAqB,CAAC,GAAG;IAC3D,MAAM,EAAE,EAAE,CAAC,kBAAkB,CAAC,CAAC;IAC/B,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,yBAAyB,CACxD,kBAAkB,GAAG,aAAa,CAAC,cAAc,CAAC,CACnD,GAAG;IACF,OAAO,EAAE,yBAAyB,CAAC;CACpC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,SAAS,EAwJjB,kBAAkB,CAAC"}

package/es/components/Coachmark/next/Coachmark/Coachmark.js

@@ -16,7 +16,6 @@ import ContentBody from "./ContentBody.js";
 import React, { forwardRef, useEffect, useRef, useState } from "react";
 import PropTypes from "prop-types";
 import { Popover } from "@carbon/react";
-
 //#region src/components/Coachmark/next/Coachmark/Coachmark.tsx
 /**
 * Copyright IBM Corp. 2024, 2025
@@ -35,8 +34,9 @@ const Coachmark = forwardRef((props, ref) => {
 	const { children, className, onClose, align = "bottom", open, position = {
 		x: 0,
 		y: 0
-	}, floating, dropShadow, highContrast, caret, selectorPrimaryFocus, ...rest } = props;
-	const triggerRef = useRef(null);
+	}, floating, dropShadow, highContrast, caret, selectorPrimaryFocus, triggerRef: triggerRefProp, ...rest } = props;
+	const internalTriggerRef = useRef(null);
+	const triggerRef = triggerRefProp ?? internalTriggerRef;
 	const internalRef = useRef(null);
 	const [contentRef, setContentRef] = useState(null);
 	const [openState, setOpenState] = useState(false);
@@ -47,15 +47,20 @@ const Coachmark = forwardRef((props, ref) => {
 	const currentOpen = open ?? openState;
 	const caretValue = caret !== void 0 ? caret : floating === true ? false : true;
 	useEffect(() => {
+		if (triggerRefProp?.current) return;
 		const container = internalRef.current;
 		if (!container) return;
 		const firstFocusable = Array.from(container.querySelectorAll("*")).find((el) => el.tabIndex >= 0 && !el.hasAttribute("disabled"));
 		if (firstFocusable) triggerRef.current = firstFocusable;
-	}, [children]);
+	}, [
+		children,
+		triggerRef,
+		triggerRefProp
+	]);
 	useEffect(() => {
 		const el = triggerRef.current;
 		if (el) el.setAttribute("aria-expanded", String(!!open));
-	}, [open]);
+	}, [open, triggerRef]);
 	useEffect(() => {
 		if (!open && contentRef && floating) {
 			contentRef.style.transform = "none";
@@ -105,28 +110,70 @@ const Coachmark = forwardRef((props, ref) => {
 		caret: caretValue,
 		highContrast: highContrast ?? true,
 		dropShadow
-	}, children)));
+	}, triggerRefProp?.current ? /* @__PURE__ */ React.createElement("span", {
+		"aria-hidden": "true",
+		style: { display: "contents" },
+		ref: (node) => {
+			if (node && triggerRefProp.current) node.replaceWith(triggerRefProp.current);
+		}
+	}) : null, children)));
 });
 Coachmark.Content = CoachmarkContent;
 Coachmark.Content.Header = ContentHeader;
 Coachmark.Content.Body = ContentBody;
 Coachmark.displayName = componentName;
 Coachmark.propTypes = {
+	/**
+	* Where to render the Coachmark relative to its target.
+	*/
 	align: PropTypes.string,
+	/**
+	* Specify whether a caret should be rendered on the popover. This is intended to use only for coachmark patterns.
+	*/
 	caret: PropTypes.bool,
+	/**
+	* Provide the contents of the CoachmarkV2.
+	*/
 	children: PropTypes.node.isRequired,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* Specify whether a drop shadow should be rendered on the popover.
+	*/
 	dropShadow: PropTypes.bool,
+	/**
+	* Specifies whether the component is floating or not.
+	*/
 	floating: PropTypes.bool,
+	/**
+	* Specify whether the component should be rendered on high-contrast.
+	*/
 	highContrast: PropTypes.bool,
+	/**
+	* Function to call when the close button is clicked.
+	*/
 	onClose: PropTypes.func,
+	/**
+	* Specifies whether the component is currently open.
+	*/
 	open: PropTypes.bool,
+	/**
+	* Fine tune the position of the target in pixels. Applies only to Beacons.
+	*/
 	position: PropTypes.shape({
 		x: PropTypes.number,
 		y: PropTypes.number
 	}),
-	selectorPrimaryFocus: PropTypes.string
+	/**
+	* CSS selector for the element that should receive focus when the coachmark opens.
+	*/
+	selectorPrimaryFocus: PropTypes.string,
+	/**
+	* Optional ref for an external trigger element, used when the trigger is not part of the coachmark.
+	*/
+	triggerRef: PropTypes.shape({ current: PropTypes.any })
 };
-
 //#endregion
-export { Coachmark };
+export { Coachmark };

package/es/components/Coachmark/next/Coachmark/CoachmarkBeacon/CoachmarkBeacon.js

@@ -12,7 +12,6 @@ import { getDevtoolsProps } from "../../../../../global/js/utils/devtools.js";
 import React, { forwardRef } from "react";
 import PropTypes from "prop-types";
 import { Button } from "@carbon/react";
-
 //#region src/components/Coachmark/next/Coachmark/CoachmarkBeacon/CoachmarkBeacon.tsx
 /**
 * Copyright IBM Corp. 2024, 2025
@@ -50,18 +49,33 @@ const CoachmarkBeacon = forwardRef((props, ref) => {
 });
 CoachmarkBeacon.displayName = componentName;
 CoachmarkBeacon.propTypes = {
+	/**
+	* button props
+	*/
 	buttonProps: PropTypes.shape({
+		/**@ts-ignore*/
 		...Button.propTypes,
+		/**@ts-ignore*/
 		id: PropTypes.string,
 		onClick: PropTypes.func,
 		onDoubleClick: PropTypes.func,
 		tabIndex: PropTypes.number,
 		["aria-expanded"]: PropTypes.bool
 	}),
+	/**
+	* Optional class name for this component.
+	*/
 	className: PropTypes.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: PropTypes.oneOf(["default"]),
+	/**
+	* The aria label.
+	*/
 	label: PropTypes.string.isRequired
 };
-
 //#endregion
-export { CoachmarkBeacon };
+export { CoachmarkBeacon };

package/es/components/Coachmark/next/Coachmark/CoachmarkContent.js

@@ -12,7 +12,6 @@ import { CoachmarkContext, blockClass } from "./context.js";
 import React, { forwardRef, useContext, useEffect, useRef } from "react";
 import PropTypes from "prop-types";
 import { PopoverContent } from "@carbon/react";
-
 //#region src/components/Coachmark/next/Coachmark/CoachmarkContent.tsx
 /**
 * Copyright IBM Corp. 2024, 2026
@@ -82,9 +81,15 @@ const CoachmarkContent = forwardRef((props, ref) => {
 	}, children);
 });
 CoachmarkContent.propTypes = {
+	/**
+	* This is a required callback that has to return the content to render in the body section.
+	* It can be a single child or an array of children depending on your need
+	*/
 	children: PropTypes.node,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string
 };
-
 //#endregion
-export { CoachmarkContent as default };
+export { CoachmarkContent as default };

package/es/components/Coachmark/next/Coachmark/CoachmarkTagline/CoachmarkTagline.js

@@ -13,7 +13,6 @@ import React from "react";
 import PropTypes from "prop-types";
 import { Button } from "@carbon/react";
 import { Close, Idea } from "@carbon/react/icons";
-
 //#region src/components/Coachmark/next/Coachmark/CoachmarkTagline/CoachmarkTagline.tsx
 /**
 * Copyright IBM Corp. 2025
@@ -57,19 +56,35 @@ const CoachmarkTagline = React.forwardRef(({ closeIconDescription = defaults.clo
 });
 CoachmarkTagline.displayName = componentName;
 CoachmarkTagline.propTypes = {
+	/**
+	* button props
+	*/
 	buttonProps: PropTypes.shape({
+		/**@ts-ignore*/
 		...Button.propTypes,
+		/**@ts-ignore*/
 		id: PropTypes.string,
 		onClick: PropTypes.func,
 		onDoubleClick: PropTypes.func,
 		tabIndex: PropTypes.number,
 		["aria-expanded"]: PropTypes.bool
 	}),
+	/**
+	* Optional class name for this component.
+	*/
 	className: PropTypes.string,
+	/**
+	* Tooltip text and aria label for the Close button icon.
+	*/
 	closeIconDescription: PropTypes.string,
+	/**
+	* Function to call when the close button is clicked.
+	*/
 	onClose: PropTypes.func,
+	/**
+	* The title of the tagline.
+	*/
 	title: PropTypes.string.isRequired
 };
-
 //#endregion
-export { CoachmarkTagline };
+export { CoachmarkTagline };

package/es/components/Coachmark/next/Coachmark/ContentBody.js

@@ -10,7 +10,6 @@ import { require_classnames } from "../../../../node_modules/classnames/index.js
 import { blockClass } from "./context.js";
 import React, { forwardRef } from "react";
 import PropTypes from "prop-types";
-
 //#region src/components/Coachmark/next/Coachmark/ContentBody.tsx
 /**
 * Copyright IBM Corp. 2024, 2025
@@ -28,9 +27,15 @@ const ContentBody = forwardRef((props, ref) => {
 	}, children);
 });
 ContentBody.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: PropTypes.node.isRequired,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string
 };
-
 //#endregion
-export { ContentBody as default };
+export { ContentBody as default };

package/es/components/Coachmark/next/Coachmark/ContentHeader.js

@@ -14,7 +14,6 @@ import React, { forwardRef, useContext, useEffect, useRef } from "react";
 import PropTypes from "prop-types";
 import { Button } from "@carbon/react";
 import { Close, Draggable } from "@carbon/react/icons";
-
 //#region src/components/Coachmark/next/Coachmark/ContentHeader.tsx
 /**
 * Copyright IBM Corp. 2024, 2026
@@ -94,11 +93,22 @@ const ContentHeader = forwardRef((props, ref) => {
 	}));
 });
 ContentHeader.propTypes = {
+	/**
+	* Optional contents of the Coachmark Header.
+	*/
 	children: PropTypes.node,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* Tooltip text and aria label for the Close button icon.
+	*/
 	closeIconDescription: PropTypes.string,
+	/**
+	* Tooltip text and aria label for the Drag button icon.
+	*/
 	dragIconDescription: PropTypes.string
 };
-
 //#endregion
-export { ContentHeader };
+export { ContentHeader };

package/es/components/Coachmark/next/Coachmark/context.js

@@ -7,7 +7,6 @@
 
 import { pkg } from "../../../../settings.js";
 import { createContext } from "react";
-
 //#region src/components/Coachmark/next/Coachmark/context.ts
 /**
 * Copyright IBM Corp. 2025
@@ -29,6 +28,5 @@ const CoachmarkContext = createContext({
 	floating: false
 });
 const blockClass = `${pkg.prefix}--coachmark__next`;
-
 //#endregion
-export { CoachmarkContext, blockClass };
+export { CoachmarkContext, blockClass };

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

@@ -5,16 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import { COACHMARK_ALIGNMENT, COACHMARK_OVERLAY_KIND } from "./enums.js";
-
+import "./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 !== COACHMARK_OVERLAY_KIND.TOOLTIP) switch (coachmark.align) {
-		case COACHMARK_ALIGNMENT.TOP:
+	if (kind !== "tooltip") switch (coachmark.align) {
+		case "top":
 			left = width / 2;
 			break;
-		case COACHMARK_ALIGNMENT.TOP_LEFT:
+		case "top-left":
 			left = distanceOffset;
 			break;
-		case COACHMARK_ALIGNMENT.TOP_RIGHT:
+		case "top-right":
 			left = width - distanceOffset;
 			break;
-		case COACHMARK_ALIGNMENT.BOTTOM:
+		case "bottom":
 			top = height;
 			left = width / 2;
 			break;
-		case COACHMARK_ALIGNMENT.BOTTOM_LEFT:
+		case "bottom-left":
 			top = height;
 			left = distanceOffset;
 			break;
-		case COACHMARK_ALIGNMENT.BOTTOM_RIGHT:
+		case "bottom-right":
 			top = height;
 			left = width - distanceOffset;
 			break;
-		case COACHMARK_ALIGNMENT.LEFT:
+		case "left":
 			top = height / 2;
 			break;
-		case COACHMARK_ALIGNMENT.LEFT_TOP:
+		case "left-top":
 			top = distanceOffset;
 			break;
-		case COACHMARK_ALIGNMENT.LEFT_BOTTOM:
+		case "left-bottom":
 			top = height - distanceOffset;
 			break;
-		case COACHMARK_ALIGNMENT.RIGHT:
+		case "right":
 			top = height / 2;
 			left = width;
 			break;
-		case COACHMARK_ALIGNMENT.RIGHT_TOP:
+		case "right-top":
 			top = distanceOffset;
 			left = width;
 			break;
-		case COACHMARK_ALIGNMENT.RIGHT_BOTTOM:
+		case "right-bottom":
 			top = height - distanceOffset;
 			left = width;
 			break;
@@ -75,6 +68,5 @@ const getOffsetTune = (coachmark, kind) => {
 		left
 	};
 };
-
 //#endregion
-export { getOffsetTune };
+export { getOffsetTune };

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

@@ -6,12 +6,10 @@
  */
 
 import { createContext, useContext } from "react";
-
 //#region src/components/Coachmark/utils/context.ts
 const CoachmarkContext = createContext(null);
 const useCoachmark = () => {
 	return useContext(CoachmarkContext);
 };
-
 //#endregion
-export { CoachmarkContext, useCoachmark };
+export { CoachmarkContext, useCoachmark };

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

@@ -52,6 +52,5 @@ let COACHMARK_ALIGNMENT = /* @__PURE__ */ function(COACHMARK_ALIGNMENT) {
 	COACHMARK_ALIGNMENT["TOP_RIGHT"] = "top-right";
 	return COACHMARK_ALIGNMENT;
 }({});
-
 //#endregion
-export { BEACON_KIND, COACHMARK_ALIGNMENT, COACHMARK_OVERLAY_KIND };
+export { BEACON_KIND, COACHMARK_ALIGNMENT, COACHMARK_OVERLAY_KIND };

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

@@ -6,9 +6,8 @@
  */
 
 import { useIsomorphicEffect } from "../../../global/js/hooks/useIsomorphicEffect.js";
-import { COACHMARK_OVERLAY_KIND } from "./enums.js";
+import "./enums.js";
 import { useEffect, useRef } from "react";
-
 //#region src/components/Coachmark/utils/hooks.js
 /**
 * Copyright IBM Corp. 2024
@@ -25,7 +24,7 @@ import { useEffect, useRef } from "react";
 */
 function useClickOutsideElement(coachmarkRef, overlayRef, overlayKind, callback) {
 	const cb = useRef(void 0);
-	const isTooltip = overlayKind === COACHMARK_OVERLAY_KIND.TOOLTIP;
+	const isTooltip = overlayKind === "tooltip";
 	useIsomorphicEffect(() => {
 		cb.current = callback;
 	}, [callback]);
@@ -63,6 +62,5 @@ const useWindowEvent = (eventName, callback) => {
 		};
 	}, [eventName]);
 };
-
 //#endregion
-export { useClickOutsideElement, useWindowEvent };
+export { useClickOutsideElement, useWindowEvent };

package/es/components/CoachmarkBeacon/CoachmarkBeacon.js

@@ -12,7 +12,6 @@ import { getDevtoolsProps } from "../../global/js/utils/devtools.js";
 import React from "react";
 import PropTypes from "prop-types";
 import { Button } from "@carbon/react";
-
 //#region src/components/CoachmarkBeacon/CoachmarkBeacon.tsx
 var import_classnames = /* @__PURE__ */ __toESM(require_classnames());
 const blockClass = `${pkg.prefix}--coachmark-beacon`;
@@ -50,17 +49,32 @@ CoachmarkBeacon.deprecated = {
 };
 CoachmarkBeacon.displayName = componentName;
 CoachmarkBeacon.propTypes = {
+	/**
+	* button props
+	*/
 	buttonProps: PropTypes.shape({
+		/**@ts-ignore*/
 		...Button.propTypes,
+		/**@ts-ignore*/
 		onClick: PropTypes.func,
 		onDoubleClick: PropTypes.func,
 		tabIndex: PropTypes.number,
 		["aria-expanded"]: PropTypes.bool
 	}),
+	/**
+	* Optional class name for this component.
+	*/
 	className: PropTypes.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: PropTypes.oneOf(["default"]),
+	/**
+	* The aria label.
+	*/
 	label: PropTypes.string.isRequired
 };
-
 //#endregion
-export { CoachmarkBeacon };
+export { CoachmarkBeacon };

package/es/components/CoachmarkButton/CoachmarkButton.js

@@ -13,7 +13,6 @@ import { useCoachmark } from "../Coachmark/utils/context.js";
 import React from "react";
 import PropTypes from "prop-types";
 import { Button } from "@carbon/react";
-
 //#region src/components/CoachmarkButton/CoachmarkButton.tsx
 /**
 * Copyright IBM Corp. 2023, 2025
@@ -48,9 +47,14 @@ CoachmarkButton.deprecated = {
 };
 CoachmarkButton.displayName = componentName;
 CoachmarkButton.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* The aria label.
+	*/
 	label: PropTypes.string.isRequired
 };
-
 //#endregion
-export { CoachmarkButton };
+export { CoachmarkButton };

package/es/components/CoachmarkFixed/CoachmarkFixed.js

@@ -11,14 +11,13 @@ import { pkg } from "../../settings.js";
 import { useIsomorphicEffect } from "../../global/js/hooks/useIsomorphicEffect.js";
 import { usePrefersReducedMotion } from "../../global/js/hooks/usePrefersReducedMotion.js";
 import { getDevtoolsProps } from "../../global/js/utils/devtools.js";
-import { COACHMARK_OVERLAY_KIND } from "../Coachmark/utils/enums.js";
+import "../Coachmark/utils/enums.js";
 import { CoachmarkContext } from "../Coachmark/utils/context.js";
 import { CoachmarkOverlay } from "../Coachmark/CoachmarkOverlay.js";
 import { CoachmarkTagline } from "../Coachmark/CoachmarkTagline.js";
 import React, { useCallback, useEffect, useRef, useState } from "react";
 import PropTypes from "prop-types";
 import { createPortal } from "react-dom";
-
 //#region src/components/CoachmarkFixed/CoachmarkFixed.tsx
 /**
 * Copyright IBM Corp. 2023, 2024
@@ -122,7 +121,7 @@ const CoachmarkFixed = React.forwardRef(({ children, className, onClose = defaul
 	}), isOpen && portalNode?.current && createPortal(/* @__PURE__ */ React.createElement(CoachmarkOverlay, {
 		ref: overlayRef,
 		fixedIsVisible,
-		kind: COACHMARK_OVERLAY_KIND.FIXED,
+		kind: "fixed",
 		onClose: handleClose,
 		onTransitionEnd: handleTransitionEnd,
 		theme,
@@ -136,14 +135,41 @@ CoachmarkFixed.deprecated = {
 };
 CoachmarkFixed.displayName = componentName;
 CoachmarkFixed.propTypes = {
+	/**
+	* CoachmarkFixed should use a single CoachmarkOverlayElements component as a child.
+	*/
 	children: PropTypes.node.isRequired,
+	/**
+	* Optional class name for this component.
+	*/
 	className: PropTypes.string,
+	/**
+	* Tooltip text and aria label for the Close button icon.
+	*/
 	closeIconDescription: PropTypes.string,
+	/**
+	* Function to call when the Coachmark closes.
+	*/
 	onClose: PropTypes.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: PropTypes.string,
+	/**
+	* The tagline title which will be fixed to the bottom right of the window and will serve as the display trigger.
+	*/
 	tagline: PropTypes.string.isRequired,
+	/**
+	* Determines the theme of the component.
+	*/
 	theme: PropTypes.oneOf(["light", "dark"])
 };
-
 //#endregion
-export { CoachmarkFixed };
+export { CoachmarkFixed };