Skip to main content

Function: getSiteStatusVariant()

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

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

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

Parameters​

status​

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

The SiteStatus value to map.

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": Degraded, mixed, or paused status ("degraded", "mixed", or "paused").
  • "info": Pending status ("pending").

Example​

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