Type Alias: UiSafeAreaEcsComponent

UiSafeAreaEcsComponent = UiSafeAreaDefaultedOptions

Defined in: ui/components/ui-safe-area-component.ts:34

Attach to a full-stretch-anchored UI element (UiAnchor.stretchAll()) to keep it clear of a device's notch, camera cutout, rounded corners, or home indicator - createUiSafeAreaEcsSystem overwrites its RectTransformEcsComponent.x/y/anchoredPosition every frame to shrink its rect inward from whichever edges the live safe-area insets (see getSafeAreaInsets) actually need, so critical content (a pause button pinned to a corner, a HUD bar along an edge) never renders under a notch. Set a field false to leave that specific edge flush with its parent regardless of the device's insets - e.g. a bottom bar that intentionally extends under a home indicator.