Skip to content

Function: createPlayUI()

API / @xmachines/play-dom / createPlayUI

function createPlayUI(registryResult, options?): MountFn;

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

Create a batteries-included DOM renderer mount function.

The caller is responsible for producing registryResult via defineRegistry. createPlayUI closes over it and returns a MountFn that can be invoked once per actor/container pair.

Parameters

ParameterTypeDescription
registryResultDefineRegistryResultResult from defineRegistry() — provides the registry and the lazy handlers factory.
optionsCreatePlayUIOptionsFactory-level configuration (see CreatePlayUIOptions): - functions — named compute functions for $computed prop expressions. - validationFunctions — custom validation functions; available at ctx.ctx.validationFunctions. - navigate — navigation callback; invoked on onSuccess: { navigate: "..." }. - onRenderError(error, name) handler for component render errors and action handler rejections. - fallback — element shown when the actor’s initial view is null.

Returns

MountFn

MountFn: (actor, container, mountOptions?) → disconnect