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

Carbon for IBM Products

/**
 * Copyright IBM Corp. 2020, 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.
 */

import { extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
import React__default from 'react';
import PropTypes from '../../_virtual/index.js';
import cx from 'classnames';
import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
import { pkg } from '../../settings.js';

// The block part of our conventional BEM class names (blockClass__E--M).
const blockClass = `${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.
 */
let CoachmarkOverlayElement = /*#__PURE__*/React__default.forwardRef((_ref, ref) => {
  let {
    button,
    className,
    description,
    title,
    // Collect any other property values passed in.
    ...rest
  } = _ref;
  return /*#__PURE__*/React__default.createElement("div", _extends({}, rest, {
    className: cx(blockClass,
    // Apply the block class to the main HTML element
    className,
    // Apply any supplied class names to the main HTML element.
    // example: `${blockClass}__template-string-class-${kind}-n-${size}`,
    {
      // switched classes dependant on props or state
      // example: [`${blockClass}__here-if-small`]: size === 'sm',
    }),
    ref: ref
  }, 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));
});

// Return a placeholder if not released and not enabled by feature flag
CoachmarkOverlayElement = pkg.checkComponentEnabled(CoachmarkOverlayElement, componentName);

// The display name of the component, used by React. Note that displayName
// is used in preference to relying on function.name.
CoachmarkOverlayElement.displayName = componentName;

// The types and DocGen commentary for the component props,
// in alphabetical order (for consistency).
// See https://www.npmjs.com/package/prop-types#usage.
CoachmarkOverlayElement.propTypes = {
  /**
   * An optional button can be rendered below the description.
   * This can be a link, button, Coachmark button, etc.
   */
  button: PropTypes.node,
  /**
   * Optional class name for this component.
   */
  className: PropTypes.string,
  /**
   * The description of the Coachmark.
   */
  description: PropTypes.node.isRequired,
  /**
   * The title of the Coachmark.
   */
  title: PropTypes.string.isRequired
};

export { CoachmarkOverlayElement };