UIElement

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

Common interface for elements that participate in Yoga layout.

Extended by

• UIContainerElement
• UIInputCaptureElement

Properties

_transform?

readonly optional _transform?: ElementTransform

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

Internal

The element’s transformOrigin, scale, rotation and zIndex. The parent’s layout pass reads it to place the element; an element without one is placed at its top-left corner with no pivot.

---

displayObject

readonly displayObject: DisplayContainer

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

---

visible

visible: boolean

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

---

yogaNode

readonly yogaNode: Node

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

Methods

_attachToTree()?

optional _attachToTree(context): void

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

Internal

Take the context of the UI tree this element belongs to: the name a development warning prints, and the scene’s focus stack. Containers implement it and pass it on to their children. An element that implements neither hook gets no warning label and never hosts a focus scope.

Parameters

context

UITreeContext

Returns

void

---

_detachFromTree()?

optional _detachFromTree(): void

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

Internal

Drop the tree context, unregistering any focus scope this element hosts. Called from a container’s removeElement and from destroy().

Returns

void

---

applyLayout()?

optional applyLayout(): void

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

Returns

void

---

destroy()

destroy(): void

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

Returns

void

---

update()

update(props): void

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

Parameters

props

Record<string, unknown>

Returns

void