@carbon/ibm-products/lib/components/Guidebanner/GuidebannerElement.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.
 */

'use strict';

var _rollupPluginBabelHelpers = require('../../_virtual/_rollupPluginBabelHelpers.js');
var React = require('react');
var index = require('../../_virtual/index.js');
var cx = require('classnames');
var devtools = require('../../global/js/utils/devtools.js');
var settings = require('../../settings.js');

// The block part of our conventional BEM class names (blockClass__E--M).
const blockClass = `${settings.pkg.prefix}--guidebanner__element`;
const componentName = 'GuidebannerElement';
/**
 * The GuidebannerElement is a required child component of the Guidebanner,
 * and acts as a container for a CarouselItem.
 */
exports.GuidebannerElement = /*#__PURE__*/React.forwardRef((_ref, ref) => {
  let {
    button,
    className,
    description,
    title,
    ...rest
  } = _ref;
  return /*#__PURE__*/React.createElement("div", _rollupPluginBabelHelpers.extends({}, rest, {
    className: cx(blockClass, className),
    ref: ref
  }, devtools.getDevtoolsProps(componentName)), title && /*#__PURE__*/React.createElement("h2", {
    className: `${blockClass}-title`
  }, title), description && /*#__PURE__*/React.createElement("p", {
    className: `${blockClass}-content`
  }, description), button && /*#__PURE__*/React.createElement("div", {
    className: `${blockClass}-buttons`
  }, button));
});

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

// The display name of the component, used by React. Note that displayName
// is used in preference to relying on function.name.
exports.GuidebannerElement.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.
exports.GuidebannerElement.propTypes = {
  /**
   * An optional button can be rendered below the description.
   * This can be a link, button, Coachmark button, etc.
   */
  button: index.default.node,
  /**
   * Provide an optional class to be applied to the containing node.
   */
  className: index.default.string,
  /**
   * The description of the element.
   */

  description: index.default.oneOfType([index.default.string, index.default.node]).isRequired,
  /**
   * The title of the element.
   */
  title: index.default.string
};