antd/es/badge/Badge.d.ts

An enterprise-class UI design language and React components implementation

import * as React from 'react';
import type { PresetStatusColorType } from '../_util/colors';
import type { GenerateSemantic } from '../_util/hooks/useMergeSemantic/semanticType';
import type { LiteralUnion } from '../_util/type';
import type { SizeType } from '../config-provider/SizeContext';
import type { PresetColorKey } from '../theme/internal';
export type BadgeSemanticType = {
    classNames?: {
        root?: string;
        indicator?: string;
    };
    styles?: {
        root?: React.CSSProperties;
        indicator?: React.CSSProperties;
    };
};
export type BadgeSemanticAllType = GenerateSemantic<BadgeSemanticType, BadgeProps>;
export interface BadgeProps extends React.HTMLAttributes<HTMLSpanElement> {
    /** Number to show in badge */
    count?: React.ReactNode;
    showZero?: boolean;
    /** Max count to show */
    overflowCount?: number;
    /** Whether to show red dot without number */
    dot?: boolean;
    style?: React.CSSProperties;
    prefixCls?: string;
    scrollNumberPrefixCls?: string;
    className?: string;
    rootClassName?: string;
    status?: PresetStatusColorType;
    color?: LiteralUnion<PresetColorKey>;
    text?: React.ReactNode;
    /**
     * Note: `default` is deprecated and will be removed in v7, please use `medium` instead.
     */
    size?: Exclude<SizeType, 'large'> | 'default';
    offset?: [number | string, number | string];
    title?: string;
    children?: React.ReactNode;
    classNames?: BadgeSemanticAllType['classNamesAndFn'];
    styles?: BadgeSemanticAllType['stylesAndFn'];
}
declare const Badge: React.ForwardRefExoticComponent<BadgeProps & React.RefAttributes<HTMLSpanElement>>;
export default Badge;