Skip to content
XMachines

Interface: PlayUIProviderProps

API / @xmachines/play-react / PlayUIProviderProps

Defined in: packages/play-react/src/PlayUIProvider.tsx:35

The props of PlayUIProvider — every ActorProvider prop, and also the props of JSONUIProvider.

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
actorAbstractActor<AnyActorLogic, EventObject> & ViewableThe actor instance with the currentView signal. It requires the Viewable capability.ActorProviderProps.actorpackages/play-actor/src/abstract-actor.ts:163
childrenReactNodeThe child components to render inside the provider treeActorProviderProps.childrenpackages/play-react/src/ActorProvider.tsx:98
fallback?ReactNodeThe component to show when currentView is null, or when a catalog component throws. This prop is optionalActorProviderProps.fallbackpackages/play-react/src/ActorProvider.tsx:61
functions?Record<string, ComputedFunction>Named functions for $computed expressions in propsJSONUIProviderProps.functions-
navigate?(path) => voidNavigation functionJSONUIProviderProps.navigate-
onError?(error, info, reset) => voidThe optional error handler. The provider calls it when a descendant throws during a render. While the error is active, the provider renders the fallback instead of its children. The provider clears the error on the next view emission (when currentView changes), so a view transition retries the render. Element-level catalog component throws are caught upstream by the per-element boundary of @json-render, and reported through onRenderError. This boundary is the outer net for everything else. The THIRD parameter is the reset, for a retry that the host starts — a “Retry” button of its own. It sits after info, and not in the second place that the four other renderers use, because React.ErrorInfo holds that place already and a move would break every handler that reads info.componentStack. The reset clears the contained error and renders again. It renders the view that the actor holds at the MOMENT OF THE CALL, so a host that keeps the callback cannot rewind the screen to the view that failed. A reset that the host calls from inside this handler does nothing, because no input changed between the two attempts, and a reset after the provider is unmounted does nothing. The five renderers hold the same three rules. A handler that THROWS reaches no caller. The provider contains that throw, and it writes the throw to console.error. This handler runs inside componentDidCatch, so a throw that left it would reach the boundary ABOVE this provider, and React can then unmount the complete root — which is the failure that this boundary contained. Report a failure from this handler. To ESCALATE one, raise it from a task of your own — queueMicrotask(() => { throw error; }) — which reaches the global handler of the page and leaves the containment whole. The five renderers hold this one rule.ActorProviderProps.onErrorpackages/play-react/src/ActorProvider.tsx:96
onRenderError?RenderErrorHandlerThe provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry.ActorProviderProps.onRenderErrorpackages/play-actor/src/abstract-actor.ts:177
registryResultDefineRegistryResultThe complete result of defineRegistry(). It holds the component registry and the factory of the action handlers.ActorProviderProps.registryResultpackages/play-actor/src/abstract-actor.ts:165
store?StateStoreThe optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state.ActorProviderProps.storepackages/play-actor/src/abstract-actor.ts:172
validationFunctions?Record<string, (value, args?) => boolean>Custom validation functionsJSONUIProviderProps.validationFunctions-