@stratakit/bricks
Version:
Small, modular components for StrataKit
29 lines (28 loc) • 868 B
TypeScript
import type { BaseProps } from "@stratakit/foundations/secret-internals";
interface BadgeProps extends Omit<BaseProps<"span">, "children"> {
/**
* The label displayed inside the badge.
*/
label: React.ReactNode;
/**
* The tone of the badge.
* @default "neutral"
*/
tone?: "neutral" | "info" | "positive" | "attention" | "critical" | "accent";
/**
* The variant style of the badge.
* @default "solid"
*/
variant?: "solid" | "muted" | "outline";
}
/**
* A badge component, typically used to designate the status of an item.
*
* Example:
* ```tsx
* <Badge label="Value" />
* <Badge label="Value" tone="info" variant="outline" />
* ```
*/
declare const Badge: import("react").ForwardRefExoticComponent<BadgeProps & import("react").RefAttributes<HTMLElement | HTMLSpanElement>>;
export default Badge;