@carbon/ibm-products/lib/components/CoachmarkOverlayElement/CoachmarkOverlayElement.js

Carbon for IBM Products

/**
 * Copyright IBM Corp. 2020, 2026
 *
 * This source code is licensed under the Apache-2.0 license found in the
 * 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");
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
*
* This source code is licensed under the Apache-2.0 license found in the
* LICENSE file in the root directory of this source tree.
*/
var import_classnames = /* @__PURE__ */ require_runtime.__toESM(require_index.default);
const blockClass = `${require_settings.pkg.prefix}--coachmark-overlay-element`;
const componentName = "CoachmarkOverlayElement";
/**
* Component to be displayed within a CoachmarkOverlayElements container.
* Can be used 1 to N number, to display content in a Coachmark's overlay
* in a carousel fashion.
* @deprecated This component is deprecated.
*/
const CoachmarkOverlayElement = react.default.forwardRef(({ button, className, description, title, ...rest }, ref) => {
	return /* @__PURE__ */ react.default.createElement("div", {
		...rest,
		className: (0, import_classnames.default)(blockClass, className, {}),
		ref,
		...require_devtools.getDevtoolsProps(componentName)
	}, /* @__PURE__ */ react.default.createElement("div", { className: `${blockClass}__content` }, title && /* @__PURE__ */ react.default.createElement("h2", { className: `${blockClass}__title` }, title), description && /* @__PURE__ */ react.default.createElement("p", { className: `${blockClass}__body` }, description)), button && /* @__PURE__ */ react.default.createElement("div", { className: `${blockClass}__button` }, button));
});
/**@ts-ignore*/
CoachmarkOverlayElement.deprecated = {
	level: "warn",
	details: `${componentName} is 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;