Skip to content

Type Alias: MountFn

API / @xmachines/play-dom / MountFn

type MountFn = (actor, container, options?) => () => void;

Defined in: packages/play-dom/src/create-play-ui.ts:71

The mount function that createPlayUI returns.

Call it with (actor, container, mountOptions?) to start the renderer. It returns a disconnect cleanup function. That function stops the render and clears the container.

Parameters

ParameterType
actorAbstractActor<AnyActorLogic> & Viewable
containerHTMLElement
options?MountOptions

Returns

() => void