PixiUIBase
Defined in: ui/src/pixi-ui/PixiUIBase.ts:40
Abstract base class for wrapping @pixi/ui components as Yoga-aware UIElements.
Handles: Yoga node + measure function, prevProps storage, bridgeSignal helper, visible prop, applyLayout, hover fan-out, focus, and destroy cleanup.
The widget view sits inside a plain container, displayObject, whose
own space is measured in layout pixels. A widget that layout sizes is
stretched inside that container, so the element’s scale and rotation
stay the game’s.
Extends
Section titled “Extends”Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”T extends DisplayContainer
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PixiUIBase<
T>(view,props):PixiUIBase<T>
Defined in: ui/src/pixi-ui/PixiUIBase.ts:73
Parameters
Section titled “Parameters”T
LayoutProps & PointerEventProps & FocusProps & ConsumeInputProps
Returns
Section titled “Returns”PixiUIBase<T>
Overrides
Section titled “Overrides”Properties
Section titled “Properties”_transform
Section titled “_transform”
readonly_transform:ElementTransform
Defined in: ui/src/UIElementBase.ts:20
Internal
Inherited from
Section titled “Inherited from”displayObject
Section titled “displayObject”
readonlydisplayObject:DisplayContainer
Defined in: ui/src/pixi-ui/PixiUIBase.ts:43
Overrides
Section titled “Overrides”prevProps
Section titled “prevProps”
protectedprevProps:Record<string,unknown> ={}
Defined in: ui/src/pixi-ui/PixiUIBase.ts:46
protectedreadonlyview:T
Defined in: ui/src/pixi-ui/PixiUIBase.ts:45
yogaNode
Section titled “yogaNode”
readonlyyogaNode:Node
Defined in: ui/src/pixi-ui/PixiUIBase.ts:44
Overrides
Section titled “Overrides”Accessors
Section titled “Accessors”disabled
Section titled “disabled”Get Signature
Section titled “Get Signature”get disabled():
boolean
Defined in: ui/src/pixi-ui/PixiUIBase.ts:199
Whether the widget refuses the pointer and a confirm press. Only a widget
whose @pixi/ui view carries an enabled flag reports true.
Returns
Section titled “Returns”boolean
focusable
Section titled “focusable”Get Signature
Section titled “Get Signature”get focusable():
boolean
Defined in: ui/src/pixi-ui/PixiUIBase.ts:222
Whether the widget takes part in focus navigation.
Returns
Section titled “Returns”boolean
focused
Section titled “focused”Get Signature
Section titled “Get Signature”get focused():
boolean
Defined in: ui/src/pixi-ui/PixiUIBase.ts:204
Whether the widget holds focus in the scope that owns it.
Returns
Section titled “Returns”boolean
hovered
Section titled “hovered”Get Signature
Section titled “Get Signature”get
protectedhovered():boolean
Defined in: ui/src/pixi-ui/PixiUIBase.ts:209
Whether the pointer is over the widget.
Returns
Section titled “Returns”boolean
interactive
Section titled “interactive”Get Signature
Section titled “Get Signature”get
protectedinteractive():boolean
Defined in: ui/src/pixi-ui/PixiUIBase.ts:191
Whether the wrapped widget answers the player. One that only displays a
value keeps its view’s own event mode and stays out of navigation unless
focusable asks for it.
Returns
Section titled “Returns”boolean
pressed
Section titled “pressed”Get Signature
Section titled “Get Signature”get
protectedpressed():boolean
Defined in: ui/src/pixi-ui/PixiUIBase.ts:217
Whether any device is holding the widget down: the pointer, a confirm press from a focus scope, or both.
Returns
Section titled “Returns”boolean
rotation
Section titled “rotation”Get Signature
Section titled “Get Signature”get rotation():
number
Defined in: ui/src/UIElementBase.ts:50
See LayoutProps.rotation.
Returns
Section titled “Returns”number
Set Signature
Section titled “Set Signature”set rotation(
value):void
Defined in: ui/src/UIElementBase.ts:54
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Get Signature
Section titled “Get Signature”get scale():
Readonly<{x:number;y:number; }>
Defined in: ui/src/UIElementBase.ts:41
See LayoutProps.scale.
Returns
Section titled “Returns”Readonly<{ x: number; y: number; }>
Set Signature
Section titled “Set Signature”set scale(
value):void
Defined in: ui/src/UIElementBase.ts:45
Parameters
Section titled “Parameters”number | { x: number; y: number; }
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”transformOrigin
Section titled “transformOrigin”Get Signature
Section titled “Get Signature”get transformOrigin():
Readonly<{x:number;y:number; }>
Defined in: ui/src/UIElementBase.ts:32
See LayoutProps.transformOrigin.
Returns
Section titled “Returns”Readonly<{ x: number; y: number; }>
Set Signature
Section titled “Set Signature”set transformOrigin(
value):void
Defined in: ui/src/UIElementBase.ts:36
Parameters
Section titled “Parameters”number | { x: number; y: number; }
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”visible
Section titled “visible”Get Signature
Section titled “Get Signature”get visible():
boolean
Defined in: ui/src/pixi-ui/PixiUIBase.ts:64
Returns
Section titled “Returns”boolean
Set Signature
Section titled “Set Signature”set visible(
v):void
Defined in: ui/src/pixi-ui/PixiUIBase.ts:68
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”zIndex
Section titled “zIndex”Get Signature
Section titled “Get Signature”get zIndex():
number
Defined in: ui/src/UIElementBase.ts:59
See LayoutProps.zIndex.
Returns
Section titled “Returns”number
Set Signature
Section titled “Set Signature”set zIndex(
value):void
Defined in: ui/src/UIElementBase.ts:63
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”_inspectState()
Section titled “_inspectState()”_inspectState():
object
Defined in: ui/src/pixi-ui/PixiUIBase.ts:399
Internal
Returns
Section titled “Returns”object
disabled
Section titled “disabled”disabled:
boolean
focusable
Section titled “focusable”focusable:
boolean
focused
Section titled “focused”focused:
boolean
activate()
Section titled “activate()”
abstractactivate():void
Defined in: ui/src/pixi-ui/PixiUIBase.ts:231
Run the widget’s own action, as a confirm press or a click does. A widget that is stepped rather than pressed implements this as a no-op and carries adjust.
Returns
Section titled “Returns”void
adjust()?
Section titled “adjust()?”
protectedoptionaladjust(direction):boolean
Defined in: ui/src/pixi-ui/PixiUIBase.ts:249
Step the widget’s own value along direction, returning true only when
the press was consumed. A stepper at its end returns false, so the press
moves focus out of the widget.
Parameters
Section titled “Parameters”direction
Section titled “direction”Returns
Section titled “Returns”boolean
applyLayout()
Section titled “applyLayout()”applyLayout():
void
Defined in: ui/src/pixi-ui/PixiUIBase.ts:308
Returns
Section titled “Returns”void
applyTransformProps()
Section titled “applyTransformProps()”
protectedapplyTransformProps(props):void
Defined in: ui/src/UIElementBase.ts:27
Apply the four transform props present in props. A present key holding
undefined resets that prop to its default. Throws before writing
anything if a value is not finite.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”UIElementBase.applyTransformProps
bridgeSignal()
Section titled “bridgeSignal()”
protectedbridgeSignal<F>(signal,key,kind,newProps):void
Defined in: ui/src/pixi-ui/PixiUIBase.ts:317
Bridge a @pixi/ui Signal to a callback prop. Only reconnects if ref changed.
Type Parameters
Section titled “Type Parameters”F extends (…args) => void
Parameters
Section titled “Parameters”signal
Section titled “signal”connect
Section titled “connect”(cb) => void
disconnect
Section titled “disconnect”(cb) => void
string
string
newProps
Section titled “newProps”Record<string, unknown>
Returns
Section titled “Returns”void
destroy()
Section titled “destroy()”destroy():
void
Defined in: ui/src/pixi-ui/PixiUIBase.ts:407
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”disconnectAll()
Section titled “disconnectAll()”
abstractprotecteddisconnectAll():void
Defined in: ui/src/pixi-ui/PixiUIBase.ts:454
Override in subclass to disconnect all signals on destroy.
Returns
Section titled “Returns”void
disconnectBridgedSignal()
Section titled “disconnectBridgedSignal()”
protecteddisconnectBridgedSignal<F>(signal,key):void
Defined in: ui/src/pixi-ui/PixiUIBase.ts:353
Type Parameters
Section titled “Type Parameters”F extends (…args) => void
Parameters
Section titled “Parameters”signal
Section titled “signal”disconnect
Section titled “disconnect”(cb) => void
string
Returns
Section titled “Returns”void
focusOutlineBox()
Section titled “focusOutlineBox()”
protectedfocusOutlineBox():UIFocusOutlineBox
Defined in: ui/src/pixi-ui/PixiUIBase.ts:281
The rectangle the focus outline is drawn around, in this element’s own space, which is measured in layout pixels.
A widget layout sizes is outlined around both its layout box and everything it draws, so a part reaching outside the box is inside the outline. A widget that keeps its own size is outlined around what it draws. A widget whose drawn extent moves with its value overrides this with a box that holds every value, so the outline stays still.
Returns
Section titled “Returns”fromViewSpace()
Section titled “fromViewSpace()”
protectedfromViewSpace(box):UIFocusOutlineBox
Defined in: ui/src/pixi-ui/PixiUIBase.ts:297
Map a rectangle from the widget view’s own space into this element’s.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”intrinsicSize()
Section titled “intrinsicSize()”
protectedintrinsicSize():object
Defined in: ui/src/pixi-ui/PixiUIBase.ts:257
The size layout gives this widget when nothing constrains it. A composite that hides or reparents its parts — a dropdown lifting its open list out of this container — overrides this so the space it takes in the flow does not depend on which part is on screen.
Returns
Section titled “Returns”object
height
Section titled “height”height:
number
width:
number
invalidateSize()
Section titled “invalidateSize()”
protectedinvalidateSize():void
Defined in: ui/src/pixi-ui/PixiUIBase.ts:373
Re-measure on the next layout pass. Yoga caches a measure function’s result, so a prop that changes the widget’s intrinsic size (its text, its item list) leaves the old size in the tree until the node is dirtied.
Returns
Section titled “Returns”void
setPressed()?
Section titled “setPressed()?”
protectedoptionalsetPressed(pressed):void
Defined in: ui/src/pixi-ui/PixiUIBase.ts:242
Show the widget’s pressed face while a device holds it down, and its resting face once every device has let go. A widget with no pressed face leaves it out.
true arrives again where the widget has repainted itself under a press
that is still held, so an implementation sets the face and never toggles
it.
Parameters
Section titled “Parameters”pressed
Section titled “pressed”boolean
Returns
Section titled “Returns”void
sizedByLayout()
Section titled “sizedByLayout()”
protectedsizedByLayout():boolean
Defined in: ui/src/pixi-ui/PixiUIBase.ts:267
Whether the size layout computes is what makes the widget that size. A
composite that places its own parts (a checkbox with a label, a radio
group) answers false: sizing its container would scale those parts out
of shape, so it draws at its own size inside the layout box.
Returns
Section titled “Returns”boolean
update()
Section titled “update()”
abstractupdate(props):void
Defined in: ui/src/pixi-ui/PixiUIBase.ts:396
Parameters
Section titled “Parameters”Record<string, unknown>
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”updateBase()
Section titled “updateBase()”
protectedupdateBase(props):void
Defined in: ui/src/pixi-ui/PixiUIBase.ts:378
Apply layout props, visible, and store prevProps. Call at end of subclass update().
Parameters
Section titled “Parameters”Record<string, unknown>
Returns
Section titled “Returns”void
Coding agents: fetch https://yage.dev/llms.txt first and prefer the Markdown references it links over these HTML pages. This page's Markdown counterpart is /llms/packages/ui.md.