Skip to main content

Function: getSiteStatusVariant()

getSiteStatusVariant(status: "degraded" | "down" | "mixed" | "paused" | "pending" | "unknown" | "up"): "success" | "error" | "info" | "warning"

Defined in: shared/utils/siteStatus.ts:286

Maps a SiteStatus value to a UI color variant for status indicators.

Parametersโ€‹

statusโ€‹

The SiteStatus value to map.

"degraded" | "down" | "mixed" | "paused" | "pending" | "unknown" | "up"

Returnsโ€‹

"success" | "error" | "info" | "warning"

The color variant: "success", "error", "warning", or "info".

Remarksโ€‹

The returned variant is intended for use in UI components (e.g., badges, icons). - "success": All monitors are healthy ("up").

  • "error": All monitors are down or status is unknown ("down" or "unknown"). - "warning": Mixed or paused status ("mixed" or "paused").
  • "info": Pending status ("pending").

Exampleโ€‹

const color = getSiteStatusVariant("up"); // "success"