Keyboard key

Keyboard key docs Primitive

Shortcut chip for docs and command chrome — <kbd class=kbd>.

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.

⌘KEsc↵⇧

Copy this

html
<div class="hm-demo-row">
  <kbd class="kbd">⌘K</kbd>
  <kbd class="kbd">Esc</kbd>
  <kbd class="kbd">↵</kbd>
  <kbd class="kbd">⇧</kbd>
</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="kbd-root" data-dz-region>…</div>

How to use it

Seams

  • `<kbd class="kbd">` — always the house chip, never bare Unicode
  • layout roles: adjacent (button:has kbd gap) vs trailing (list/menu auto)

Do / Don't

DoDon't
visually secondary chip + adjacent gap or trailing autoglue ⌘K to the action label or invent a Lucide keyboard as the only hint

Pitfalls

  • 0px gap between primary label and kbd under-signals secondary metadata
  • do not apply affordance-disclosure-chrome (chevrons) rules to shortcuts
  • do not put a kbd on every dense toolbar control (clutter)

Keyboard / AT

  • kbd is presentational hint; the control still needs its own accessible name

Related parts

command button

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/kbd.py

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

NodeAttrConstraint
.kbd——

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: kbd — keyboard shortcut chip for docs and command chrome.

Dual-lock unit is the kbd root. Glyph content and layout role (adjacent vs
trailing) are host-owned. Class ``.dz-kbd`` is the stable substrate root
(gallery / hm-core; no FragmentRenderer emit yet).
"""

from contracts._kit import DomContract, Node

DOM_CONTRACT = DomContract(
    part="kbd",
    root=".dz-kbd",
    nodes=(Node(".dz-kbd", attrs={}),),
)

__all__ = ["DOM_CONTRACT"]

Notes

Stem shortcut-hint-chrome: keyboard chips are visually secondary (mono, small, muted keycap) and spatially secondary — layout roles adjacent (flex gap next to a label) vs trailing (row end via margin-inline-start: auto). Not disclosure iconography. Styles in hm-core.css; pure presentation. Dual-lock root .kbd (HMC-151).

Source files

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

site/registry.py · contracts/kbd.py