UIPanelOptions

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

Options for creating a root UIPanel (attached to an entity as a Component).

Extends

• PanelProps

Properties

alignItems?

optional alignItems?: "stretch" | "flex-start" | "center" | "flex-end" | "baseline"

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

Inherited from

PanelProps.alignItems

---

alignSelf?

optional alignSelf?: "stretch" | "auto" | "flex-start" | "center" | "flex-end" | "baseline"

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

Inherited from

PanelProps.alignSelf

---

anchor?

optional anchor?: Anchor

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

---

background?

optional background?: BackgroundOptions

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

Inherited from

PanelProps.background

---

direction?

optional direction?: FlexDirection

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

Inherited from

PanelProps.direction

---

flexBasis?

optional flexBasis?: LayoutValue

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

Inherited from

PanelProps.flexBasis

---

flexGrow?

optional flexGrow?: number

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

Inherited from

PanelProps.flexGrow

---

flexShrink?

optional flexShrink?: number

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

Inherited from

PanelProps.flexShrink

---

gap?

optional gap?: number

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

Inherited from

PanelProps.gap

---

height?

optional height?: LayoutValue

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

Inherited from

PanelProps.height

---

justifyContent?

optional justifyContent?: "flex-start" | "center" | "flex-end" | "space-between" | "space-around" | "space-evenly"

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

Inherited from

PanelProps.justifyContent

---

layer?

optional layer?: string

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

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.

---

margin?

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

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

Inherited from

PanelProps.margin

---

maxHeight?

optional maxHeight?: LayoutValue

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

Inherited from

PanelProps.maxHeight

---

maxWidth?

optional maxWidth?: LayoutValue

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

Inherited from

PanelProps.maxWidth

---

minHeight?

optional minHeight?: LayoutValue

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

Inherited from

PanelProps.minHeight

---

minWidth?

optional minWidth?: LayoutValue

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

Inherited from

PanelProps.minWidth

---

offset?

optional offset?: object

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

x

x: number

y

y: number

---

overflow?

optional overflow?: "visible" | "hidden"

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

Inherited from

PanelProps.overflow

---

padding?

optional padding?: Padding

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

Inherited from

PanelProps.padding

---

positioning?

optional positioning?: UIPositioning

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

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.

---

visible?

optional visible?: boolean

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

Inherited from

PanelProps.visible

---

width?

optional width?: LayoutValue

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

Inherited from

PanelProps.width