@carbon/ibm-products/lib/components/TooltipTrigger/TooltipTrigger.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 settings = require('../../settings.js');

// The block part of our conventional BEM class names (blockClass__E--M).
const blockClass = `${settings.pkg.prefix}--tooltip-trigger`;
const componentName = 'TooltipTrigger';

// NOTE: the component SCSS is not imported here: it is rolled up separately.

/**
 * This is an tooltip trigger as Carbon Tooltip requires an active element to work but provides
 * no blanked button.
 */
exports.TooltipTrigger = /*#__PURE__*/React.forwardRef((_ref, ref) => {
  let {
    children,
    className,
    // Collect any other property values passed in.
    ...rest
  } = _ref;
  return /*#__PURE__*/React.createElement("button", _rollupPluginBabelHelpers.extends({
    type: "button",
    ref: ref
  }, rest, {
    className: cx(blockClass,
    // Apply the block class to the main HTML element
    className // Apply any supplied class names to the main HTML element.
    )
  }), children);
});

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

// The display name of the component, used by React. Note that displayName
// is used in preference to relying on function.name.
exports.TooltipTrigger.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.TooltipTrigger.propTypes = {
  /**
   * Child content of tooltip trigger
   */
  children: index.default.node,
  /**
   * Provide an optional class to be applied to the containing node.
   */
  className: index.default.string
};