FloatingOverlay
Defined in: ui/src/floating.ts:77
One screen-space, top-most overlay per scene that every floating element
(tooltip, popover, menu, …) parents into. Decoupled from any single
UIRoot: triggers are projected into the overlay’s coordinate space via
toLocal, so world-space / camera-transformed triggers anchor correctly,
and z-order is managed across all roots. Positioning is delegated to the
pure computePosition engine (offset → flip → shift → size); content
layout is delegated to a per-handle setLayout callback so the overlay
knows nothing about React or specific node types.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FloatingOverlay():
FloatingOverlay
Returns
Section titled “Returns”FloatingOverlay
Methods
Section titled “Methods”acquire()
Section titled “acquire()”acquire():
FloatingHandle
Defined in: ui/src/floating.ts:95
Returns
Section titled “Returns”attach()
Section titled “attach()”attach(
tree):void
Defined in: ui/src/floating.ts:83
Idempotently ensure the overlay layer exists in this scene’s tree.
Parameters
Section titled “Parameters”SceneRenderTree
Returns
Section titled “Returns”void
destroy()
Section titled “destroy()”destroy():
void
Defined in: ui/src/floating.ts:170
Returns
Section titled “Returns”void
update()
Section titled “update()”update(
viewport):void
Defined in: ui/src/floating.ts:137
Re-anchor every active float. Driven once per frame after UI layout.
Parameters
Section titled “Parameters”viewport
Section titled “viewport”height
Section titled “height”number
number
Returns
Section titled “Returns”void