templating.oob_registry

Page actions AI-ready formats and sharing
Open LLM text
Share with AI
Ask Claude Ask ChatGPT Ask Gemini Ask Copilot

App-level OOB region registry for layout-contract serialization.

Maps OOB block names (e.g.breadcrumbs_oob) to serialization config (target ID, swap strategy, wrapper behavior). Apps register regions during setup; the registry is frozen…

App-level OOB region registry for layout-contract serialization.

Maps OOB block names (e.g.breadcrumbs_oob) to serialization config (target ID, swap strategy, wrapper behavior). Apps register regions during setup; the registry is frozen at runtime alongside routes and middleware.

Convention fallback: unregistered blocks useblock_name.removesuffix("_oob") as target ID,outerHTMLswap, and wrapper div.

templating.oob_registry

Name Type Default Description
type
qualified_name
element_type
description
source_file
line_number
is_autodoc
autodoc_element
_autodoc_template
_autodoc_url_path
_autodoc_page_type
title
doc_content_hash

Symbols on this page

OOBRegionConfig
class

Serialization config for a single OOB region.

target_id: DOM element ID for hx-swap-oob targeting. swap: htmx swap strategy — "innerHTML" or "true" (outerHTML). wrap: Whether to wrap in

. False for elements like that embed their own hx-swap-oob attribute.</p> </div> </div> </div> </details> <details class="chirpui-accordion__item chirp-theme-reference-member" name="reference-members" > <summary class="chirpui-accordion__trigger"> <span class="chirpui-accordion__trigger-text">OOBRegistry</span> <div class="chirpui-accordion__trigger-actions"> <span class="chirpui-badge chirpui-badge--muted"> <span class="chirpui-badge__text">class</span> </span> </div> </summary> <div class="chirpui-accordion__content"> <div id="OOBRegistry" class="chirp-theme-reference-member__body"> <div class="chirpui-rendered-content chirpui-rendered-content--compact chirp-theme-reference-member__description"> <p>App-level registry mapping OOB block names to serialization config.</p> <p>Mutable during setup, frozen at runtime (same lifecycle as routes).</p> </div> </div> </div> </details> </div> <p class="chirp-theme-reference-source"> <a href="https://github.com/lbliii/chirp/blob/main//home/runner/work/chirp/chirp/site/../src/chirp/templating/oob_registry.py#L1" class="chirp-theme-reference-source__link" target="_blank" rel="noopener"> <svg width="14" height="14" class="bengal-icon icon-code" aria-hidden="true" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 256 256" fill="none"> <title>Code View source · /home/runner/work/chirp/chirp/site/../src/chirp/templating/oob_registry.py:1