API and Development
@prepared911/ui/styles.css once at the document root.
| Name | Required | Description |
|---|---|---|
rendering | yes | Output of resolveAreaEffectRendering from @prepared911/core/notifications. |
regionLabel | yes | Accessible name of the affected region on the overlay path. |
title | yes | Primary message for the overlay alert and fallback banner. |
description | yes* | Overlay alert copy; says what to do next when there is no goTo. |
goTo | yes* | Go-to call to action on the overlay alert and on the fallback inline alert; never dismisses. |
notificationId | yes | Stable router notification id. |
fallbackInlineAlertTitle | yes | Inline alert title on the fallback path. |
fallbackInlineAlertDescription | yes* | Inline alert description on the fallback path; says what to do next when there is no goTo. |
children | no | Region content; inert only on the overlay path. |
goTo, or pass both description and fallbackInlineAlertDescription (AreaNotificationEffectSurfaceRecoveryProps). Which path renders is known only at runtime, so copy-only recovery covers both. Omitting it is a type error.
| Name | Required | Description |
|---|---|---|
active | yes | Shows the error alert and inert content when true. |
regionLabel | yes | Accessible name of the affected region. |
title | yes | Primary error message. |
description | yes* | Supporting copy under the title; says what to do next when there is no goTo. |
goTo | yes* | { label, onPress }; does not dismiss the overlay. |
notificationId | no | Stable router notification id for host wiring. |
children | no | Region content; inert while active. |
goTo, description, or both (AreaOverlayRecoveryProps). Omitting both is a type error.
| Name | Type | Default | Description |
|---|---|---|---|
active | boolean | — | When true, shows the inline error alert and makes {@link AreaOverlayBaseProps.children} inert. When false, renders children only with no alert. |
regionLabel | LocalizedMessage | — | Accessible name of the affected region (role="group"). |
title | LocalizedMessage | — | Primary error message in the inline alert. |
children | ReactNode | — | Region content; inert while active. |
className | string | — | @deprecated Pass layout through enum props and shipped parts. Request a missing case via find-pattern. |
description | LocalizedMessage | — | Supporting copy under the title. Supporting copy under the title that says what the person can do next. |
goTo | AreaOverlayGoTo | — | Go-to action; never dismisses the overlay. Absent: {@link AreaOverlayDescriptionRecovery.description} carries the recovery. |
notificationId | string | — | Stable notification id from the router effect, for host wiring and tests. Does not appear in visible copy. |
ref | Ref<HTMLDivElement> | — | Ref to the root element. |
createAreaOverlayRegistry(registeredAreas) returns { has(area) } for resolveAreaEffectRendering on @prepared911/core/notifications. Pass the result with notification copy to AreaNotificationEffectSurface. emptyAreaOverlayRegistry registers nothing.