beta-parity-react/ui/Badge/index.d.ts

Beta Parity React Components

import React from 'react';
import './index.css';
import './variables.css';
declare const sizeMap: Record<'xs' | 'sm' | 'md', string>;
/**
 * Props for the Badge component.
 *
 * Extends properties from the `span` element.
 */
export interface BadgeProps extends React.HTMLAttributes<HTMLSpanElement> {
    /**
     * The label text for the badge.
     * If provided, it will display as the main content of the badge.
     *
     * @memberof BadgeProps
     */
    label?: string;
    /**
     * Icon to be displayed alongside the label or content.
     *
     * @memberof BadgeProps
     */
    icon?: React.ReactNode;
    /**
     * Color of the badge.
     *
     * @default 'gray'
     * @memberof BadgeProps
     */
    color?: 'gray' | 'orange' | 'violet' | 'green' | 'red' | 'yellow' | 'blue' | 'lime' | 'cyan';
    /**
     * Size of the badge.
     * Available options are 'md' (medium), 'sm' (small), and 'xs' (extra small).
     *
     * @default 'md'
     * @memberof BadgeProps
     */
    size?: keyof typeof sizeMap;
    /**
     * Whether to display a small dot in the badge.
     * If `true`, a small dot will be rendered (override icon).
     *
     * @default false
     * @memberof BadgeProps
     */
    dot?: boolean;
    /**
     * The variant of the badge.
     *
     * @default 'outlined'
     * @memberof BadgeProps
     */
    variant?: 'outlined' | 'solid' | 'glass';
}
/**
 * **Parity Badge**
 *
 *  @see {@link https://beta-parity-react.vercel.app/badge Parity Badge}
 */
export declare const Badge: React.ForwardRefExoticComponent<BadgeProps & React.RefAttributes<HTMLSpanElement>>;
export {};
//# sourceMappingURL=index.d.ts.map