Feedback and status

Readiness checklist

<forma-readiness-checklist>

Explicit complete, incomplete and blocking prerequisites shown before a consequential transition.

Authoring tag
<forma-readiness-checklist>
Behavior owner
Ordo / application
Canonical source
patterns/readiness-checklist.html

Purpose

A readiness checklist shows the prerequisites for a consequential step, such as closing a period, publishing a release or submitting an application, and the state of each. Forma renders a bordered section with a header (a Status lozenge summary and a heading) and a list of items, each with a glyph, a label and an optional trailing action or state word. The application or Ordo decides what the prerequisites are, whether each is met, and whether the transition is allowed; Forma does not calculate readiness.

Use when

  • A transition has several prerequisites and the user needs to see which remain.
  • Some prerequisites block the transition and others are advisory, and the difference must be clear.
  • Each incomplete item has a place the user can go to resolve it.

Avoid when

Behavior to know

  • Each item's state is shown by its glyph text (✓, ○, !) and, for blocking items, a written state word and a thick inline-start border.
  • Complete items make their glyph bold; incomplete items usually carry an action.
  • The header lozenge summarizes progress in words, such as "5 of 7 complete".

Basic example

The smallest correct markup: the canonical pattern from patterns/readiness-checklist.html inside its public tag. Copy this first, then adapt labels, names and state.

Canonical

Minimal readiness checklist

Rendered from the canonical pattern file.

Static specimen. Its buttons stand for application actions that the consuming application implements; this script-free documentation does not perform them. Its controls are shown for their markup and appearance and cannot be operated here.

5 of 7 complete

Ready to close September

  • All invoices posted
  • Payments allocated
  • Bank reconciliation
  • CPA adjustment reviewBlocking
HTML · Minimal readiness checklist Raw HTML for HTML · Minimal readiness checklist
<forma-readiness-checklist class="forma-component-tag">
<section class="forma-readiness-checklist" aria-labelledby="readiness-title">
  <header>
    <span class="forma-status-lozenge" data-state="attention">5 of 7 complete</span>
    <h3 id="readiness-title">Ready to close September</h3>
  </header>
  <ul class="forma-readiness-checklist__items">
    <li data-state="complete"><span aria-hidden="true">✓</span><span>All invoices posted</span></li>
    <li data-state="complete"><span aria-hidden="true">✓</span><span>Payments allocated</span></li>
    <li data-state="incomplete"><span aria-hidden="true">○</span><span>Bank reconciliation</span><button type="button">Review</button></li>
    <li data-state="blocked"><span aria-hidden="true">!</span><span>CPA adjustment review</span><span>Blocking</span></li>
  </ul>
</section>
</forma-readiness-checklist>

Click or tap the code once to select all of it, then copy.

Examples

Scenario

All prerequisites met

Every item is complete. The header lozenge switches to the ok glyph and the transition button is available below the list, supplied by the application.

Static specimen. Its buttons stand for application actions that the consuming application implements; this script-free documentation does not perform them. Its controls are shown for their markup and appearance and cannot be operated here.

3 of 3 complete

Ready to publish release 4.2

  • Release notes approvedComplete
  • Migration tested on stagingComplete
  • Rollback plan recordedComplete
HTML · All prerequisites met Raw HTML for HTML · All prerequisites met
<forma-readiness-checklist class="forma-component-tag">
  <section class="forma-readiness-checklist" aria-labelledby="readiness-checklist-ready-to-publish-title">
    <header>
      <span class="forma-status-lozenge" data-state="ok">3 of 3 complete</span>
      <h3 id="readiness-checklist-ready-to-publish-title">Ready to publish release 4.2</h3>
    </header>
    <ul class="forma-readiness-checklist__items">
      <li data-state="complete"><span aria-hidden="true">✓</span><span>Release notes approved</span><span class="forma-visually-hidden">Complete</span></li>
      <li data-state="complete"><span aria-hidden="true">✓</span><span>Migration tested on staging</span><span class="forma-visually-hidden">Complete</span></li>
      <li data-state="complete"><span aria-hidden="true">✓</span><span>Rollback plan recorded</span><span class="forma-visually-hidden">Complete</span></li>
    </ul>
  </section>
  <button type="button">Publish release</button>
</forma-readiness-checklist>

Click or tap the code once to select all of it, then copy.

Scenario

Several blocking items

A grant application with two blocking prerequisites and one incomplete item. Blocking items say "Blocking" in text and link to where they are resolved; the header counts what is complete.

Live demo. 1 native action works here and is verified by an outcome test.

1 of 4 complete, 2 blocking

Before you submit the grant application

  • Budget totals match the narrativeComplete
  • Signed letter of support from the partner institutionBlocking
  • Principal investigator's conflict-of-interest formBlocking
  • Optional data-sharing planAdd
HTML · Several blocking items Raw HTML for HTML · Several blocking items
<forma-readiness-checklist class="forma-component-tag">
  <section class="forma-readiness-checklist" aria-labelledby="readiness-checklist-blocked-submission-title">
    <header>
      <span class="forma-status-lozenge" data-state="blocked">1 of 4 complete, 2 blocking</span>
      <h3 id="readiness-checklist-blocked-submission-title">Before you submit the grant application</h3>
    </header>
    <ul class="forma-readiness-checklist__items">
      <li data-state="complete"><span aria-hidden="true">✓</span><span>Budget totals match the narrative</span><span class="forma-visually-hidden">Complete</span></li>
      <li data-state="blocked"><span aria-hidden="true">!</span><span>Signed letter of support from the partner institution</span><span>Blocking</span></li>
      <li data-state="blocked"><span aria-hidden="true">!</span><span>Principal investigator's conflict-of-interest form</span><span>Blocking</span></li>
      <li data-state="incomplete"><span aria-hidden="true">○</span><span>Optional data-sharing plan</span><a href="#readiness-checklist-blocked-submission-title">Add</a></li>
    </ul>
  </section>
