Progress stages

Progress stages data Primitive

A native progress bar with stage chips — where the work is, stage by stage, with completion tones.

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.

33%
Draft (4)Review (2)Published (0)

1 of 3 complete

Copy this

html
<div class="progress-region hm-measure-lg" data-progress-region>
  <div class="progress-header">
    <progress data-progress value="33" max="100"></progress>
    <span>33%</span>
  </div>
  <div class="progress-stages"><span class="progress-chip" data-stage-tone="complete">Draft (4)</span><span class="progress-chip" data-stage-tone="active">Review (2)</span><span class="progress-chip" data-stage-tone="empty">Published (0)</span></div>
  <p class="progress-summary">1 of 3 complete</p>
</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="progress-region-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/progress.py

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

NodeAttrConstraint
[data-progress-region]data-progress-regionpresent (any value)

Ingestion model ProgressStage

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

FieldTypeRequired
namestringrequired
countintegeroptional
completebooleanoptional

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(p: Progress) -> str:
    """Model → progress region."""
    pct_str = _pct_str(p.complete_pct)
    chips_html = "".join(
        f'<span class="dz-progress-chip" data-dz-stage-tone="{_stage_tone(s)}">'
        f"{html.escape(s.name)} ({s.count})"
        f"</span>"
        for s in p.stages
    )
    summary_html = (
        f'<p class="dz-progress-summary">{p.complete_count} of {p.total} complete</p>'
        if p.total > 0
        else ""
    )
    return (
        f'<div class="dz-progress-region" data-dz-progress-region>'
        f'<div class="dz-progress-header">'
        f'<progress data-dz-progress value="{pct_str}" max="100"></progress>'
        f"<span>{pct_str}%</span>"
        f"</div>"
        f'<div class="dz-progress-stages">{chips_html}</div>'
        f"{summary_html}"
        f"</div>"
    )

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

33%
Draft (4)Review (2)Published (0)

1 of 3 complete

Notes

Dual-lock root is data-progress-region (contracts/progress.py). The bar is a NATIVE <progress> (styled via data-progress) with its percent readout as a plain <span> beside it in the header; chips are plain text (Name (count)) toned by data-stage-tone="complete|active|empty"; the summary paragraph follows the stages.

Source files

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

site/registry.py · contracts/progress.py