Axon 911 Frontend Docs
    Loading navigation…
U
User
Switch to light mode
  1. Blocks
  2. Area Overlay
  3. Usage

Area overlay

Usage

AreaOverlay from @prepared911/ui/blocks/area-overlay renders an area-scoped S5 condition: an inline error alert, optional go-to, and inert content inside one layout region. It does not use a full-page scrim and never opens a dialog. The notification host wraps each named region once, registers the same area ids with createAreaOverlayRegistry, and passes resolveAreaEffectRendering(effect, registry) from @prepared911/core/notifications into AreaNotificationEffectSurface with notification copy. Registered areas render AreaOverlay with active; unregistered areas render the interim S5 banner plus inline error alert in that region. Until every affected region registers an overlay, AreaNotificationEffectSurface keeps the fallback for unregistered ids. The fallback keeps the overlay's way forward: pass the notification's go-to action as goTo, and both paths show it as the inline alert's call to action. When the notification has no go-to, the props require description and fallbackInlineAlertDescription instead; write each as the next step the person can take. AreaOverlay used on its own requires goTo, description, or both. See the block docs/usage.md in @prepared911/ui for integration detail.
Previous
App Header / Accessibility
Next
Area overlay / API and Development