</forma-readiness-checklist>

Click or tap the code once to select all of it, then copy.

Mobile

Each mobile example renders in its own document inside a real narrow viewport, so Forma's media and container queries run exactly as they would on a phone. Choose a width to compare.

Mobile example

Mobile month-end close

The canonical close checklist at phone width with an action on an incomplete item.

Static specimen. Its buttons stand for application actions that the consuming application implements; this script-free documentation does not perform them. Its controls are shown for their markup and appearance and cannot be operated here.

Viewport width

Frames narrower than the selected width show the component at the width available.

What changes at narrow widths

  • Items keep their three columns (glyph, label, action) at every width; the label column shrinks and wraps.
  • Each row is at least 3rem tall, so the trailing button or state word has room to be tapped.
  • Long labels wrap under themselves rather than pushing the action off-screen; nothing scrolls horizontally at 320px.
  • The header lozenge and heading stack naturally; in landscape the heading has more room and wraps less.
HTML · Mobile month-end close Raw HTML for HTML · Mobile month-end close
<forma-readiness-checklist class="forma-component-tag">
  <section class="forma-readiness-checklist" aria-labelledby="readiness-checklist-mobile-month-close-title">
    <header>
      <span class="forma-status-lozenge" data-state="attention">2 of 4 complete</span>
      <h3 id="readiness-checklist-mobile-month-close-title">Close September books</h3>
    </header>
    <ul class="forma-readiness-checklist__items">
      <li data-state="complete"><span aria-hidden="true">✓</span><span>All invoices posted</span><span class="forma-visually-hidden">Complete</span></li>
      <li data-state="complete"><span aria-hidden="true">✓</span><span>Payments allocated</span><span class="forma-visually-hidden">Complete</span></li>
      <li data-state="incomplete"><span aria-hidden="true">○</span><span>Reconcile the operating account at First National</span><button type="button">Review</button></li>
      <li data-state="blocked"><span aria-hidden="true">!</span><span>External accountant adjustment review</span><span>Blocking</span></li>
    </ul>
  </section>
</forma-readiness-checklist>

Click or tap the code once to select all of it, then copy.

Baseline

Mobile · 320px

The canonical pattern in a true 320px viewport, the minimum width every Forma component must support without page-level horizontal scrolling.

Static specimen. Its buttons stand for application actions that the consuming application implements; this script-free documentation does not perform them. Its controls are shown for their markup and appearance and cannot be operated here.

Viewport width

Frames narrower than the selected width show the component at the width available.

API and configuration

Forma components have no JavaScript API. Their public contract is the markup: native elements and attributes you write, and the CSS hooks below. The CSS hook table is generated from the built stylesheet, so it always matches the shipped implementation.

Native and ARIA attributes
AttributeOnValuesDefaultDescription
aria-labelledbysection.forma-readiness-checklistid of the header heading—Names the checklist from its heading.
data-statelicomplete | incomplete | blocked—Item state supplied by the application. complete bolds the glyph; blocked adds a thick inline-start border. incomplete has no special styling.
aria-hiddenglyph spantrue—Hides the ✓ / ○ / ! glyph; state must also be available as text.
CSS hooks (derived from dist/all.css)
HookKindValues or defaultDescription
.forma-readiness-checklistBlock class—Root section with a functional border. Its direct header child is padded and separated by a rule.
.forma-readiness-checklist__itemsElement class—Unstyled list. Each li is a grid of a 2rem glyph column, a flexible label column and an auto column for an action or state word.
[data-state]Attribute hook—On each li: complete makes the first child (glyph) bold; blocked adds a 0.35rem accent inline-start border.
Keyboard interaction
KeysResult
Tab / Shift+TabMoves through item actions (buttons or links). Items themselves are not focusable.
Enter / SpaceActivates the focused action (native behavior; Space applies to buttons only).
Events
EventDescription
clickNative click on item actions. The application navigates or performs the work.

Form behavior

Not a form control; the checklist does not submit anything. The transition itself is a separate application button.

States

Readiness checklist states
StateHow it is expressedPresentation
Completeli data-state="complete"✓ glyph in bold. Provide a text equivalent such as visually hidden "Complete".
Incompleteli data-state="incomplete"○ glyph and usually an action to resolve it.
Blockingli data-state="blocked"! glyph, a visible "Blocking" word and a thick inline-start border.

Accessibility

Forma provides

  • Distinguishes blocking items by a structural border and a text column, not color.
  • Lays items out as a native list, so assistive technology announces the item count.

Your application supplies

  • Give every item a text state: a visible word ("Blocking") or visually hidden text ("Complete"), because the glyph is hidden.
  • Keep the header lozenge count in sync with the items.
  • Disable or hide the transition while blocking items remain only if the authority says so, and explain why.

Responsive behavior

  • Each item is a 2rem minmax(0, 1fr) auto grid at every width; the label column wraps.
  • Items have a 3rem minimum height.
  • No breakpoints; the header wraps naturally.

Motion

  • No animation: item states change when the application re-renders the list.

Usage guidance

Do

  • List blocking prerequisites first when the domain has no inherent order.
  • Link incomplete items to where they can be resolved.

Avoid

  • Calculating readiness in the UI from the visible items.
  • Marking advisory items as blocking to encourage completion.

Verification specimens

Generated fault-injection specimens expose content, spacing, color-cue, and reduced-effective-contrast risks. They screen presentation robustness as engineering screens without claiming human-subject validation.