UIPanelOptions

Target UI layer name on the scene’s render tree. Defaults to UI_DEFAULT_LAYER ("ui"), which is auto-provisioned as a screen-space layer via SceneRenderTreeKey.ensureLayer(...) on first use. Any other explicit name must be declared on the scene’s readonly layers or the panel throws on add.

left?

optional left?: PositionValue

Defined in: ui/src/types.ts:146

Offset from the containing block’s left edge — px or "<n>%" (only applies to position: "absolute").

Inherited from

PanelProps.left

margin?

optional margin?: number | { bottom?: number; left?: number; right?: number; top?: number; }

Defined in: ui/src/types.ts:120

Inherited from

PanelProps.margin

maxHeight?

optional maxHeight?: LayoutValue

Defined in: ui/src/types.ts:119

Inherited from

PanelProps.maxHeight

maxWidth?

optional maxWidth?: LayoutValue

Defined in: ui/src/types.ts:117

Inherited from

PanelProps.maxWidth

minHeight?

optional minHeight?: LayoutValue

Defined in: ui/src/types.ts:118

Inherited from

PanelProps.minHeight

minWidth?

optional minWidth?: LayoutValue

Defined in: ui/src/types.ts:116

Inherited from

PanelProps.minWidth

offset?

optional offset?: object

Defined in: ui/src/types.ts:503

x

x: number

y

y: number

onHover?

optional onHover?: (hovering) => void

Defined in: ui/src/types.ts:220

Parameters

hovering

boolean

Returns

void

Inherited from

PanelProps.onHover

onPointerOut?

optional onPointerOut?: () => void

Defined in: ui/src/types.ts:219

Returns

void

Inherited from

PanelProps.onPointerOut

onPointerOver?

optional onPointerOver?: () => void

Defined in: ui/src/types.ts:218

Returns

void

Inherited from

PanelProps.onPointerOver

overflow?

optional overflow?: "visible" | "hidden"

Defined in: ui/src/types.ts:291

Inherited from

PanelProps.overflow

padding?

optional padding?: Padding

Defined in: ui/src/types.ts:277

Inherited from

PanelProps.padding

position?

optional position?: "relative" | "absolute"

Defined in: ui/src/types.ts:144

Positioning mode for this element relative to its parent. Defaults to "relative" — the element flows in the parent’s flex layout. Set to "absolute" to lift the element out of the flow and pin it via left / top / right / bottom against the parent’s content box.

A position: "relative" ancestor acts as the containing block for any absolute-positioned descendants — useful for HUD overlays, modal backdrops, and badge markers. See <ZStack> in @yagejs/ui-react for an opinionated overlay primitive.

Inherited from

PanelProps.position

positioning?

optional positioning?: UIPositioning

Defined in: ui/src/types.ts:527

How the panel’s root container is positioned each frame.

"anchor" (default) — resolve anchor against the viewport (virtualSize). Classic HUD/menu behavior.
"transform" — read entity.get(Transform).worldPosition and reinterpret anchor as the pivot on the panel itself (e.g. BottomCenter → panel’s bottom-center sits at the Transform). Requires a Transform on the entity. The panel is positioned in the layer’s local coords, so this plays with any layer type: screen-space layers (paired with a ScreenFollow component that writes projected screen coords) for constant-size billboards, or world-space layers for genuinely diegetic UI that scales with the camera.