Interface BadgeProps

interface BadgeProps {
    children?: ReactNode;
    className?: string;
    classNames?: {
        indicator?: string;
        root?: string;
    };
    color?: LiteralUnion<"blue" | "cyan" | "gold" | "green" | "lime" | "magenta" | "orange" | "pink" | "purple" | "red" | "yellow" | "volcano" | "geekblue">;
    count?: ReactNode;
    dot?: boolean;
    offset?: [string | number, string | number];
    overflowCount?: number;
    prefixCls?: string;
    rootClassName?: string;
    scrollNumberPrefixCls?: string;
    showZero?: boolean;
    size?: "default" | "small";
    status?: "default" | "error" | "success" | "warning" | "processing";
    style?: CSSProperties;
    styles?: {
        indicator?: CSSProperties;
        root?: CSSProperties;
    };
    text?: ReactNode;
    title?: string;
}

Properties

children? className? classNames? color? count? dot? offset? overflowCount? prefixCls? rootClassName? scrollNumberPrefixCls? showZero? size? status? style? styles? text? title?

Properties

Optional children

children?: ReactNode

Optional className

className?: string

Optional classNames

classNames?: {
    indicator?: string;
    root?: string;
}

Type declaration

  • Optional indicator?: string
  • Optional root?: string

Optional color

color?: LiteralUnion<"blue" | "cyan" | "gold" | "green" | "lime" | "magenta" | "orange" | "pink" | "purple" | "red" | "yellow" | "volcano" | "geekblue">

Optional count

count?: ReactNode

Number to show in badge

Optional dot

dot?: boolean

Whether to show red dot without number

Optional offset

offset?: [string | number, string | number]

Optional overflowCount

overflowCount?: number

Max count to show

Optional prefixCls

prefixCls?: string

Optional rootClassName

rootClassName?: string

Optional scrollNumberPrefixCls

scrollNumberPrefixCls?: string

Optional showZero

showZero?: boolean

Optional size

size?: "default" | "small"

Optional status

status?: "default" | "error" | "success" | "warning" | "processing"

Optional style

style?: CSSProperties

Optional styles

styles?: {
    indicator?: CSSProperties;
    root?: CSSProperties;
}

Type declaration

  • Optional indicator?: CSSProperties
  • Optional root?: CSSProperties

Optional text

text?: ReactNode

Optional title

title?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc