UNPKG

621 BTypeScriptView Raw
1import * as React from "react";
2import { BoxProps } from "../Box";
3
4export interface IBadge {
5 /**
6 * The color scheme of the badge
7 *
8 * 🚨Note: This should be one of the color keys in the theme that has `100` - `900` color values (e.g.`green`, `red`).
9 * @see http://chakra-ui.com/theme#colors
10 */
11 variantColor?: string;
12 /**
13 * The variant of the badge
14 */
15 variant?: "solid" | "subtle" | "outline";
16}
17
18export type BadgeProps = IBadge & BoxProps;
19
20/**
21 * The Badge component is used for state, general text, and number labels.
22 */
23declare const Badge: React.FC<BadgeProps>;
24
25export default Badge;