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.

Critical: Collision risk · Hall B

14:02:31Patrol dog 7F3A
Unacknowledged

High: Battery 12 %, 9 min left

14:01:05Patrol dog 7F3A
Unacknowledged

Low: Lidar cleaning due

13:40:12Courier 2B19
Unacknowledged

Alarm priorities

Install
npx shadcn add @syncrobotic/alarm

Also installs: lucide-react, @syncrobotic/cn, @syncrobotic/use-presence, @syncrobotic/feedback, @syncrobotic/robot-icons

Overview

Alarms after ISA-18.2: three priorities, each with its own shape, colour and words, acknowledge and clear states, and a sorted list that announces new alarms.

When to use

  • Anything a person must act on: collision risk, e-stop, low battery on a mission.

Use something else

  • Feedback on what the user just did: Toast.
  • A note about the page that needs no action: Alert.

More examples

States and real uses. Each example is also a Storybook story and a visual regression test.

High: Localisation degraded · Floor 3

14:05:44Courier 2B19
Unacknowledged

High: Localisation degraded · Floor 3

14:05:44Courier 2B19
Cleared 14:07, not acknowledged

High: Localisation degraded · Floor 3

14:05:44Courier 2B19
Acknowledged 14:06

High: Wi-Fi weak · Dock 2

13:58:20Courier 2B19
Shelved until 15:30

Alarm states

Critical: Person in restricted zone · Dock 4

14:06:02Patrol dog 7F3A
Unacknowledged

Alarm with action

Alarms

3 active · 2 unacknowledged
  • Critical: Collision risk · Hall B

    14:02:31Patrol dog 7F3A
    Unacknowledged
  • High: Battery 12 %, 9 min left

    14:01:05Patrol dog 7F3A
    Unacknowledged
  • Low: Lidar cleaning due

    13:40:12Courier 2B19
    Acknowledged 13:42
Shelved · 1
  • Low: Map out of date · Floor 2

    13:31:50Courier 5C01
    Shelved until 15:30

1 suppressed by design

Alarm list sorted

Alarms

2 active · 2 unacknowledged
  • Critical: Collision risk · Hall B

    14:02Patrol dog 7F3A
    Unacknowledged
  • High: Wi-Fi weak · Dock 2

    13:58Courier 2B19
    Unacknowledged
Shelved · 1
  • Low: Lidar cleaning due

    13:40Courier 2B19
    Shelved until 15:30

1 suppressed by design · 1 out of service

Alarm list shelved

Alarms

16 active · 16 unacknowledged

Alarm flood: 16 alarms in 10 min. Critical and high first; low alarms are grouped.

  • Critical: Network down · Hall B

    14:09Site
    Unacknowledged
  • High: Lost connection

    14:09Patrol dog 7F3A
    Unacknowledged
14 low alarms
  • Low: Telemetry delayed

    14:09Courier 2B1D
    Unacknowledged
  • Low: Telemetry delayed

    14:09Courier 2B1C
    Unacknowledged
  • Low: Telemetry delayed

    14:09Courier 2B1B
    Unacknowledged
  • Low: Telemetry delayed

    14:09Courier 2B1A
    Unacknowledged
  • Low: Telemetry delayed

    14:09Courier 2B19
    Unacknowledged
  • Low: Telemetry delayed

    14:09Courier 2B18
    Unacknowledged
  • Low: Telemetry delayed

    14:09Courier 2B17
    Unacknowledged
  • Low: Telemetry delayed

    14:09Courier 2B16
    Unacknowledged
  • Low: Telemetry delayed

    14:09Courier 2B15
    Unacknowledged
  • Low: Telemetry delayed

    14:09Courier 2B14
    Unacknowledged
  • Low: Telemetry delayed

    14:09Courier 2B13
    Unacknowledged
  • Low: Telemetry delayed

    14:09Courier 2B12
    Unacknowledged
  • Low: Telemetry delayed

    14:09Courier 2B11
    Unacknowledged
  • Low: Telemetry delayed

    14:09Courier 2B10
    Unacknowledged

Alarm list flood

Alarms

Loading alarms

Alarm list loading

Alarms

2 active · 2 unacknowledged
  • Critical: Network down · Hall B

    14:09Site
    Unacknowledged
  • High: Lost connection

    14:09Patrol dog 7F3A
    Unacknowledged

Alarm list error

Usage rules

  • Only for an abnormal condition that needs an operator to act. No action, no alarm: log it instead.
  • Three priorities, each with its own shape, colour and word: critical (act now), high (act within minutes), low (act when convenient).
  • Stays until the condition clears and someone acknowledges it. Acknowledging records that it was seen; it does not clear it.
  • Never auto-dismissed, never a toast, never blinking, never a tinted row. Colour is only on the glyph and the priority word. Unacknowledged: bold title and a solid bar in the priority's colour. Cleared but not acknowledged: still bold, the bar dashed, and it says when it cleared. Acknowledged: regular and grey, with when (“Acknowledged 13:42”, from acknowledgedAt).
  • Time comes first, in tabular figures, so order and age read down the column. Below 576 px of width the row reflows: the time under the title, the state and buttons on a line of their own.
  • “Acknowledge all” appears only when the app passes onAcknowledgeAll, with two or more alarms it may take in view, and takes only those: never a critical alarm (each is acknowledged on its own row; the button then reads “Acknowledge 3 non-critical”), never shelved, suppressed or out-of-service alarms, and in a flood the folded low ones only while their group is open (“Acknowledge 2 shown”). Screen readers hear how many were acknowledged. Leave it out where every alarm must be read on its own.
  • One alarm per root cause. If the robot is offline, do not also raise camera lost and lidar lost.
  • Shelving hides a nuisance alarm for a set time and it comes back on its own; it is never permanent and never for critical alarms. Suppressed by design (the app's logic) and out of service (maintenance) are counted under the list, not hidden silently.
  • Pass raisedAt so a flood (over 10 alarms in 10 minutes) is named and the low ones fold away; then fix the root cause the flood points to.

Changelog

  • 0.27.02026-11-21Buttons beside Acknowledge (a custom action, Shelve) are ghost, so Acknowledge is the only outlined button in an unacknowledged row. Unshelve, alone in its row, keeps its outline.
  • 0.22.22026-11-20"Acknowledge all" appears only when onAcknowledgeAll is passed (no longer from onAcknowledge alone), and never takes a critical alarm: each is acknowledged on its own row, and while one is unacknowledged the button reads "Acknowledge 3 non-critical" (label acknowledgeNonCritical).
  • 0.22.12026-11-20Low priority is a diamond (DiamondAlert), not a circle: at 20 px the circle read as the critical octagon. AlarmList takes status ("loading" shows placeholder rows and never "No active alarms"; "error" says the list could not load or update, keeps what it has, with onRetry and updatedAt). Labels loading, errorEmpty, errorStale, updatedAt, retry. useAlarmSignals takes ready: alarms that arrive with the first load do not buzz.

How to upgrade