checklist

Track local tutorial progress

Install

docsloth component add @docsloth/checklist@1.0.0

Live package: sha256:90d811d2436bb54d136a8e00969f1240fec4a4141478b9d997010bc4b6fcc226 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

Props

The prop schema is normative in packages/contracts/component-props/checklist.schema.json.

Example props generated from this schema:

{
  "title": "example-title",
  "items": [
    {
      "id": "example-id",
      "label": "example-label",
      "required": true
    }
  ],
  "persist_locally": true
}

Required props: items, persist_locally.

Example

Example document IR (the block the renderer consumes):

{
  "type": "checklist",
  "props": {
    "title": "example-title",
    "items": [
      {
        "id": "example-id",
        "label": "example-label",
        "required": true
      }
    ],
    "persist_locally": true
  }
}

Renderer HTML (entities decoded and wrapped for display):

<section class="ds-block ds-checklist" data-component="checklist" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<ul class="ds-checklist">
<li>
<span class="ds-check" aria-hidden="true" data-markdown-ignore="true">☐</span> example-label (required)</li>
</ul>
<p class="ds-live-note" role="note">Checking items off and saving progress needs the live documentation site.</p>
</section>

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

Specification

Generated from packages/contracts/component-specs/checklist.md.

Contract

Production props are normative in ../contracts/component-props/checklist.schema.json. The corresponding component-fixtures manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated component-package.json manifest plus props.schema.json (the production props schema, copied byte-for-byte) and spec.md (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

Intended behavior

The official React component renders every item as a labelled checkbox after hydration, marks required instructions, counts local completion and provides Reset progress. Completion is explicitly self-reported and never machine verification. Before hydration or without JavaScript, all instructions remain readable without inert controls or a misleading live progress counter. The native IR renderer remains a static task list.

Failure and fallback

persist_locally: true saves checkmarks in browser localStorage only when the host supplies a nonempty releaseId through ComponentContentProvider. The key contains the release, title, ordered item IDs/labels/required flags and persistence setting; changed content or release starts separate progress. Identical checklists in the same release share saved progress on reload. No global cross-page or cross-release key is used, and checkmarks never authorize execution. Hosts must use a release identity that changes with publication versions.

Absent publication context, disabled persistence, corrupt data or denied/full storage falls back to memory with a visible notice. Reset clears this checklist's checkmarks. Old version keys are not automatically deleted; browser storage limits can trigger the memory fallback. Empty lists and malformed or duplicate item IDs have explicit messages. No network or model calls occur.

Required acceptance cases

Reset and page version invalidation. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

Package manifest

Protocol fixture: packages/contracts/component-fixtures/checklist.json.

Sources