✨ Publier v1 is live — a polished docs platform built for the open web.
Skip to content

StatusIndicator

Inline service-status dot and label — operational, degraded, outage, or maintenance.

The StatusIndicator component from @publier/shell renders a colored status dot with a label — useful on status pages, in the header of a service doc, or inside a changelog entry.

Usage

import { StatusIndicator } from '@publier/shell/components';
<StatusIndicator status="operational" />
<StatusIndicator status="degraded" service="API" />
<StatusIndicator status="maintenance" label="Scheduled maintenance until 22:00 UTC" />

Props

PropTypeDefaultDescription
status'operational' | 'degraded' | 'outage' | 'maintenance'requiredSemantic status level.
labelstringautoOverride label text. When omitted, defaults to a canonical label per status (see below).
servicestringundefinedOptional service name — shown before the label and used in the accessible name.

Default labels

StatusDefault label
operationalOperational
degradedDegraded performance
outageMajor outage
maintenanceUnder maintenance

Behaviour

  • Renders as <span role="status"> — screen readers announce changes politely.
  • The colored dot is marked aria-hidden so the label carries the semantics.
  • Accessible name is built as "{service} {label-lowercased}" when service is set (e.g. "API degraded performance") — so the phrase reads naturally. When service is unset, the label renders verbatim.