Switch

Switch form Primitive

On/off control — progressive enhancement over a native checkbox. State is the checkbox's checked attribute (DOM), not a JS store.

Layer: L1 surface · Recipe: boolean-settings — boolean settings / on-off preference. Curriculum: AGENTS.md; pick matrix: docs/agent/pick-a-surface.md; blast radius: CONSUMER_MAP.md.

Copy this

html
<div class="hm-demo-row">
  <label class="switch"><input type="checkbox" name="hm-notify" data-switch checked><span class="switch__track" aria-hidden="true"></span><span>Email notifications</span></label>
  <label class="switch"><input type="checkbox" name="hm-digest" data-switch><span class="switch__track" aria-hidden="true"></span><span>Weekly digest</span></label>
</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="switch-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/switch.py

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

NodeAttrConstraint
[data-switch]data-switchpresent (any value)

Module source

Import path is monorepo/package-local (from contracts._kit import …). Source-token form often uses data-*; gallery demos above are unprefixed. Do not copy this into app routes.

python
"""HYPERPART: switch — on/off control over a native checkbox.

Dual-lock unit is the switch input root. Label chrome and track styling are
host-owned. Selector ``[data-dz-switch]`` is the stable substrate root.

Dazzle form path (2026-08-07): ``widget=switch`` → ``SwitchField`` →
``FragmentRenderer._emit_switch_field`` mounts this anatomy on create/edit forms.
"""

from contracts._kit import DomContract, Node, Present

DOM_CONTRACT = DomContract(
    part="switch",
    root="[data-dz-switch]",
    nodes=(
        Node(
            "[data-dz-switch]",
            attrs={"data-dz-switch": Present()},
        ),
    ),
)

__all__ = ["DOM_CONTRACT"]

Notes

PLACEHOLDER — shadcn parity (HMC-031). No controller: native checkbox + CSS track/thumb. Label text is a sibling span so the whole control is a click target. Dual-lock root [data-switch] (HMC-129); Dazzle form-field emit still optional.

Source files

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

site/registry.py · contracts/switch.py