@geneui/components
Version:
The Gene UI components library designed for BI tools
37 lines (36 loc) • 935 B
TypeScript
import { ReactNode, FC, HTMLAttributes } from 'react';
import './Badge.scss';
interface IBadgeProps extends HTMLAttributes<HTMLDivElement> {
/**
* Any custom class name
*/
className?: string;
/**
* Badge size <br/>
* Possible values: `default | medium | big | huge`
*/
size?: 'default' | 'medium' | 'big' | 'huge';
/**
* Badge color <br/>
* Possible values: `danger | primary`
*/
color?: 'danger' | 'primary';
/**
* Shows the specified number on the badge
*/
count?: number;
/**
* Set this property to have only dot instead of number
*/
dot?: boolean;
/**
* When the "count" is greater than "maxCount" Badge will show "maxCount" value and "+"
*/
maxCount?: number;
/**
* Any valid React node
*/
children?: ReactNode;
}
declare const Badge: FC<IBadgeProps>;
export { IBadgeProps, Badge as default };