@carbon/ibm-products/lib/components/BigNumbers/BigNumbers.d.ts

Carbon for IBM Products

/**
 * Copyright IBM Corp. 2024, 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 React, { ReactNode } from 'react';
import { BigNumbersSizeValues } from './constants';
export interface BigNumbersProps {
    className?: string;
    forceShowTotal?: boolean;
    fractionDigits?: number;
    iconButton?: ReactNode;
    loading?: boolean;
    label: string;
    locale?: string;
    percentage?: boolean;
    size?: BigNumbersSizeValues;
    tooltipDescription?: string;
    total?: number;
    trending?: boolean;
    truncate?: boolean;
    value?: number;
}
/**
 * BigNumbers is used to display large values in a small area. The display of
 * values can be the value itself, or grouped in a `numerator/denominator` fashion.
 * Control over the total fraction decimals displayed as well as how the
 * values/totals are displayed are done via a locale prop. Other optional props
 * allow control over size, truncation, if the value is a percentage, the addition
 * of a button as well as tool tip functionality.
 * The default locale is English (`en-US`) if one is not provided or if the provided one is not supported.
 */
export declare let BigNumbers: React.ForwardRefExoticComponent<BigNumbersProps & React.RefAttributes<HTMLDivElement>>;