liber-salti
Version:
Saltí - Liber Design System
40 lines (39 loc) • 974 B
TypeScript
/// <reference types="react" />
export declare type BaseBadgeColor = 'primary' | 'error';
export interface BaseAnchorOrigin {
vertical: 'bottom' | 'top';
horizontal: 'left' | 'right';
}
export interface BadgeProps {
/**
* Badge label
*/
content?: number | string;
/**
* Variant of badge style
*/
variant?: 'standard' | 'dot';
/**
* The color of the badge
*/
color?: BaseBadgeColor | 'primary-light';
/**
* The badge will be added relative to this node.
*/
children?: JSX.Element;
/**
* If true, the badge is invisible.
*/
invisible?: boolean;
/**
* The anchor of the badge.
*/
anchorOrigin?: {
vertical: 'center' | BaseAnchorOrigin['vertical'];
horizontal: BaseAnchorOrigin['horizontal'];
};
/**
* Wrapped shape the badge should overlap.
*/
overlap?: 'circular' | 'rectangular';
}