# oob_registry URL: /api/templating/oob_registry/ Section: templating -------------------------------------------------------------------------------- oob_registry - Chirp window.BENGAL_THEME_DEFAULTS = { appearance: 'light', palette: 'charcoal-bengal' }; window.Bengal = window.Bengal || {}; window.Bengal.enhanceBaseUrl = '/chirp/assets/js/enhancements'; window.Bengal.watchDom = true; window.Bengal.debug = false; window.Bengal.enhanceUrls = { 'toc': '/chirp/assets/js/enhancements/toc.736b857e.js', 'docs-nav': '/chirp/assets/js/enhancements/docs-nav.57e4b129.js', 'tabs': '/chirp/assets/js/enhancements/tabs.aac9e817.js', 'lightbox': '/chirp/assets/js/enhancements/lightbox.1ca22aa1.js', 'interactive': '/chirp/assets/js/enhancements/interactive.96c8880c.js', 'mobile-nav': '/chirp/assets/js/enhancements/mobile-nav.d991657f.js', 'action-bar': '/chirp/assets/js/enhancements/action-bar.d62417f4.js', 'copy-link': '/chirp/assets/js/enhancements/copy-link.7d9a5c29.js', 'data-table': '/chirp/assets/js/enhancements/data-table.1f5bc1eb.js', 'lazy-loaders': '/chirp/assets/js/enhancements/lazy-loaders.a5c38245.js', 'holo': '/chirp/assets/js/enhancements/holo.ee13c841.js', 'link-previews': '/chirp/assets/js/enhancements/link-previews.96620bcf.js' }; (function () { try { var defaults = window.BENGAL_THEME_DEFAULTS || { appearance: 'system', palette: '' }; var defaultAppearance = defaults.appearance; if (defaultAppearance === 'system') { defaultAppearance = (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) ? 'dark' : 'light'; } var storedTheme = localStorage.getItem('bengal-theme'); var storedPalette = localStorage.getItem('bengal-palette'); var theme = storedTheme ? (storedTheme === 'system' ? defaultAppearance : storedTheme) : defaultAppearance; var palette = storedPalette ?? defaults.palette; document.documentElement.setAttribute('data-theme', theme); if (palette) { document.documentElement.setAttribute('data-palette', palette); } } catch (e) { document.documentElement.setAttribute('data-theme', 'light'); } })(); { "prerender": [ { "where": { "and": [ { "href_matches": "/docs/*" }, { "not": { "selector_matches": "[data-external], [target=_blank], .external" } } ] }, "eagerness": "conservative" } ], "prefetch": [ { "where": { "and": [ { "href_matches": "/*" }, { "not": { "selector_matches": "[data-external], [target=_blank], .external" } } ] }, "eagerness": "conservative" } ] } Skip to main content Magnifying Glass ESC Recent Clear Magnifying Glass No results for "" Start typing to search... ↑↓ Navigate ↵ Open ESC Close Powered by Lunr ⌁⌁ DocumentationGet StartedCore ConceptsTemplatesGit BranchRoutingMiddlewareStreamingDatabaseDataTestingFile TextReferenceServerDeploymentInfoAboutExamplesGuidesTutorialsReleasesDevGitHubChirp API ReferenceForum Magnifying Glass Search ⌘K Palette Appearance Chevron Down Mode Monitor System Sun Light Moon Dark Palette Snow Lynx Brown Bengal Silver Bengal Charcoal Bengal Blue Bengal List ⌁⌁ Magnifying Glass Search X Close Documentation Caret Down Get Started Core Concepts Templates Git Branch Routing Middleware Streaming Database Data Testing File Text Reference Server Deployment Info About Examples Guides Tutorials Releases Dev Caret Down GitHub Chirp API Reference Forum Palette Appearance Chevron Down Mode Monitor System Sun Light Moon Dark Palette Snow Lynx Brown Bengal Silver Bengal Charcoal Bengal Blue Bengal Chirp API Reference Caret Right Internal asgi invoke invoke_plan kwargs_resolve multimap types Caret Right Ai _providers _structured errors llm streaming Caret Right App compiler diagnostics lifecycle registry runtime server state Caret Right Cache Caret Right Backends memory null redis key middleware protocol Caret Right Cli Caret Right Templates full minimal scaffold shell sse v2 _check _makemigrations _new _resolve _routes _run _security_check _templates Caret Right Contracts checker declarations routes rules_accessibility rules_commands rules_forms rules_htmx rules_inline rules_islands rules_layout rules_page_shell rules_route_contract rules_sse rules_swap rules_vary template_scan types utils Caret Right Data Caret Right Drivers postgres sqlite Caret Right Schema diff generate introspect operations parse types _mapping _sqlite database errors migrate query types Caret Right Ext chirp_ui Caret Right Http cookies forms headers query request response sync_request Caret Right I18N catalog detection formatting middleware Caret Right Markdown errors filters renderer Caret Right Middleware _redis_rate_limit allowed_hosts auth auth_rate_limit builtin csp_nonce csrf inject layout_debug protocol security_headers sessions static Caret Right Pages actions context debug discovery Caret Right index bus events stream renderer resolve sections shell_actions shell_context types Caret Right Realtime events sse Caret Right Routing params route router Caret Right Security audit decorators lockout passwords urls Caret Right Server Caret Right Debug editor frames render_plan_snapshot renderers request_context styles template_context alpine debug_page delegation dev dev_browser_reload devtools errors handler handler_kwargs htmx_debug htmx_safe_target islands negotiation negotiation_oob production route_explorer sender speculation_rules sse_lifecycle sync_handler terminal_checks terminal_errors view_transitions Caret Right Templating adapter composition filters fragment_target_registry integration kida_adapter macros oob_registry render_plan returns streaming suspense Caret Right Testing assertions client sse Caret Right Tools events handler registry schema Caret Right Validation result rules chirp config context domains errors extraction health logging plugin resilience shell_actions shell_regions sources Chirp API ReferenceTemplating ᗢ Caret Down Link Copy URL External Open LLM text Copy Copy LLM text Share with AI Ask Claude Ask ChatGPT Ask Gemini Ask Copilot Module templating.oob_registry 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 use block_name.removesuffix("_oob") as target ID, outerHTML swap, and wrapper div. 2Classes Classes OOBRegionConfig 3 ▼ Serialization config for a single OOB region. target_id: DOM element ID for hx-swap-oob targeting.… 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. Attributes Name Type Description target_id str — swap str — wrap bool — OOBRegistry 11 ▼ App-level registry mapping OOB block names to serialization config. Mutable during setup, frozen a… App-level registry mapping OOB block names to serialization config. Mutable during setup, frozen at runtime (same lifecycle as routes). Attributes Name Type Description _regions dict[str, OOBRegionConfig] — _frozen bool — _contract_cache dict[str, LayoutContract] — _contract_lock threading.Lock — Methods registered_blocks 0 frozenset[str] ▼ property def registered_blocks(self) -> frozenset[str] Returns frozenset[str] register 2 ▼ def register(self, block_name: str, config: OOBRegionConfig) -> None Parameters Name Type Description block_name — config — freeze 0 ▼ def freeze(self) -> None get 1 OOBRegionConfig | None ▼ def get(self, block_name: str) -> OOBRegionConfig | None Parameters Name Type Description block_name — Returns OOBRegionConfig | None resolve_target 1 str ▼ Resolve block name to target ID. Registry first, convention fallback. def resolve_target(self, block_name: str) -> str Parameters Name Type Description block_name — Returns str resolve_serialization 1 tuple[str, bool] ▼ Return (swap, wrap) for a target ID. Convention default: outerHTML + wrap. def resolve_serialization(self, target_id: str) -> tuple[str, bool] Parameters Name Type Description target_id — Returns tuple[str, bool] get_or_build_contract 2 LayoutContract ▼ Return cached LayoutContract, building on first access. def get_or_build_contract(self, adapter: Any, template_name: str) -> LayoutContract Parameters Name Type Description adapter — template_name — Returns LayoutContract ← Previous macros Next → render_plan List © 2026 Chirp built in ᓚᘏᗢ { "linkPreviews": { "enabled": true, "hoverDelay": 200, "hideDelay": 150, "showSection": true, "showReadingTime": true, "showWordCount": true, "showDate": true, "showTags": true, "maxTags": 3, "includeSelectors": [".prose"], "excludeSelectors": ["nav", ".toc", ".breadcrumb", ".pagination", ".card", "[class*='-card']", ".tab-nav", "[class*='-widget']", ".child-items", ".content-tiles"], "allowedHosts": [], "allowedSchemes": ["https"], "hostFailureThreshold": 3, "showDeadLinks": true } } window.BENGAL_LAZY_ASSETS = { tabulator: '/chirp/assets/js/tabulator.min.js', dataTable: '/chirp/assets/js/data-table.js', mermaidToolbar: '/chirp/assets/js/mermaid-toolbar.9de5abba.js', mermaidTheme: '/chirp/assets/js/mermaid-theme.344822c5.js', graphMinimap: '/chirp/assets/js/graph-minimap.ff04e939.js', graphContextual: '/chirp/assets/js/graph-contextual.355458ba.js' }; window.BENGAL_ICONS = { close: '/chirp/assets/icons/close.911d4fe1.svg', enlarge: '/chirp/assets/icons/enlarge.652035e5.svg', copy: '/chirp/assets/icons/copy.3d56e945.svg', 'download-svg': '/chirp/assets/icons/download.04f07e1b.svg', 'download-png': '/chirp/assets/icons/image.c34dfd40.svg', 'zoom-in': '/chirp/assets/icons/zoom-in.237b4a83.svg', 'zoom-out': '/chirp/assets/icons/zoom-out.38857c77.svg', reset: '/chirp/assets/icons/reset.d26dba29.svg' }; Arrow Up -------------------------------------------------------------------------------- Metadata: - Word Count: 1036 - Reading Time: 5 minutes