@shopify/polaris
Version:
Shopify’s admin product component library
22 lines (21 loc) • 825 B
TypeScript
/// <reference types="react" />
declare type Status = 'info' | 'success' | 'attention' | 'warning' | 'critical' | 'new';
declare type Progress = 'incomplete' | 'partiallyComplete' | 'complete';
declare type Size = 'small' | 'medium';
export interface BadgeProps {
/** The content to display inside the badge. */
children?: string;
/** Colors and labels the badge with the given status. */
status?: Status;
/** Render a pip showing the progress of a given task. */
progress?: Progress;
/**
* Medium or small size.
* @default 'medium'
*/
size?: Size;
/** Pass a custom accessibilityLabel */
statusAndProgressLabelOverride?: string;
}
export declare function Badge({ children, status, progress, size, statusAndProgressLabelOverride, }: BadgeProps): JSX.Element;
export {};