Status list

Status list data Sprite

System / check states as an icon + title + caption list — tone rides data-state per row, never colour alone.

Layer: L1 surface · Recipe: unset — see docs/agent/pick-a-surface.md. Curriculum: AGENTS.md; pick matrix: docs/agent/pick-a-surface.md; blast radius: CONSUMER_MAP.md.

  • Payments API
    Operational · 99.99% this month
    positive
  • Webhooks
    Elevated retries since 09:20
    warning
  • Nightly export
    Scheduled 02:00

Copy this

html
<!-- icons: include the icon sheet once per page (see the Setup section, #setup) -->
<div class="status-list-region hm-measure-lg">
  <ul class="status-list" data-entry-count="3">
    <li class="status-list-entry" data-status-entry data-state="positive">
      <span class="status-list-icon" aria-hidden="true"><svg class="icon" aria-hidden="true"><use href="#i-circle-check"/></svg></span>
      <div class="status-list-text">
        <div class="status-list-title">Payments API</div>
        <div class="status-list-caption">Operational · 99.99% this month</div>
      </div>
      <span class="status-list-pill">positive</span>
    </li>
    <li class="status-list-entry" data-status-entry data-state="warning">
      <span class="status-list-icon" aria-hidden="true"><svg class="icon" aria-hidden="true"><use href="#i-triangle-alert"/></svg></span>
      <div class="status-list-text">
        <div class="status-list-title">Webhooks</div>
        <div class="status-list-caption">Elevated retries since 09:20</div>
      </div>
      <span class="status-list-pill">warning</span>
    </li>
    <li class="status-list-entry" data-status-entry data-state="neutral">
      <span class="status-list-icon-spacer" aria-hidden="true"></span>
      <div class="status-list-text">
        <div class="status-list-title">Nightly export</div>
        <div class="status-list-caption">Scheduled 02:00</div>
      </div>
    </li>
  </ul>
</div>

Server exchange

This Hyperpart has no server exchange — it is presentation or client chrome only. htmx does not issue a request on this part's behalf. If you put an affordance (hx-*) on a control that uses this markup, that action's exchange belongs to the action, not this part. See Swap contract for host-owned envelopes.

Swap contract

Agent-visible HTMX topology (ADR-0054 / decision 0012). exchange envelope = what the response may re-emit relative to the persistent slot (body_only | outer | none | host_owned | document). dual-lock validates part markup only — not this envelope. Stem: stems/morph-safe-hypermedia.md; decision: docs/decisions/0012-swap-identity-contract.md.

No host HTMX exchange on this part — presentation or client chrome only. exchange envelope: n/a.

If a host wraps this markup in hx-*, that host owns the swap contract (sole identity + envelope). Prefer innerMorph / outerMorph for stable slots; replacement for flash; body-only responses under inner swaps.

Envelope response examples

This part has no owned exchange (envelope n/a). If a host adds hx-*, that host’s envelope applies — typically body_only:

html
<!-- Host wraps this presentation part with hx-* (host owns envelope) -->
<!-- Prefer: hx-swap="innerMorph" hx-target="#panel-body" -->
<!-- Server returns body_only interior for #panel-body -->
<div class="dz-stack">content…</div>

Do not re-own the slot:

html
<!-- WRONG: server returns the presentation root with a new id every poll -->
<div id="status-list-root" data-dz-region>…</div>

How to use it

No extended guidance authored yet — start from Copy this and the dependency chips (Primitive = markup only; controller = load listed JS; Endpoint = implement Server exchange).

Seams

  • copy the partial under Copy this; keep root class and data-* modifiers so the CSS/JS bundle matches
  • no Server exchange on this part — pure presentation or client chrome
  • satisfy the DOM contract tables (CI stop-ship)

DOM contract

What the emitted HTML must satisfy — the table is the required surface; Python under contracts/ is the package-internal dual-lock CI runs (tests/test_contracts.py), not an app route. Standalone HTMX4: implement the API so responses match this markup. Dazzle: the agent emits SSR that already satisfies it. Do not invent attrs outside these tables. For request/response wiring see Server exchange.

contracts/status_list.py

Required in the DOM: root [data-status-entry] (part status-list). Emit only these attributes — inventing extras is fine only if controllers ignore them; omitting required ones fails CI (tests/test_contracts.py).

NodeAttrConstraint
[data-status-entry]data-status-entrypresent (any value)
[data-status-entry]data-stateone of ['neutral', 'positive', 'warning', 'destructive', 'accent']

Ingestion model StatusListEntry

Server-side shape before render — one normalisation boundary for producers.

FieldTypeRequired
titlestringrequired
statestring ∈ ['neutral', 'positive', 'warning', 'destructive', 'accent']optional
captionstringoptional
icon_htmlstringoptional

Exemplar render()

Executable in CI: the Python below is render(); the boxed preview is render(EXEMPLARS[0]) — the first fixture the dual-lock tests emit, not a separate widget and not gallery mock data.

python
def render(entry: StatusListEntry) -> str:
    """Model → one ``<li>`` status entry."""
    state = html.escape(entry.state, quote=True)
    title = html.escape(entry.title)
    if entry.icon_html.strip():
        icon_html = entry.icon_html
    else:
        icon_html = '<span class="dz-status-list-icon-spacer" aria-hidden="true"></span>'
    caption_html = ""
    if entry.caption:
        caption_html = f'<div class="dz-status-list-caption">{html.escape(entry.caption)}</div>'
    pill_html = ""
    if entry.state != "neutral":
        pill_html = f'<span class="dz-status-list-pill">{html.escape(entry.state)}</span>'
    return (
        f'<li class="dz-status-list-entry" data-dz-status-entry '
        f'data-dz-state="{state}">'
        f"{icon_html}"
        f'<div class="dz-status-list-text">'
        f'<div class="dz-status-list-title">{title}</div>'
        f"{caption_html}"
        f"</div>"
        f"{pill_html}"
        f"</li>"
    )

Live output of render(EXEMPLARS[0]) — fixture markup the dual-lock validates (sample field values only).

  • Payments API
    Operational · 99.99% this month
    positive

Notes

Per-row state is data-state on the entry (the pill repeats it as text for WCAG 1.4.1); dual-lock root is data-status-entry (contracts/status_list.py). Vocabulary: neutral / positive / warning / destructive / accent (not success). A neutral row has no pill and an icon SPACER keeps the text column aligned. The wrapper's data-entry-count is the server's row count — handy for e2e assertions without counting DOM.

Source files

Canonical registration in the registry. No dedicated controller — CSS for this part lives in the layered bundle.

site/registry.py · contracts/status_list.py