@carbon/ibm-products/lib/components/CoachmarkButton/CoachmarkButton.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('@carbon/react');
var index = require('../../_virtual/index.js');
var React = require('react');
var cx = require('classnames');
var devtools = require('../../global/js/utils/devtools.js');
var settings = require('../../settings.js');
require('../Coachmark/Coachmark.js');
var context = require('../Coachmark/utils/context.js');

var _div;

// Carbon and package components we use.
/* TODO: @import(s) of carbon components and other package components. */

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

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

// Default values can be included here and then assigned to the prop params,
// e.g. prop = defaults.prop,
// This gathers default values together neatly and ensures non-primitive
// values are initialized early to avoid react making unnecessary re-renders.
// Note that default values are not required for props that are 'required',
// nor for props where the component can apply undefined values reasonably.
// Default values should be provided when the component needs to make a choice
// or assumption when a prop is not supplied.

// Default values for props
// const defaults = {
//   /* TODO: add defaults for relevant props if needed */
// };

/**
 * Use CoachmarkButton for the target prop of a Coachmark component.
 */
exports.CoachmarkButton = /*#__PURE__*/React.forwardRef((_ref, ref) => {
  let {
    className,
    label,
    ...rest
  } = _ref;
  const coachmark = context.useCoachmark();
  if (!coachmark) {
    return _div || (_div = /*#__PURE__*/React.createElement("div", null, "CoachmarkButton is to be use exclusively within the target prop of Coachmark"));
  }
  return /*#__PURE__*/React.createElement(react.Button, _rollupPluginBabelHelpers.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,
    role: "button",
    "aria-label": label
  }, devtools.getDevtoolsProps(componentName), coachmark.buttonProps), label);
});

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

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