Skip to content
Design System
GitHub

ISA-18.2 alarms: three priorities with their own shape, colour and words, acknowledge and clear states, and a sorted list that announces new alarms to screen readers.

API reference

Generated from the types. Every part also takes className.

Alarm

Also takes every prop of AlarmData (except id).

source
stringThe robot, sensor or system that raised it.
time
stringWhen it was raised, already formatted by the app: "14:02:31". Shown first, in tabular figures.
titlerequired
stringWhat happened and where: "Collision risk · Hall B".
priorityrequired
"critical" | "high" | "low"
activerequired
booleanThe condition is still present.
acknowledgedrequired
booleanAn operator has acknowledged it.
acknowledgedAt
stringWhen it was acknowledged, already formatted: "13:42". Shown as "Acknowledged 13:42".
clearedAt
stringWhen the condition cleared, already formatted ("14:07"). Shown while a cleared alarm waits for acknowledgement.
shelvedUntil
stringShelved by an operator until this time, already formatted ("15:30"). A shelved alarm is out of the live list and silent; the app clears this field when the time comes, and the alarm returns. Critical alarms cannot be shelved.
suppressed
booleanSuppressed by design: the app's logic says it does not apply now (a docked robot's "not moving"). Counted, not shown.
outOfService
booleanOut of service: taken off for maintenance by an authorised person. Counted, not shown.
raisedAt
numberWhen it was raised, in ms since the epoch. Needed only for flood detection.
onAcknowledge
() => voidShown while unacknowledged. Without it the alarm is read-only (for viewers).
onShelve
() => voidShows "Shelve" (not on critical alarms). The app asks how long, then sets shelvedUntil.
onUnshelve
() => voidShows "Unshelve" on a shelved alarm.
action
{ label: string; onClick: () => void; }The corrective action, e.g. "Open camera".
labels
Partial<AlarmLabels>

AlarmAnnouncer

announcerequired
{ assertive: string; polite: string; }

AlarmList

alarmsrequired
AlarmData[]
onAcknowledge
(id: string) => void
onAcknowledgeAll
(ids: string[]) => void"Acknowledge all" in the header: only when you pass it, since a product may require every alarm to be read and acknowledged on its own. Shown while two or more alarms it may take are unacknowledged and in view. It is called with those ids only: never a critical alarm (each is acknowledged on its own row), never shelved, suppressed or out-of-service ones, and the low alarms folded in a flood only while their group is open.
onShelve
(id: string) => void
onUnshelve
(id: string) => void
labels
Partial<AlarmLabels> & { title?: string; summary?: (active: number, unacknowledged: number) => string; none?: string; acknowledgeAll?: string; acknowledgeShown?: (count: number) => string; acknowledgeNonCritical?: (count: number) => string; acknowledgedCount?: (count: number) => string; shelvedGroup?: (count: number) => string; hidden?: (suppressed: number, outOfService: number) => string; flood?: (count: number, minutes: number) => string; lowGroup?: (count: number) => string; many?: (count: number) => string; loading?: string; errorEmpty?: string; errorStale?: string; updatedAt?: (time: string) => string; retry?: string; }
flood
{ count: number; minutes: number; } = { count: 10, minutes: 10 }More than count alarms raised within minutes is a flood (ISA-18.2: over 10 in 10 minutes per operator). The list says so, keeps critical and high on top and folds low alarms into one row. Needs raisedAt on the alarms.
now
numberThe current time in ms, for flood detection. Defaults to the clock; pass it to make a story or test stable.
feedback
boolean = trueBuzz and sound for a new critical or high alarm (the feedback patterns). On by default; turn off where the list is a record, not a live feed.
status
"ready" | "loading" | "error" = "ready"Where the alarms come from. "loading": rows held by placeholders, never "No active alarms". "error": the list says it could not load or update, keeps the alarms it already has (an old list beats an empty one), and offers onRetry.
onRetry
() => void
updatedAt
stringWhen the alarms were last loaded, shown with an error: "Last updated 13:42".