@hashicorp/design-system-components
Version:
Helios Design System Components
34 lines (33 loc) • 1.42 kB
TypeScript
/**
* Copyright IBM Corp. 2021, 2025
* SPDX-License-Identifier: MPL-2.0
*/
import Component from '@glimmer/component';
import { HdsBadgeColorValues, HdsBadgeSizeValues, HdsBadgeTypeValues } from './types.ts';
import type { HdsBadgeColors, HdsBadgeSizes, HdsBadgeTypes } from './types.ts';
import type { HdsIconSignature } from '../icon/index';
export declare const SIZES: HdsBadgeSizes[];
export declare const TYPES: HdsBadgeTypes[];
export declare const COLORS: HdsBadgeColors[];
export declare const DEFAULT_SIZE = HdsBadgeSizeValues.Medium;
export declare const DEFAULT_TYPE = HdsBadgeTypeValues.Filled;
export declare const DEFAULT_COLOR = HdsBadgeColorValues.Neutral;
export interface HdsBadgeSignature {
Args: {
size?: HdsBadgeSizes;
type?: HdsBadgeTypes;
color?: HdsBadgeColors;
text: string | number;
icon?: HdsIconSignature['Args']['name'];
isIconOnly?: boolean;
};
Element: HTMLDivElement;
}
export default class HdsBadge extends Component<HdsBadgeSignature> {
get size(): "small" | "medium" | "large" | HdsBadgeSizeValues.Medium;
get type(): "filled" | "inverted" | "outlined" | HdsBadgeTypeValues.Filled;
get color(): "highlight" | "success" | "warning" | "critical" | "neutral" | "neutral-dark-mode" | HdsBadgeColorValues.Neutral;
get text(): string | number;
get isIconOnly(): boolean;
get classNames(): string;
}