import { SizeKeyword } from '../../shared/scales'; import { ToneKeyword } from '../../shared/theming'; import { ColorKeyword } from '../../shared/scales'; import { GlobalProps } from '../../shared/global'; import { ComponentChildren } from '../../shared/children'; import { IconType } from '../../shared/icons'; export interface BadgeProps extends GlobalProps { /** * The content of the Badge. */ children?: ComponentChildren; /** * Sets the tone of the Badge, based on the intention of the information being conveyed. * * @default 'auto' */ tone?: ToneKeyword; /** * Modify the color to be more or less intense. * * @default 'base' */ color?: ColorKeyword; /** * The type of icon to be displayed in the badge. * * @default '' */ icon?: IconType; /** * The position of the icon in relation to the text. */ iconPosition?: 'start' | 'end'; /** * Adjusts the size. * * @default 'base' */ size?: SizeKeyword; }