@carbon/ibm-products/lib/components/BigNumbers/BigNumbersSkeleton.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');
var react = require('@carbon/react');
var constants = require('./constants.js');

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

/**
 * SkeletonBigNumbers is used to display a skeleton version while
 * content is loading (handled by the BigNumbers prop `loading').
 *
 * Note: This component is only used within BigNumbers.
 */

// Use the same properties and values as parent BigNumbersProps

const BigNumbersSkeleton = /*#__PURE__*/React.forwardRef((_ref, ref) => {
  let {
    className,
    size,
    ...rest
  } = _ref;
  const bigNumbersSkeletonClasses = cx(className, blockClass, {
    [`${blockClass}--lg`]: size === constants.BigNumbersSize.Large,
    [`${blockClass}--xl`]: size === constants.BigNumbersSize.XLarge
  });
  return /*#__PURE__*/React.createElement("div", _rollupPluginBabelHelpers.extends({}, rest, {
    className: bigNumbersSkeletonClasses,
    ref: ref
  }, devtools.getDevtoolsProps(componentName)), /*#__PURE__*/React.createElement(react.SkeletonText, {
    className: `${blockClass}__label`
  }), /*#__PURE__*/React.createElement(react.SkeletonText, {
    heading: true,
    className: `${blockClass}__value`,
    width: "80%"
  }));
});

// The display name of the component, used by React. Note that displayName
// is used in preference to relying on function.name.
BigNumbersSkeleton.displayName = componentName;
BigNumbersSkeleton.propTypes = {
  /**
   * Provide an optional class to be applied to the containing node.
   */
  className: index.default.string,
  /**
   *
   */
  size: index.default.oneOf([constants.BigNumbersSize.Default, constants.BigNumbersSize.Large, constants.BigNumbersSize.XLarge])
};

exports.BigNumbersSkeleton = BigNumbersSkeleton;