@postenbring/hedwig-react
Version:
React components for [Hedwig Design System](https://github.com/bring/hedwig-design-system).
43 lines • 1.22 kB
TypeScript
export interface BadgeProps extends React.HTMLAttributes<HTMLSpanElement> {
children: React.ReactNode;
/**
* Color of the badge
*
* @deprecated
* @default "lighter"
* "lighter", "darker", and "white" are deprecated and will be removed in a future release.
* Use data-color "neutral", "info", "success", "warning", or "error" instead.
*/
variant?: "lighter"
/** @deprecated */
| "darker"
/** @deprecated */
| "white"
/** @deprecated */
| "warning";
"data-color"?: "neutral" | "info" | "success" | "warning" | "error";
/**
* Font size of the badge
*
* @default "small"
*/
size?: "small" | "smaller";
/**
* Change the default rendered element for the one passed as a child, merging their props and behavior.
*
* @default false
*/
asChild?: boolean;
}
/**
* Badges are used to label, categorize or organize items using keywords to describe them.
*
* @example
*
* ```tsx
* <Badge variant="info">Info</Badge>
* ```
*
*/
export declare const Badge: import("react").ForwardRefExoticComponent<BadgeProps & import("react").RefAttributes<HTMLSpanElement>>;
//# sourceMappingURL=badge.d.ts.map