Skip to content

Interface: PlayUIProviderProps

API / @xmachines/play-svelte / PlayUIProviderProps

Defined in: packages/play-svelte/src/actor-context.svelte.ts:78

Framework-agnostic base props shared by every ActorProvider implementation (React, Vue, Solid, Svelte). TRegistry captures the framework-specific DefineRegistryResult type; RenderErrorHandler is sourced from @json-render/core so no second generic is needed.

Framework packages extend this with their fallback, onError, and children fields.

Example

import type { BaseActorProviderProps } from "@xmachines/play-actor";
import type { DefineRegistryResult } from "@json-render/react";
interface ActorProviderProps extends BaseActorProviderProps<DefineRegistryResult> {
fallback?: React.ReactNode;
children: React.ReactNode;
}

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
actorAbstractActor<AnyActorLogic, EventObject> & ViewableActor instance with currentView signal (requires Viewable capability).ActorProviderProps.actorpackages/play-actor/src/abstract-actor.ts:154
childrenSnippet-ActorProviderProps.childrenpackages/play-svelte/src/actor-context.svelte.ts:71
fallback?Snippet<[]>-ActorProviderProps.fallbackpackages/play-svelte/src/actor-context.svelte.ts:69
functions?Record<string, unknown>--packages/play-svelte/src/actor-context.svelte.ts:84
navigate?(path) => void--packages/play-svelte/src/actor-context.svelte.ts:83
onError?(error, reset) => void-ActorProviderProps.onErrorpackages/play-svelte/src/actor-context.svelte.ts:70
onRenderError?RenderErrorHandlerCalled when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry.ActorProviderProps.onRenderErrorpackages/play-actor/src/abstract-actor.ts:167
registryResultDefineRegistryResultFull result from defineRegistry() — contains the component registry and action handlers factory.ActorProviderProps.registryResultpackages/play-actor/src/abstract-actor.ts:156
store?StateStoreOptional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state.ActorProviderProps.storepackages/play-actor/src/abstract-actor.ts:162
validationFunctions?Record<string, (value, args?) => boolean>--packages/play-svelte/src/actor-context.svelte.ts:79