Skip to main content

Interface: StatusBadgeProperties

Defined in: src/components/common/StatusBadge.tsx:58

Props for the StatusBadge component

Hierarchy​

View Summary

Extends​

Properties​

children?​

readonly optional children?: ReactNode;

Defined in: shared/types/componentProps.ts:36

Component content (text, elements, or other components)

Inherited from​

CoreComponentProperties.children

className?​

readonly optional className?: string;

Defined in: shared/types/componentProps.ts:38

Additional CSS classes for styling customization

Inherited from​

CoreComponentProperties.className

disabled?​

readonly optional disabled?: boolean;

Defined in: shared/types/componentProps.ts:40

Whether the component is disabled and non-interactive

Inherited from​

CoreComponentProperties.disabled

formatter?​

readonly optional formatter?: (label: string, status: "degraded" | "down" | "paused" | "pending" | "up") => string;

Defined in: src/components/common/StatusBadge.tsx:60

Optional custom formatter for label and status display

Parameters​

label​

string

status​

"degraded" | "down" | "paused" | "pending" | "up"

Returns​

string

label​

readonly label: string;

Defined in: src/components/common/StatusBadge.tsx:66

Label text to display (expected to be localized by caller)

Example​

(Status, "Current State", "Monitor Status");

showIcon?​

readonly optional showIcon?: boolean;

Defined in: src/components/common/StatusBadge.tsx:68

Whether to show the status icon

size?​

readonly optional size?: "lg" | "sm" | "xs" | "xl" | "base" | "2xl" | "3xl" | "4xl";

Defined in: src/components/common/StatusBadge.tsx:70

Text size (affects both text and icon sizing)

status​

readonly status: "degraded" | "down" | "paused" | "pending" | "up";

Defined in: src/components/common/StatusBadge.tsx:80

Current status to display