Skip to content

SafeAreaData

Defined in: ui/layout/safe-area.ts:21

core-ui.ts

The stable UI surface promoted into the top-level esengine namespace (text, UINode box visuals, interaction, layout, theme).

This is the curated public UI API. The complete UI module surface — which also includes low-level text/atlas internals and engine-internal composition glue (e.g. EntityStateMap, ensureComponent) — lives in ./ui and is imported module-directly by the SDK code that needs it. Those internals are intentionally NOT re-exported here, so the public esengine namespace stays a stable, intentional surface.

Re-exported wholesale by core.ts.

applyBottom: boolean

Defined in: ui/layout/safe-area.ts:23


applyLeft: boolean

Defined in: ui/layout/safe-area.ts:24


applyRight: boolean

Defined in: ui/layout/safe-area.ts:25


applyTop: boolean

Defined in: ui/layout/safe-area.ts:22


avoidHostMenu: boolean

Defined in: ui/layout/safe-area.ts:32

Also clear the host’s own overlay — WeChat’s capsule menu, which sits INSIDE the safe area: measured on an iPhone 12, its bottom is 29px below safeArea.top. Only for a node the overlay actually reaches: this moves the whole node down, so a HUD already above the capsule ends up on it.