@carbon/ibm-products/es/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.
 */

import { extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
import React__default, { forwardRef } 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';
import { SkeletonText } from '@carbon/react';
import { BigNumbersSize } from './constants.js';

// The block part of our conventional BEM class names (blockClass__E--M).
const blockClass = `${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__*/forwardRef((_ref, ref) => {
  let {
    className,
    size,
    ...rest
  } = _ref;
  const bigNumbersSkeletonClasses = cx(className, blockClass, {
    [`${blockClass}--lg`]: size === BigNumbersSize.Large,
    [`${blockClass}--xl`]: size === BigNumbersSize.XLarge
  });
  return /*#__PURE__*/React__default.createElement("div", _extends({}, rest, {
    className: bigNumbersSkeletonClasses,
    ref: ref
  }, getDevtoolsProps(componentName)), /*#__PURE__*/React__default.createElement(SkeletonText, {
    className: `${blockClass}__label`
  }), /*#__PURE__*/React__default.createElement(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: PropTypes.string,
  /**
   *
   */
  size: PropTypes.oneOf([BigNumbersSize.Default, BigNumbersSize.Large, BigNumbersSize.XLarge])
};

export { BigNumbersSkeleton };