Sidebar layout Primitive
Two panes: a fixed-ish side and a fluid content pane that wraps UNDER the side when it would get too narrow — responsive without a media query.
Layer: L1 surface · Recipe: layout-primitive — layout primitive. Curriculum: AGENTS.md; pick matrix: docs/agent/pick-a-surface.md; blast radius: CONSUMER_MAP.md.
Copy this
<div class="sidebar-layout" style="--sidebar-width: 12rem">
<div class="hm-demo-box">Side (12rem)</div>
<div class="hm-demo-box">Content — wraps under the side when narrower than its minimum comfortable width.</div>
</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:
<!-- 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:
<!-- WRONG: server returns the presentation root with a new id every poll -->
<div id="sidebar-layout-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/sidebar_layout.py
Required in the DOM: root .sidebar-layout (part sidebar_layout). Emit only these attributes — inventing extras is fine only if controllers ignore them; omitting required ones fails CI (tests/test_contracts.py).
| Node | Attr | Constraint |
|---|---|---|
.sidebar-layout | — | — |
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.
"""HYPERPART: sidebar_layout — two-pane flex wrap (side + fluid content).
Dual-lock unit is the layout root. Side/content children, ``--dz-sidebar-width``,
and ``data-dz-side`` are host-owned. Class ``.dz-sidebar-layout`` is the stable
substrate root (gallery layout primitive; no FragmentRenderer emit yet).
Distinct from contracts/sidebar.py (``.dz-sidebar`` nav rail).
"""
from contracts._kit import DomContract, Node
DOM_CONTRACT = DomContract(
part="sidebar_layout",
root=".dz-sidebar-layout",
nodes=(Node(".dz-sidebar-layout", attrs={}),),
)
__all__ = ["DOM_CONTRACT"]
Notes
flex-basis: var(--sidebar-width) (a PUBLIC knob — set it inline or at :root), the content gets flex-grow: 999 with min-inline-size: var(--sidebar-content-min, 50%) — when the content can't hold that minimum on the line, it wraps to a full-width row. data-side="end" puts the side after the content. No media query: the breakpoint is the CONTENT'S minimum, so the same markup works in a page, a card, or a drawer. Dual-lock root .sidebar-layout (HMC-152).Source files
Canonical registration in the registry. No dedicated controller — CSS for this part lives in the layered bundle.
site/registry.py · contracts/sidebar_layout.py